Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

15.2 Resource PackagedProductDefinition - Content

Biomedical Research and Regulation Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

A medically related item or items, in a container or package.

For an overview of this resource and others in the Medication Definition domain, also see the module page

A medically related item or items of any type, in a container or package, representing the unit that has been prepared for sale, supply, shipping or storage. These can include packaged medications, devices and other items such as food, biologicals, raw materials, cosmetics, medical fluids, gases etc. This resource represents the whole package of items, and all the packaging within, rather than the individual items themselves and may contain other packages (parent/child relationships). In some cases a "product" exists at exists at logically different levels, and therefore has a variety of available packages associated with it. Typically the packages are associated with different sizes/quantities.

This resource is usually used with MedicinalProductDefinition, via the productFor relationship. For cases where only a subset of PackagedProductDefinition is need in a product, use as a contained resource to MPD may be appropriate. See MedicinalProductDefinition for an example.

The PackagedProductDefinition resource covers two main areas - package types that exist for a product (linked via productFor), and the packaging within those packages.

These can be thought of as the "package type" and the "packaging" respectively. The package type is covered by the PackagedProductDefinition class and the packaging by the Package backbone element (broadly the left and right of the UML model). It is possible to leave either part un-populated.

A package type can be documented without needing to say in detail what physical packaging or items are within it. This is common in many drug dictionaries, which list package types, but not their internals.

Conversely it is possible to only populate the Package backbone, and child classes, to cover packaging of an item but not say anything about the product outer packaging or the overall package that will eventually be on sale. This would be appropriate when focusing on the physical product and the inner packaging, perhaps at a manufacturing stage, without needing to populate package details not relevant (or not existing) at that phase.

Other implementations will use both "halves". A single application could start by using the Package class for packaging and then populate the package type data later on.

It is very important that a consistent representation is used. Packaging always uses the Package backbone, whether or not there are any package type properties documented. A diagram of this is shown on the Medication Definition module page.

This resource has two recursive relationships. One is primarily intended to be "internal" to the package - for package layers and contents, and the other for aggregated packages (e.g. for wholesaling) that are made up of other packages.

  • PackagedProductDefinition.package.package
    This recursive relationship is used for the inner parts and containers within a package - the package being indivisible and marketed or prescribed as a whole entity. However see also the "referenceable" packaging case in the next bullet.
  • PackagedProductDefinition.package.containedItem.item(PackagedProductDefinition)
    This recursive route is primarily for cases where the whole (indivisible) package is then aggregated into another, divisible, package - for example a warehousing or transport pack. This represents a package of packages. It is not generally used for the internal parts of a single package (see previous bullet). However for cases where there is a need to represent the distinct regulation of specific inner parts of a package, and so a need for these to be directly referenceable as packaging layers by other resources, this relationship SHOULD also be used for packaging within the package.

Feedback
In order to properly meet all packaging uses cases, consistent representation of different package information and recursive relationships are aspects of this resource that BR&R workgroup are particularly seeking implementation feedback on. (Comments links are found at the bottom of each page.)

This resource is referenced by MedicationKnowledge, itself, PlanDefinition and RegulatedAuthorization.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition TUDomainResourceA medically related item or items, in a container or package
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierA unique identifier for this package as whole - not for the content of the package
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ0..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping container etc
PackageType (Example)
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
PublicationStatus (Preferred)
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*QuantityA 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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
LegalStatusOfSupply (Example)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Jurisdiction (Example)
... marketingStatus Σ0..*MarketingStatusAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
PackageCharacteristic (Example)
... copackagedIndicator Σ0..1booleanIdentifies if the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type (multiple means these are all possible manufacturers)
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the packaged product
... packaging Σ0..1BackboneElementA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... identifier Σ0..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
PackagingType (Example)
.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ0..*CodeableConceptMaterial type of the package item
PackageMaterial (Example)
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
PackageMaterial (Example)
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
ProductCharacteristic (Example)
..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... item Σ1..1CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... packaging Σ0..*see packagingAllows containers (and parts of containers) within containers, still a single packaged product

