This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Biomedical Research and Regulation Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the PackagedProductDefinition resource.
PackagedProductDefinition | |
Element Id | PackagedProductDefinition |
Definition | A medically related item or items, in a container or package. |
Cardinality | 0..* |
Type | DomainResource |
Summary | false |
PackagedProductDefinition.identifier | |
Element Id | PackagedProductDefinition.identifier |
Definition | A unique identifier for this package as whole. Unique instance identifiers assigned to a package by manufacturers, regulators, drug catalogue custodians or other organizations. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
PackagedProductDefinition.name | |
Element Id | PackagedProductDefinition.name |
Definition | A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc. |
Cardinality | 0..1 |
Type | string |
Summary | true |
PackagedProductDefinition.type | |
Element Id | PackagedProductDefinition.type |
Definition | A high level category e.g. medicinal product, raw material, shipping/transport container, etc. |
Cardinality | 0..1 |
Terminology Binding | PackageType (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.packageFor | |
Element Id | PackagedProductDefinition.packageFor |
Definition | The product that this is a pack for. |
Cardinality | 0..* |
Type | Reference(MedicinalProductDefinition) |
Summary | true |
PackagedProductDefinition.status | |
Element Id | PackagedProductDefinition.status |
Definition | 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. |
Cardinality | 0..1 |
Terminology Binding | PublicationStatus (Preferred) |
Type | CodeableConcept |
Is Modifier | true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid) |
Summary | true |
PackagedProductDefinition.statusDate | |
Element Id | PackagedProductDefinition.statusDate |
Definition | The date at which the given status became applicable. |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
PackagedProductDefinition.containedItemQuantity | |
Element Id | PackagedProductDefinition.containedItemQuantity |
Definition | 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. |
Cardinality | 0..* |
Type | Quantity |
Summary | true |
PackagedProductDefinition.description | |
Element Id | PackagedProductDefinition.description |
Definition | Textual description. Note that this is not the name of the package or product. |
Cardinality | 0..1 |
Type | markdown |
Summary | true |
PackagedProductDefinition.legalStatusOfSupply | |
Element Id | PackagedProductDefinition.legalStatusOfSupply |
Definition | The legal status of supply of the packaged item as classified by the regulator. |
Cardinality | 0..* |
Summary | true |
PackagedProductDefinition.legalStatusOfSupply.code | |
Element Id | PackagedProductDefinition.legalStatusOfSupply.code |
Definition | The actual status of supply. Conveys in what situation this package type may be supplied for use. |
Cardinality | 0..1 |
Terminology Binding | LegalStatusOfSupply (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.legalStatusOfSupply.jurisdiction | |
Element Id | PackagedProductDefinition.legalStatusOfSupply.jurisdiction |
Definition | The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context. |
Cardinality | 0..1 |
Terminology Binding | Jurisdiction (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.marketingStatus | |
Element Id | PackagedProductDefinition.marketingStatus |
Definition | Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated. |
Cardinality | 0..* |
Type | MarketingStatus |
Summary | true |
PackagedProductDefinition.characteristic | |
Element Id | PackagedProductDefinition.characteristic |
Definition | Allows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack". |
Cardinality | 0..* |
Terminology Binding | PackageCharacteristic (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.copackagedIndicator | |
Element Id | PackagedProductDefinition.copackagedIndicator |
Definition | States whether a drug product is supplied with another item such as a diluent or adjuvant. |
Cardinality | 0..1 |
Type | boolean |
Meaning if Missing | If this value is not present, there is no statement being made about whether this is co-packaged or not. No inference can be made |
Summary | true |
PackagedProductDefinition.manufacturer | |
Element Id | PackagedProductDefinition.manufacturer |
Definition | Manufacturer of this package type. When there are multiple it means these are all possible manufacturers. |
Cardinality | 0..* |
Type | Reference(Organization) |
Summary | true |
PackagedProductDefinition.package | |
Element Id | PackagedProductDefinition.package |
Definition | 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). |
Cardinality | 0..1 |
Summary | true |
PackagedProductDefinition.package.identifier | |
Element Id | PackagedProductDefinition.package.identifier |
Definition | An identifier that is specific to this particular part of the packaging. Including possibly Data Carrier Identifier (a GS1 barcode). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
PackagedProductDefinition.package.type | |
Element Id | PackagedProductDefinition.package.type |
Definition | The physical type of the container of the items. |
Cardinality | 0..1 |
Terminology Binding | PackagingType (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.quantity | |
Element Id | PackagedProductDefinition.package.quantity |
Definition | The quantity of this level of packaging in the package that contains it. If specified, the outermost level is always 1. |
Cardinality | 0..1 |
Type | integer |
Summary | true |
PackagedProductDefinition.package.material | |
Element Id | PackagedProductDefinition.package.material |
Definition | Material type of the package item. |
Cardinality | 0..* |
Terminology Binding | PackageMaterial (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.alternateMaterial | |
Element Id | PackagedProductDefinition.package.alternateMaterial |
Definition | 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). |
Cardinality | 0..* |
Terminology Binding | PackageMaterial (Example) |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.shelfLifeStorage | |
Element Id | PackagedProductDefinition.package.shelfLifeStorage |
Definition | Shelf Life and storage information. |
Cardinality | 0..* |
Summary | true |
PackagedProductDefinition.package.shelfLifeStorage.type | |
Element Id | PackagedProductDefinition.package.shelfLifeStorage.type |
Definition | This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified. |
Cardinality | 0..1 |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.shelfLifeStorage.period[x] | |
Element Id | PackagedProductDefinition.package.shelfLifeStorage.period[x] |
Definition | The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used. |
Cardinality | 0..1 |
Type | Duration|string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
PackagedProductDefinition.package.shelfLifeStorage.specialPrecautionsForStorage | |
Element Id | PackagedProductDefinition.package.shelfLifeStorage.specialPrecautionsForStorage |
Definition | Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary. The controlled term and the controlled term identifier shall be specified. |
Cardinality | 0..* |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.manufacturer | |
Element Id | PackagedProductDefinition.package.manufacturer |
Definition | Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers. |
Cardinality | 0..* |
Type | Reference(Organization) |
Summary | true |
PackagedProductDefinition.package.property | |
Element Id | PackagedProductDefinition.package.property |
Definition | General characteristics of this item. |
Cardinality | 0..* |
Summary | true |
PackagedProductDefinition.package.property.type | |
Element Id | PackagedProductDefinition.package.property.type |
Definition | A code expressing the type of characteristic. |
Cardinality | 1..1 |
Terminology Binding | ProductCharacteristic : |
Type | CodeableConcept |
Summary | true |
PackagedProductDefinition.package.property.value[x] | |
Element Id | PackagedProductDefinition.package.property.value[x] |
Definition | A value for the characteristic. |
Cardinality | 0..1 |
Type | CodeableConcept|Quantity|date|boolean|Attachment |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
PackagedProductDefinition.package.containedItem | |
Element Id | PackagedProductDefinition.package.containedItem |
Definition | The item(s) within the packaging. |
Cardinality | 0..* |
Summary | true |
PackagedProductDefinition.package.containedItem.item | |
Element Id | PackagedProductDefinition.package.containedItem.item |
Definition | The 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.package.package). |
Cardinality | 1..1 |
Type | CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct) |
Summary | true |
PackagedProductDefinition.package.containedItem.amount | |
Element Id | PackagedProductDefinition.package.containedItem.amount |
Definition | The number of this type of item within this packaging. |
Cardinality | 0..1 |
Type | Quantity |
Summary | true |
PackagedProductDefinition.package.package | |
Element Id | PackagedProductDefinition.package.package |
Definition | Allows containers (and parts of containers) parwithin containers, still a single packaged product. See also PackagedProductDefinition.package.containedItem.item(PackagedProductDefinition). |
Cardinality | 0..* |
Type | See PackagedProductDefinition.package |
Summary | true |