Class PackagedProductDefinition

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

A medically related item or items, in a container or package.
See Also:
  • Field Details

    • identifier

      A unique identifier for this package as whole - not the the content of the package. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations.
    • name

      protected StringType name
      A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc.
    • type

      protected CodeableConcept type
      A high level category e.g. medicinal product, raw material, shipping/transport container, etc.
    • packageFor

      The product this package model relates to, not the contents of the package (for which see package.containedItem).
    • status

      The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status.
    • statusDate

      The date at which the given status became applicable.
    • containedItemQuantity

      A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size. This attribute differs from containedItem.amount in that it can give a single aggregated count of all tablet types in a pack, even when these are different manufactured items. For example a pill pack of 21 tablets plus 7 sugar tablets, can be denoted here as '28 tablets'. This attribute is repeatable so that the different item types in one pack type can be counted (e.g. a count of vials and count of syringes). Each repeat must have different units, so that it is clear what the different sets of counted items are, and it is not intended to allow different counts of similar items (e.g. not '2 tubes and 3 tubes'). Repeats are not to be used to represent different pack sizes (e.g. 20 pack vs. 50 pack) - which would be different instances of this resource.
    • description

      Textual description. Note that this is not the name of the package or product.
    • legalStatusOfSupply

      The legal status of supply of the packaged item as classified by the regulator.
    • marketingStatus

      Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated.
    • characteristic

      Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack".
    • copackagedIndicator

      Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvant.
    • manufacturer

      Manufacturer of this package type. When there are multiple it means these are all possible manufacturers.
    • attachedDocument

      Additional information or supporting documentation about the packaged product.
    • packaging

      A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap (which is not a device or a medication manufactured item).
    • SP_BIOLOGICAL

      public static final String SP_BIOLOGICAL
      Search parameter: biological

      Description: A biologically derived product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • BIOLOGICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BIOLOGICAL
      Fluent Client search parameter constant for biological

      Description: A biologically derived product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_BIOLOGICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BIOLOGICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:biological".
    • SP_CONTAINED_ITEM

      public static final String SP_CONTAINED_ITEM
      Search parameter: contained-item

      Description: Any of the contained items within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • CONTAINED_ITEM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTAINED_ITEM
      Fluent Client search parameter constant for contained-item

      Description: Any of the contained items within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_CONTAINED_ITEM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTAINED_ITEM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:contained-item".
    • SP_DEVICE

      public static final String SP_DEVICE
      Search parameter: device

      Description: A device within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • DEVICE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
      Fluent Client search parameter constant for device

      Description: A device within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_DEVICE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:device".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Unique identifier
      Type: token
      Path: PackagedProductDefinition.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Unique identifier
      Type: token
      Path: PackagedProductDefinition.identifier

    • SP_MANUFACTURED_ITEM

      public static final String SP_MANUFACTURED_ITEM
      Search parameter: manufactured-item

      Description: A manufactured item of medication within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • MANUFACTURED_ITEM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURED_ITEM
      Fluent Client search parameter constant for manufactured-item

      Description: A manufactured item of medication within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_MANUFACTURED_ITEM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURED_ITEM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:manufactured-item".
    • SP_MEDICATION

      public static final String SP_MEDICATION
      Search parameter: medication

      Description: A manufactured item of medication within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • MEDICATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
      Fluent Client search parameter constant for medication

      Description: A manufactured item of medication within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_MEDICATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:medication".
    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
      Type: token
      Path: PackagedProductDefinition.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam NAME
      Fluent Client search parameter constant for name

      Description: A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
      Type: token
      Path: PackagedProductDefinition.name

    • SP_NUTRITION

      public static final String SP_NUTRITION
      Search parameter: nutrition

      Description: A nutrition product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • NUTRITION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam NUTRITION
      Fluent Client search parameter constant for nutrition

      Description: A nutrition product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_NUTRITION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_NUTRITION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:nutrition".
    • SP_PACKAGE_FOR

      public static final String SP_PACKAGE_FOR
      Search parameter: package-for

      Description: The product that this is a pack for
      Type: reference
      Path: PackagedProductDefinition.packageFor

      See Also:
    • PACKAGE_FOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PACKAGE_FOR
      Fluent Client search parameter constant for package-for

      Description: The product that this is a pack for
      Type: reference
      Path: PackagedProductDefinition.packageFor

    • INCLUDE_PACKAGE_FOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PACKAGE_FOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:package-for".
    • SP_PACKAGE

      public static final String SP_PACKAGE
      Search parameter: package

      Description: A complete packaged product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

      See Also:
    • PACKAGE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PACKAGE
      Fluent Client search parameter constant for package

      Description: A complete packaged product within this packaged product
      Type: reference
      Path: PackagedProductDefinition.packaging.containedItem.item.reference

    • INCLUDE_PACKAGE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PACKAGE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "PackagedProductDefinition:package".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status
      Type: token
      Path: PackagedProductDefinition.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status
      Type: token
      Path: PackagedProductDefinition.status

  • Constructor Details

  • Method Details