doco Documentation for this format

UML Diagram (Legend)

PackagedProductDefinition (DomainResource)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 organizationsidentifier : Identifier [0..*]A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etcname : string [0..1]A high level category e.g. medicinal product, raw material, shipping/transport container, etctype : CodeableConcept [0..1] « null (Strength=Example)PackageType?? »The product this package model relates to, not the contents of the package (for which see package.containedItem)packageFor : Reference [0..*] « MedicinalProductDefinition »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 (this element modifies the meaning of other elements)status : CodeableConcept [0..1] « null (Strength=Preferred)PublicationStatus? »The date at which the given status became applicablestatusDate : dateTime [0..1]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 resourcecontainedItemQuantity : Quantity [0..*]Textual description. Note that this is not the name of the package or productdescription : markdown [0..1]Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associatedmarketingStatus : MarketingStatus [0..*]Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack"characteristic : CodeableConcept [0..*] « null (Strength=Example)PackageCharacteristic?? »Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvantcopackagedIndicator : boolean [0..1]Manufacturer of this package type. When there are multiple it means these are all possible manufacturersmanufacturer : Reference [0..*] « Organization »Additional information or supporting documentation about the packaged productattachedDocument : Reference [0..*] « DocumentReference »LegalStatusOfSupplyThe actual status of supply. Conveys in what situation this package type may be supplied for usecode : CodeableConcept [0..1] « null (Strength=Example)LegalStatusOfSupply?? »The place where the legal status of supply applies. When not specified, this indicates it is unknown in this contextjurisdiction : CodeableConcept [0..1] « null (Strength=Example)Jurisdiction ValueSet?? »PackagingA business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode)identifier : Identifier [0..*]The physical type of the container of the itemstype : CodeableConcept [0..1] « null (Strength=Example)PackagingType?? »The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2quantity : integer [0..1]Material type of the package itemmaterial : CodeableConcept [0..*] « null (Strength=Example)PackageMaterial?? »A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve)alternateMaterial : CodeableConcept [0..*] « null (Strength=Example)PackageMaterial?? »Shelf Life and storage informationshelfLifeStorage : ProductShelfLife [0..*]Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging itemmanufacturer : Reference [0..*] « Organization »PropertyA code expressing the type of characteristictype : CodeableConcept [1..1] « null (Strength=Example)ProductCharacteristic?? »A value for the characteristicvalue[x] : DataType [0..1] « CodeableConcept|Quantity|date|boolean| Attachment »ContainedItemThe actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.packaging.packaging)item : DataType [1..1] « ManufacturedItemDefinition|DeviceDefinition| PackagedProductDefinition|BiologicallyDerivedProduct| NutritionProduct »The number of this type of item within this packagingamount : Quantity [0..1]The legal status of supply of the packaged item as classified by the regulatorlegalStatusOfSupply[0..*]General characteristics of this itemproperty[0..*]The item(s) within the packagingcontainedItem[0..*]Allows containers (and parts of containers) parwithin containers, still a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition)packaging[0..*]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)packaging[0..1]

XML Template

<PackagedProductDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier A unique identifier for this package as whole - not for the content of the package --></identifier>
 <name value="[string]"/><!-- 0..1 A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc -->
 <type><!-- 0..1 CodeableConcept A high level category e.g. medicinal product, raw material, shipping container etc --></type>
 <packageFor><!-- 0..* Reference(MedicinalProductDefinition) The product that this is a pack for --></packageFor>
 <status><!-- 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status --></status>
 <statusDate value="[dateTime]"/><!-- 0..1 The date at which the given status became applicable -->
 <containedItemQuantity><!-- 0..* Quantity 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 --></containedItemQuantity>
 <description value="[markdown]"/><!-- 0..1 Textual description. Note that this is not the name of the package or product -->
 <legalStatusOfSupply>  <!-- 0..* The legal status of supply of the packaged item as classified by the regulator -->
  <code><!-- 0..1 CodeableConcept The actual status of supply. In what situation this package type may be supplied for use --></code>
  <jurisdiction><!-- 0..1 CodeableConcept The place where the legal status of supply applies --></jurisdiction>
 </legalStatusOfSupply>
 <marketingStatus><!-- 0..* MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated --></marketingStatus>
 <characteristic><!-- 0..* CodeableConcept Allows the key features to be recorded, such as "hospital pack", "nurse prescribable" --></characteristic>
 <copackagedIndicator value="[boolean]"/><!-- 0..1 Identifies if the drug product is supplied with another item such as a diluent or adjuvant -->
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this package type (multiple means these are all possible manufacturers) --></manufacturer>
 <attachedDocument><!-- 0..* Reference(DocumentReference) Additional information or supporting documentation about the packaged product --></attachedDocument>
 <packaging>  <!-- 0..1 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap -->
  <identifier><!-- 0..* Identifier An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier --></identifier>
  <type><!-- 0..1 CodeableConcept The physical type of the container of the items --></type>
  <quantity value="[integer]"/><!-- 0..1 The quantity of this level of packaging in the package that contains it (with the outermost level being 1) -->
  <material><!-- 0..* CodeableConcept Material type of the package item --></material>
  <alternateMaterial><!-- 0..* CodeableConcept A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material --></alternateMaterial>
  <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
  <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this packaging item (multiple means these are all potential manufacturers) --></manufacturer>
  <property>  <!-- 0..* General characteristics of this item -->
   <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic  --></type>
   <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]>
  </property>
  <containedItem>  <!-- 0..* The item(s) within the packaging -->
   <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|
     ManufacturedItemDefinition|NutritionProduct|PackagedProductDefinition) The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package --></item>
   <amount><!-- 0..1 Quantity The number of this type of item within this packaging --></amount>
  </containedItem>
  <packaging><!-- 0..* Content as for PackagedProductDefinition.packaging Allows containers (and parts of containers) within containers, still a single packaged product --></packaging>
 </packaging>
</PackagedProductDefinition>

JSON Template

{doco
  "resourceType" : "PackagedProductDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // A unique identifier for this package as whole - not for the content of the package
  "name" : "<string>", // A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
  "type" : { CodeableConcept }, // A high level category e.g. medicinal product, raw material, shipping container etc
  "packageFor" : [{ Reference(MedicinalProductDefinition) }], // The product that this is a pack for
  "status" : { CodeableConcept }, // The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
  "statusDate" : "<dateTime>", // The date at which the given status became applicable
  "containedItemQuantity" : [{ Quantity }], // 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
  "description" : "<markdown>", // 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
    "code" : { CodeableConcept }, // The actual status of supply. In what situation this package type may be supplied for use
    "jurisdiction" : { CodeableConcept } // The place where the legal status of supply applies
  }],
  "marketingStatus" : [{ 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" : [{ CodeableConcept }], // Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
  "copackagedIndicator" : <boolean>, // Identifies if the drug product is supplied with another item such as a diluent or adjuvant
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this package type (multiple means these are all possible manufacturers)
  "attachedDocument" : [{ Reference(DocumentReference) }], // 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
    "identifier" : [{ Identifier }], // An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
    "type" : { CodeableConcept }, // The physical type of the container of the items
    "quantity" : <integer>, // The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
    "material" : [{ CodeableConcept }], // Material type of the package item
    "alternateMaterial" : [{ CodeableConcept }], // A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
    "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
    "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this packaging item (multiple means these are all potential manufacturers)
    "property" : [{ // General characteristics of this item
      "type" : { CodeableConcept }, // R!  A code expressing the type of characteristic 
      // value[x]: A value for the characteristic. One of these 5:
      "valueCodeableConcept" : { CodeableConcept }
      "valueQuantity" : { Quantity }
      "valueDate" : "<date>"
      "valueBoolean" : <boolean>
      "valueAttachment" : { Attachment }
    }],
    "containedItem" : [{ // The item(s) within the packaging
      "item" : { CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|
     ManufacturedItemDefinition|NutritionProduct|PackagedProductDefinition) }, // R!  The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
      "amount" : { Quantity } // The number of this type of item within this packaging
    }],
    "packaging" : [{ Content as for PackagedProductDefinition.packaging }] // Allows containers (and parts of containers) within containers, still a single packaged product
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PackagedProductDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PackagedProductDefinition.identifier [ Identifier ], ... ; # 0..* A unique identifier for this package as whole - not for the content of the package
  fhir:PackagedProductDefinition.name [ string ]; # 0..1 A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
  fhir:PackagedProductDefinition.type [ CodeableConcept ]; # 0..1 A high level category e.g. medicinal product, raw material, shipping container etc
  fhir:PackagedProductDefinition.packageFor [ Reference(MedicinalProductDefinition) ], ... ; # 0..* The product that this is a pack for
  fhir:PackagedProductDefinition.status [ CodeableConcept ]; # 0..1 The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
  fhir:PackagedProductDefinition.statusDate [ dateTime ]; # 0..1 The date at which the given status became applicable
  fhir:PackagedProductDefinition.containedItemQuantity [ Quantity ], ... ; # 0..* 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
  fhir:PackagedProductDefinition.description [ markdown ]; # 0..1 Textual description. Note that this is not the name of the package or product
  fhir:PackagedProductDefinition.legalStatusOfSupply [ # 0..* The legal status of supply of the packaged item as classified by the regulator
    fhir:PackagedProductDefinition.legalStatusOfSupply.code [ CodeableConcept ]; # 0..1 The actual status of supply. In what situation this package type may be supplied for use
    fhir:PackagedProductDefinition.legalStatusOfSupply.jurisdiction [ CodeableConcept ]; # 0..1 The place where the legal status of supply applies
  ], ...;
  fhir:PackagedProductDefinition.marketingStatus [ MarketingStatus ], ... ; # 0..* Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
  fhir:PackagedProductDefinition.characteristic [ CodeableConcept ], ... ; # 0..* Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
  fhir:PackagedProductDefinition.copackagedIndicator [ boolean ]; # 0..1 Identifies if the drug product is supplied with another item such as a diluent or adjuvant
  fhir:PackagedProductDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this package type (multiple means these are all possible manufacturers)
  fhir:PackagedProductDefinition.attachedDocument [ Reference(DocumentReference) ], ... ; # 0..* Additional information or supporting documentation about the packaged product
  fhir:PackagedProductDefinition.packaging [ # 0..1 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
    fhir:PackagedProductDefinition.packaging.identifier [ Identifier ], ... ; # 0..* An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
    fhir:PackagedProductDefinition.packaging.type [ CodeableConcept ]; # 0..1 The physical type of the container of the items
    fhir:PackagedProductDefinition.packaging.quantity [ integer ]; # 0..1 The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
    fhir:PackagedProductDefinition.packaging.material [ CodeableConcept ], ... ; # 0..* Material type of the package item
    fhir:PackagedProductDefinition.packaging.alternateMaterial [ CodeableConcept ], ... ; # 0..* A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
    fhir:PackagedProductDefinition.packaging.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
    fhir:PackagedProductDefinition.packaging.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this packaging item (multiple means these are all potential manufacturers)
    fhir:PackagedProductDefinition.packaging.property [ # 0..* General characteristics of this item
      fhir:PackagedProductDefinition.packaging.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic
      # PackagedProductDefinition.packaging.property.value[x] : 0..1 A value for the characteristic. One of these 5
        fhir:PackagedProductDefinition.packaging.property.valueCodeableConcept [ CodeableConcept ]
        fhir:PackagedProductDefinition.packaging.property.valueQuantity [ Quantity ]
        fhir:PackagedProductDefinition.packaging.property.valueDate [ date ]
        fhir:PackagedProductDefinition.packaging.property.valueBoolean [ boolean ]
        fhir:PackagedProductDefinition.packaging.property.valueAttachment [ Attachment ]
    ], ...;
    fhir:PackagedProductDefinition.packaging.containedItem [ # 0..* The item(s) within the packaging
      fhir:PackagedProductDefinition.packaging.containedItem.item [ CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|ManufacturedItemDefinition|
  NutritionProduct|PackagedProductDefinition) ]; # 1..1 The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
      fhir:PackagedProductDefinition.packaging.containedItem.amount [ Quantity ]; # 0..1 The number of this type of item within this packaging
    ], ...;
    fhir:PackagedProductDefinition.packaging.packaging [ See PackagedProductDefinition.packaging ], ... ; # 0..* Allows containers (and parts of containers) within containers, still a single packaged product
  ];
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition TUDomainResourceA medically related item or items, in a container or package
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierA unique identifier for this package as whole - not for the content of the package
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ0..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping container etc
PackageType (Example)
... status ?!Σ0..1CodeableConceptThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
PublicationStatus (Preferred)
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*QuantityA 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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
LegalStatusOfSupply (Example)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Jurisdiction (Example)
... marketingStatus Σ0..*MarketingStatusAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
PackageCharacteristic (Example)
... copackagedIndicator Σ0..1booleanIdentifies if the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type (multiple means these are all possible manufacturers)
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the packaged product
... packaging Σ0..1BackboneElementA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... identifier Σ0..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
PackagingType (Example)
.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ0..*CodeableConceptMaterial type of the package item
PackageMaterial (Example)
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
PackageMaterial (Example)
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
ProductCharacteristic (Example)
..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... item Σ1..1CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... packaging Σ0..*see packagingAllows containers (and parts of containers) within containers, still a single packaged product

doco Documentation for this format

UML Diagram (Legend)

PackagedProductDefinition (DomainResource)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 organizationsidentifier : Identifier [0..*]A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etcname : string [0..1]A high level category e.g. medicinal product, raw material, shipping/transport container, etctype : CodeableConcept [0..1] « null (Strength=Example)PackageType?? »The product this package model relates to, not the contents of the package (for which see package.containedItem)packageFor : Reference [0..*] « MedicinalProductDefinition »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 (this element modifies the meaning of other elements)status : CodeableConcept [0..1] « null (Strength=Preferred)PublicationStatus? »The date at which the given status became applicablestatusDate : dateTime [0..1]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 resourcecontainedItemQuantity : Quantity [0..*]Textual description. Note that this is not the name of the package or productdescription : markdown [0..1]Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associatedmarketingStatus : MarketingStatus [0..*]Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack"characteristic : CodeableConcept [0..*] « null (Strength=Example)PackageCharacteristic?? »Identifies if the package contains different items, such as when a drug product is supplied with another item e.g. a diluent or adjuvantcopackagedIndicator : boolean [0..1]Manufacturer of this package type. When there are multiple it means these are all possible manufacturersmanufacturer : Reference [0..*] « Organization »Additional information or supporting documentation about the packaged productattachedDocument : Reference [0..*] « DocumentReference »LegalStatusOfSupplyThe actual status of supply. Conveys in what situation this package type may be supplied for usecode : CodeableConcept [0..1] « null (Strength=Example)LegalStatusOfSupply?? »The place where the legal status of supply applies. When not specified, this indicates it is unknown in this contextjurisdiction : CodeableConcept [0..1] « null (Strength=Example)Jurisdiction ValueSet?? »PackagingA business identifier that is specific to this particular part of the packaging, often assigned by the manufacturer. Including possibly Data Carrier Identifier (a GS1 barcode)identifier : Identifier [0..*]The physical type of the container of the itemstype : CodeableConcept [0..1] « null (Strength=Example)PackagingType?? »The quantity of packaging items contained at this layer of the package. This does not relate to the number of contained items but relates solely to the number of packaging items. When looking at the outermost layer it is always 1. If there are two boxes within, at the next layer it would be 2quantity : integer [0..1]Material type of the package itemmaterial : CodeableConcept [0..*] « null (Strength=Example)PackageMaterial?? »A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material (e.g. different types of plastic for a blister sleeve)alternateMaterial : CodeableConcept [0..*] « null (Strength=Example)PackageMaterial?? »Shelf Life and storage informationshelfLifeStorage : ProductShelfLife [0..*]Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging itemmanufacturer : Reference [0..*] « Organization »PropertyA code expressing the type of characteristictype : CodeableConcept [1..1] « null (Strength=Example)ProductCharacteristic?? »A value for the characteristicvalue[x] : DataType [0..1] « CodeableConcept|Quantity|date|boolean| Attachment »ContainedItemThe actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.packaging.packaging)item : DataType [1..1] « ManufacturedItemDefinition|DeviceDefinition| PackagedProductDefinition|BiologicallyDerivedProduct| NutritionProduct »The number of this type of item within this packagingamount : Quantity [0..1]The legal status of supply of the packaged item as classified by the regulatorlegalStatusOfSupply[0..*]General characteristics of this itemproperty[0..*]The item(s) within the packagingcontainedItem[0..*]Allows containers (and parts of containers) parwithin containers, still a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition)packaging[0..*]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)packaging[0..1]

XML Template

<PackagedProductDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier A unique identifier for this package as whole - not for the content of the package --></identifier>
 <name value="[string]"/><!-- 0..1 A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc -->
 <type><!-- 0..1 CodeableConcept A high level category e.g. medicinal product, raw material, shipping container etc --></type>
 <packageFor><!-- 0..* Reference(MedicinalProductDefinition) The product that this is a pack for --></packageFor>
 <status><!-- 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status --></status>
 <statusDate value="[dateTime]"/><!-- 0..1 The date at which the given status became applicable -->
 <containedItemQuantity><!-- 0..* Quantity 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 --></containedItemQuantity>
 <description value="[markdown]"/><!-- 0..1 Textual description. Note that this is not the name of the package or product -->
 <legalStatusOfSupply>  <!-- 0..* The legal status of supply of the packaged item as classified by the regulator -->
  <code><!-- 0..1 CodeableConcept The actual status of supply. In what situation this package type may be supplied for use --></code>
  <jurisdiction><!-- 0..1 CodeableConcept The place where the legal status of supply applies --></jurisdiction>
 </legalStatusOfSupply>
 <marketingStatus><!-- 0..* MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated --></marketingStatus>
 <characteristic><!-- 0..* CodeableConcept Allows the key features to be recorded, such as "hospital pack", "nurse prescribable" --></characteristic>
 <copackagedIndicator value="[boolean]"/><!-- 0..1 Identifies if the drug product is supplied with another item such as a diluent or adjuvant -->
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this package type (multiple means these are all possible manufacturers) --></manufacturer>
 <attachedDocument><!-- 0..* Reference(DocumentReference) Additional information or supporting documentation about the packaged product --></attachedDocument>
 <packaging>  <!-- 0..1 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap -->
  <identifier><!-- 0..* Identifier An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier --></identifier>
  <type><!-- 0..1 CodeableConcept The physical type of the container of the items --></type>
  <quantity value="[integer]"/><!-- 0..1 The quantity of this level of packaging in the package that contains it (with the outermost level being 1) -->
  <material><!-- 0..* CodeableConcept Material type of the package item --></material>
  <alternateMaterial><!-- 0..* CodeableConcept A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material --></alternateMaterial>
  <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
  <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this packaging item (multiple means these are all potential manufacturers) --></manufacturer>
  <property>  <!-- 0..* General characteristics of this item -->
   <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic  --></type>
   <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]>
  </property>
  <containedItem>  <!-- 0..* The item(s) within the packaging -->
   <item><!-- 1..1 CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|
     ManufacturedItemDefinition|NutritionProduct|PackagedProductDefinition) The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package --></item>
   <amount><!-- 0..1 Quantity The number of this type of item within this packaging --></amount>
  </containedItem>
  <packaging><!-- 0..* Content as for PackagedProductDefinition.packaging Allows containers (and parts of containers) within containers, still a single packaged product --></packaging>
 </packaging>
</PackagedProductDefinition>

JSON Template

{doco
  "resourceType" : "PackagedProductDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // A unique identifier for this package as whole - not for the content of the package
  "name" : "<string>", // A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
  "type" : { CodeableConcept }, // A high level category e.g. medicinal product, raw material, shipping container etc
  "packageFor" : [{ Reference(MedicinalProductDefinition) }], // The product that this is a pack for
  "status" : { CodeableConcept }, // The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
  "statusDate" : "<dateTime>", // The date at which the given status became applicable
  "containedItemQuantity" : [{ Quantity }], // 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
  "description" : "<markdown>", // 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
    "code" : { CodeableConcept }, // The actual status of supply. In what situation this package type may be supplied for use
    "jurisdiction" : { CodeableConcept } // The place where the legal status of supply applies
  }],
  "marketingStatus" : [{ 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" : [{ CodeableConcept }], // Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
  "copackagedIndicator" : <boolean>, // Identifies if the drug product is supplied with another item such as a diluent or adjuvant
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this package type (multiple means these are all possible manufacturers)
  "attachedDocument" : [{ Reference(DocumentReference) }], // 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
    "identifier" : [{ Identifier }], // An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
    "type" : { CodeableConcept }, // The physical type of the container of the items
    "quantity" : <integer>, // The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
    "material" : [{ CodeableConcept }], // Material type of the package item
    "alternateMaterial" : [{ CodeableConcept }], // A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
    "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
    "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this packaging item (multiple means these are all potential manufacturers)
    "property" : [{ // General characteristics of this item
      "type" : { CodeableConcept }, // R!  A code expressing the type of characteristic 
      // value[x]: A value for the characteristic. One of these 5:
      "valueCodeableConcept" : { CodeableConcept }
      "valueQuantity" : { Quantity }
      "valueDate" : "<date>"
      "valueBoolean" : <boolean>
      "valueAttachment" : { Attachment }
    }],
    "containedItem" : [{ // The item(s) within the packaging
      "item" : { CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|
     ManufacturedItemDefinition|NutritionProduct|PackagedProductDefinition) }, // R!  The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
      "amount" : { Quantity } // The number of this type of item within this packaging
    }],
    "packaging" : [{ Content as for PackagedProductDefinition.packaging }] // Allows containers (and parts of containers) within containers, still a single packaged product
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:PackagedProductDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:PackagedProductDefinition.identifier [ Identifier ], ... ; # 0..* A unique identifier for this package as whole - not for the content of the package
  fhir:PackagedProductDefinition.name [ string ]; # 0..1 A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
  fhir:PackagedProductDefinition.type [ CodeableConcept ]; # 0..1 A high level category e.g. medicinal product, raw material, shipping container etc
  fhir:PackagedProductDefinition.packageFor [ Reference(MedicinalProductDefinition) ], ... ; # 0..* The product that this is a pack for
  fhir:PackagedProductDefinition.status [ CodeableConcept ]; # 0..1 The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
  fhir:PackagedProductDefinition.statusDate [ dateTime ]; # 0..1 The date at which the given status became applicable
  fhir:PackagedProductDefinition.containedItemQuantity [ Quantity ], ... ; # 0..* 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
  fhir:PackagedProductDefinition.description [ markdown ]; # 0..1 Textual description. Note that this is not the name of the package or product
  fhir:PackagedProductDefinition.legalStatusOfSupply [ # 0..* The legal status of supply of the packaged item as classified by the regulator
    fhir:PackagedProductDefinition.legalStatusOfSupply.code [ CodeableConcept ]; # 0..1 The actual status of supply. In what situation this package type may be supplied for use
    fhir:PackagedProductDefinition.legalStatusOfSupply.jurisdiction [ CodeableConcept ]; # 0..1 The place where the legal status of supply applies
  ], ...;
  fhir:PackagedProductDefinition.marketingStatus [ MarketingStatus ], ... ; # 0..* Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
  fhir:PackagedProductDefinition.characteristic [ CodeableConcept ], ... ; # 0..* Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"
  fhir:PackagedProductDefinition.copackagedIndicator [ boolean ]; # 0..1 Identifies if the drug product is supplied with another item such as a diluent or adjuvant
  fhir:PackagedProductDefinition.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this package type (multiple means these are all possible manufacturers)
  fhir:PackagedProductDefinition.attachedDocument [ Reference(DocumentReference) ], ... ; # 0..* Additional information or supporting documentation about the packaged product
  fhir:PackagedProductDefinition.packaging [ # 0..1 A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
    fhir:PackagedProductDefinition.packaging.identifier [ Identifier ], ... ; # 0..* An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
    fhir:PackagedProductDefinition.packaging.type [ CodeableConcept ]; # 0..1 The physical type of the container of the items
    fhir:PackagedProductDefinition.packaging.quantity [ integer ]; # 0..1 The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
    fhir:PackagedProductDefinition.packaging.material [ CodeableConcept ], ... ; # 0..* Material type of the package item
    fhir:PackagedProductDefinition.packaging.alternateMaterial [ CodeableConcept ], ... ; # 0..* A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
    fhir:PackagedProductDefinition.packaging.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
    fhir:PackagedProductDefinition.packaging.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this packaging item (multiple means these are all potential manufacturers)
    fhir:PackagedProductDefinition.packaging.property [ # 0..* General characteristics of this item
      fhir:PackagedProductDefinition.packaging.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic
      # PackagedProductDefinition.packaging.property.value[x] : 0..1 A value for the characteristic. One of these 5
        fhir:PackagedProductDefinition.packaging.property.valueCodeableConcept [ CodeableConcept ]
        fhir:PackagedProductDefinition.packaging.property.valueQuantity [ Quantity ]
        fhir:PackagedProductDefinition.packaging.property.valueDate [ date ]
        fhir:PackagedProductDefinition.packaging.property.valueBoolean [ boolean ]
        fhir:PackagedProductDefinition.packaging.property.valueAttachment [ Attachment ]
    ], ...;
    fhir:PackagedProductDefinition.packaging.containedItem [ # 0..* The item(s) within the packaging
      fhir:PackagedProductDefinition.packaging.containedItem.item [ CodeableReference(BiologicallyDerivedProduct|DeviceDefinition|ManufacturedItemDefinition|
  NutritionProduct|PackagedProductDefinition) ]; # 1..1 The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
      fhir:PackagedProductDefinition.packaging.containedItem.amount [ Quantity ]; # 0..1 The number of this type of item within this packaging
    ], ...;
    fhir:PackagedProductDefinition.packaging.packaging [ See PackagedProductDefinition.packaging ], ... ; # 0..* Allows containers (and parts of containers) within containers, still a single packaged product
  ];
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
PackagedProductDefinition.type ExamplePackageType
PackagedProductDefinition.status PreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.code ExampleLegalStatusOfSupply
PackagedProductDefinition.legalStatusOfSupply.jurisdiction ExampleJurisdiction ValueSet
PackagedProductDefinition.characteristic ExamplePackageCharacteristic
PackagedProductDefinition.packaging.type ExamplePackagingType
PackagedProductDefinition.packaging.material ExamplePackageMaterial
PackagedProductDefinition.packaging.alternateMaterial ExamplePackageMaterial
PackagedProductDefinition.packaging.property.type Examplehttp://hl7.org/fhir/ValueSet/product-characteristic-codes

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
biological DreferenceA biologically derived product within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
contained-item DreferenceAny of the contained items within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
device DreferenceA device within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
identifiertokenUnique identifierPackagedProductDefinition.identifier
manufactured-item DreferenceA manufactured item of medication within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
medication DreferenceA manufactured item of medication within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
name NtokenA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etcPackagedProductDefinition.name
nutrition DreferenceA nutrition product within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
package DreferenceA complete packaged product within this packaged productPackagedProductDefinition.packaging.containedItem.item.reference
package-forreferenceThe product that this is a pack forPackagedProductDefinition.packageFor
(MedicinalProductDefinition)
statustokenThe 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 statusPackagedProductDefinition.status