R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

11.16 Resource MedicinalProductPackaged - Content

Biomedical Research and Regulation Work GroupMaturity Level: 0 Trial Use Compartments: Not linked to any defined compartments

A medicinal product in a container or package.

Medicinal Product in a container being part of a package, representing the entirety that has been packaged for sale or supply

This resource is referenced by MedicinalProduct and MedicinalProductAuthorization

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductPackaged ΣTUDomainResourceA medicinal product in a container or package
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ1..1IdentifierUnique identifier
... description Σ0..1stringTextual description
... marketingStatus Σ0..*MarketingStatusMarketing information
... marketingAuthorization Σ0..1Reference(MedicinalProductAuthorization)Manufacturer of this Package Item
... manufacturer Σ0..*Reference(Organization)Manufacturer of this Package Item
... batchIdentifier Σ0..*BackboneElementBatch numbering
.... outerPackaging Σ1..1IdentifierA number appearing on the outer packaging of a specific batch
.... immediatePackaging Σ0..1IdentifierA number appearing on the immediate packaging (and not the outer packaging)
... packageItem Σ1..*BackboneElementA packaging item, as a contained for medicine, possibly with other packaging items within
.... identifier Σ0..*IdentifierIncluding possibly Data Carrier Identifier
.... type Σ1..1CodeableConceptThe physical type of the container of the medicine
.... quantity Σ1..1QuantityThe quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
.... material Σ0..*CodeableConceptMaterial type of the package item
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for the packaging
.... device Σ0..*Reference(MedicinalProductDeviceSpec | DeviceDefinition)A device accompanying a medicinal product
.... manufacturedItem Σ0..*Reference(MedicinalProductManufactured)The manufactured item as contained in the packaged medicinal product
.... packageItem Σ0..*see packageItemAllows containers within containers
.... physicalCharacteristics Σ0..1ProdCharacteristicDimensions, color etc.
.... otherCharacteristics Σ0..*CodeableConceptOther codeable characteristics
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this Package Item

doco Documentation for this format

UML Diagram (Legend)

MedicinalProductPackaged (DomainResource)Unique identifieridentifier : Identifier [1..1]Textual descriptiondescription : string [0..1]Marketing informationmarketingStatus : MarketingStatus [0..*]Manufacturer of this Package ItemmarketingAuthorization : Reference [0..1] « MedicinalProductAuthorization »Manufacturer of this Package Itemmanufacturer : Reference [0..*] « Organization »BatchIdentifierA number appearing on the outer packaging of a specific batchouterPackaging : Identifier [1..1]A number appearing on the immediate packaging (and not the outer packaging)immediatePackaging : Identifier [0..1]PackageItemIncluding possibly Data Carrier Identifieridentifier : Identifier [0..*]The physical type of the container of the medicinetype : CodeableConcept [1..1]The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1quantity : Quantity [1..1]Material type of the package itemmaterial : CodeableConcept [0..*]A possible alternate material for the packagingalternateMaterial : CodeableConcept [0..*]A device accompanying a medicinal productdevice : Reference [0..*] « MedicinalProductDeviceSpec| DeviceDefinition »The manufactured item as contained in the packaged medicinal productmanufacturedItem : Reference [0..*] « MedicinalProductManufactured »Dimensions, color etcphysicalCharacteristics : ProdCharacteristic [0..1]Other codeable characteristicsotherCharacteristics : CodeableConcept [0..*]Shelf Life and storage informationshelfLifeStorage : ProductShelfLife [0..*]Manufacturer of this Package Itemmanufacturer : Reference [0..*] « Organization »Batch numberingbatchIdentifier[0..*]Allows containers within containerspackageItem[0..*]A packaging item, as a contained for medicine, possibly with other packaging items withinpackageItem[1..*]

XML Template

<MedicinalProductPackaged xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 1..1 Identifier Unique identifier --></identifier>
 <description value="[string]"/><!-- 0..1 Textual description -->
 <marketingStatus><!-- 0..* MarketingStatus Marketing information --></marketingStatus>
 <marketingAuthorization><!-- 0..1 Reference(MedicinalProductAuthorization) Manufacturer of this Package Item --></marketingAuthorization>
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Package Item --></manufacturer>
 <batchIdentifier>  <!-- 0..* Batch numbering -->
  <outerPackaging><!-- 1..1 Identifier A number appearing on the outer packaging of a specific batch --></outerPackaging>
  <immediatePackaging><!-- 0..1 Identifier A number appearing on the immediate packaging (and not the outer packaging) --></immediatePackaging>
 </batchIdentifier>
 <packageItem>  <!-- 1..* A packaging item, as a contained for medicine, possibly with other packaging items within -->
  <identifier><!-- 0..* Identifier Including possibly Data Carrier Identifier --></identifier>
  <type><!-- 1..1 CodeableConcept The physical type of the container of the medicine --></type>
  <quantity><!-- 1..1 Quantity The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1 --></quantity>
  <material><!-- 0..* CodeableConcept Material type of the package item --></material>
  <alternateMaterial><!-- 0..* CodeableConcept A possible alternate material for the packaging --></alternateMaterial>
  <device><!-- 0..* Reference(MedicinalProductDeviceSpec|DeviceDefinition) A device accompanying a medicinal product --></device>
  <manufacturedItem><!-- 0..* Reference(MedicinalProductManufactured) The manufactured item as contained in the packaged medicinal product --></manufacturedItem>
  <packageItem><!-- 0..* Content as for MedicinalProductPackaged.packageItem Allows containers within containers --></packageItem>
  <physicalCharacteristics><!-- 0..1 ProdCharacteristic Dimensions, color etc. --></physicalCharacteristics>
  <otherCharacteristics><!-- 0..* CodeableConcept Other codeable characteristics --></otherCharacteristics>
  <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
  <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Package Item --></manufacturer>
 </packageItem>
</MedicinalProductPackaged>

JSON Template

{doco
  "resourceType" : "MedicinalProductPackaged",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // R!  Unique identifier
  "description" : "<string>", // Textual description
  "marketingStatus" : [{ MarketingStatus }], // Marketing information
  "marketingAuthorization" : { Reference(MedicinalProductAuthorization) }, // Manufacturer of this Package Item
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this Package Item
  "batchIdentifier" : [{ // Batch numbering
    "outerPackaging" : { Identifier }, // R!  A number appearing on the outer packaging of a specific batch
    "immediatePackaging" : { Identifier } // A number appearing on the immediate packaging (and not the outer packaging)
  }],
  "packageItem" : [{ // R!  A packaging item, as a contained for medicine, possibly with other packaging items within
    "identifier" : [{ Identifier }], // Including possibly Data Carrier Identifier
    "type" : { CodeableConcept }, // R!  The physical type of the container of the medicine
    "quantity" : { Quantity }, // R!  The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
    "material" : [{ CodeableConcept }], // Material type of the package item
    "alternateMaterial" : [{ CodeableConcept }], // A possible alternate material for the packaging
    "device" : [{ Reference(MedicinalProductDeviceSpec|DeviceDefinition) }], // A device accompanying a medicinal product
    "manufacturedItem" : [{ Reference(MedicinalProductManufactured) }], // The manufactured item as contained in the packaged medicinal product
    "packageItem" : [{ Content as for MedicinalProductPackaged.packageItem }], // Allows containers within containers
    "physicalCharacteristics" : { ProdCharacteristic }, // Dimensions, color etc.
    "otherCharacteristics" : [{ CodeableConcept }], // Other codeable characteristics
    "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
    "manufacturer" : [{ Reference(Organization) }] // Manufacturer of this Package Item
  }]
}

Turtle Template

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


[ a fhir:MedicinalProductPackaged;
  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:MedicinalProductPackaged.identifier [ Identifier ]; # 1..1 Unique identifier
  fhir:MedicinalProductPackaged.description [ string ]; # 0..1 Textual description
  fhir:MedicinalProductPackaged.marketingStatus [ MarketingStatus ], ... ; # 0..* Marketing information
  fhir:MedicinalProductPackaged.marketingAuthorization [ Reference(MedicinalProductAuthorization) ]; # 0..1 Manufacturer of this Package Item
  fhir:MedicinalProductPackaged.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Package Item
  fhir:MedicinalProductPackaged.batchIdentifier [ # 0..* Batch numbering
    fhir:MedicinalProductPackaged.batchIdentifier.outerPackaging [ Identifier ]; # 1..1 A number appearing on the outer packaging of a specific batch
    fhir:MedicinalProductPackaged.batchIdentifier.immediatePackaging [ Identifier ]; # 0..1 A number appearing on the immediate packaging (and not the outer packaging)
  ], ...;
  fhir:MedicinalProductPackaged.packageItem [ # 1..* A packaging item, as a contained for medicine, possibly with other packaging items within
    fhir:MedicinalProductPackaged.packageItem.identifier [ Identifier ], ... ; # 0..* Including possibly Data Carrier Identifier
    fhir:MedicinalProductPackaged.packageItem.type [ CodeableConcept ]; # 1..1 The physical type of the container of the medicine
    fhir:MedicinalProductPackaged.packageItem.quantity [ Quantity ]; # 1..1 The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
    fhir:MedicinalProductPackaged.packageItem.material [ CodeableConcept ], ... ; # 0..* Material type of the package item
    fhir:MedicinalProductPackaged.packageItem.alternateMaterial [ CodeableConcept ], ... ; # 0..* A possible alternate material for the packaging
    fhir:MedicinalProductPackaged.packageItem.device [ Reference(MedicinalProductDeviceSpec|DeviceDefinition) ], ... ; # 0..* A device accompanying a medicinal product
    fhir:MedicinalProductPackaged.packageItem.manufacturedItem [ Reference(MedicinalProductManufactured) ], ... ; # 0..* The manufactured item as contained in the packaged medicinal product
    fhir:MedicinalProductPackaged.packageItem.packageItem [ See MedicinalProductPackaged.packageItem ], ... ; # 0..* Allows containers within containers
    fhir:MedicinalProductPackaged.packageItem.physicalCharacteristics [ ProdCharacteristic ]; # 0..1 Dimensions, color etc.
    fhir:MedicinalProductPackaged.packageItem.otherCharacteristics [ CodeableConcept ], ... ; # 0..* Other codeable characteristics
    fhir:MedicinalProductPackaged.packageItem.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
    fhir:MedicinalProductPackaged.packageItem.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Package Item
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicinalProductPackaged ΣTUDomainResourceA medicinal product in a container or package
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ1..1IdentifierUnique identifier
... description Σ0..1stringTextual description
... marketingStatus Σ0..*MarketingStatusMarketing information
... marketingAuthorization Σ0..1Reference(MedicinalProductAuthorization)Manufacturer of this Package Item
... manufacturer Σ0..*Reference(Organization)Manufacturer of this Package Item
... batchIdentifier Σ0..*BackboneElementBatch numbering
.... outerPackaging Σ1..1IdentifierA number appearing on the outer packaging of a specific batch
.... immediatePackaging Σ0..1IdentifierA number appearing on the immediate packaging (and not the outer packaging)
... packageItem Σ1..*BackboneElementA packaging item, as a contained for medicine, possibly with other packaging items within
.... identifier Σ0..*IdentifierIncluding possibly Data Carrier Identifier
.... type Σ1..1CodeableConceptThe physical type of the container of the medicine
.... quantity Σ1..1QuantityThe quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
.... material Σ0..*CodeableConceptMaterial type of the package item
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for the packaging
.... device Σ0..*Reference(MedicinalProductDeviceSpec | DeviceDefinition)A device accompanying a medicinal product
.... manufacturedItem Σ0..*Reference(MedicinalProductManufactured)The manufactured item as contained in the packaged medicinal product
.... packageItem Σ0..*see packageItemAllows containers within containers
.... physicalCharacteristics Σ0..1ProdCharacteristicDimensions, color etc.
.... otherCharacteristics Σ0..*CodeableConceptOther codeable characteristics
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this Package Item

doco Documentation for this format

UML Diagram (Legend)

MedicinalProductPackaged (DomainResource)Unique identifieridentifier : Identifier [1..1]Textual descriptiondescription : string [0..1]Marketing informationmarketingStatus : MarketingStatus [0..*]Manufacturer of this Package ItemmarketingAuthorization : Reference [0..1] « MedicinalProductAuthorization »Manufacturer of this Package Itemmanufacturer : Reference [0..*] « Organization »BatchIdentifierA number appearing on the outer packaging of a specific batchouterPackaging : Identifier [1..1]A number appearing on the immediate packaging (and not the outer packaging)immediatePackaging : Identifier [0..1]PackageItemIncluding possibly Data Carrier Identifieridentifier : Identifier [0..*]The physical type of the container of the medicinetype : CodeableConcept [1..1]The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1quantity : Quantity [1..1]Material type of the package itemmaterial : CodeableConcept [0..*]A possible alternate material for the packagingalternateMaterial : CodeableConcept [0..*]A device accompanying a medicinal productdevice : Reference [0..*] « MedicinalProductDeviceSpec| DeviceDefinition »The manufactured item as contained in the packaged medicinal productmanufacturedItem : Reference [0..*] « MedicinalProductManufactured »Dimensions, color etcphysicalCharacteristics : ProdCharacteristic [0..1]Other codeable characteristicsotherCharacteristics : CodeableConcept [0..*]Shelf Life and storage informationshelfLifeStorage : ProductShelfLife [0..*]Manufacturer of this Package Itemmanufacturer : Reference [0..*] « Organization »Batch numberingbatchIdentifier[0..*]Allows containers within containerspackageItem[0..*]A packaging item, as a contained for medicine, possibly with other packaging items withinpackageItem[1..*]

XML Template

<MedicinalProductPackaged xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 1..1 Identifier Unique identifier --></identifier>
 <description value="[string]"/><!-- 0..1 Textual description -->
 <marketingStatus><!-- 0..* MarketingStatus Marketing information --></marketingStatus>
 <marketingAuthorization><!-- 0..1 Reference(MedicinalProductAuthorization) Manufacturer of this Package Item --></marketingAuthorization>
 <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Package Item --></manufacturer>
 <batchIdentifier>  <!-- 0..* Batch numbering -->
  <outerPackaging><!-- 1..1 Identifier A number appearing on the outer packaging of a specific batch --></outerPackaging>
  <immediatePackaging><!-- 0..1 Identifier A number appearing on the immediate packaging (and not the outer packaging) --></immediatePackaging>
 </batchIdentifier>
 <packageItem>  <!-- 1..* A packaging item, as a contained for medicine, possibly with other packaging items within -->
  <identifier><!-- 0..* Identifier Including possibly Data Carrier Identifier --></identifier>
  <type><!-- 1..1 CodeableConcept The physical type of the container of the medicine --></type>
  <quantity><!-- 1..1 Quantity The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1 --></quantity>
  <material><!-- 0..* CodeableConcept Material type of the package item --></material>
  <alternateMaterial><!-- 0..* CodeableConcept A possible alternate material for the packaging --></alternateMaterial>
  <device><!-- 0..* Reference(MedicinalProductDeviceSpec|DeviceDefinition) A device accompanying a medicinal product --></device>
  <manufacturedItem><!-- 0..* Reference(MedicinalProductManufactured) The manufactured item as contained in the packaged medicinal product --></manufacturedItem>
  <packageItem><!-- 0..* Content as for MedicinalProductPackaged.packageItem Allows containers within containers --></packageItem>
  <physicalCharacteristics><!-- 0..1 ProdCharacteristic Dimensions, color etc. --></physicalCharacteristics>
  <otherCharacteristics><!-- 0..* CodeableConcept Other codeable characteristics --></otherCharacteristics>
  <shelfLifeStorage><!-- 0..* ProductShelfLife Shelf Life and storage information --></shelfLifeStorage>
  <manufacturer><!-- 0..* Reference(Organization) Manufacturer of this Package Item --></manufacturer>
 </packageItem>
</MedicinalProductPackaged>

JSON Template

{doco
  "resourceType" : "MedicinalProductPackaged",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : { Identifier }, // R!  Unique identifier
  "description" : "<string>", // Textual description
  "marketingStatus" : [{ MarketingStatus }], // Marketing information
  "marketingAuthorization" : { Reference(MedicinalProductAuthorization) }, // Manufacturer of this Package Item
  "manufacturer" : [{ Reference(Organization) }], // Manufacturer of this Package Item
  "batchIdentifier" : [{ // Batch numbering
    "outerPackaging" : { Identifier }, // R!  A number appearing on the outer packaging of a specific batch
    "immediatePackaging" : { Identifier } // A number appearing on the immediate packaging (and not the outer packaging)
  }],
  "packageItem" : [{ // R!  A packaging item, as a contained for medicine, possibly with other packaging items within
    "identifier" : [{ Identifier }], // Including possibly Data Carrier Identifier
    "type" : { CodeableConcept }, // R!  The physical type of the container of the medicine
    "quantity" : { Quantity }, // R!  The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
    "material" : [{ CodeableConcept }], // Material type of the package item
    "alternateMaterial" : [{ CodeableConcept }], // A possible alternate material for the packaging
    "device" : [{ Reference(MedicinalProductDeviceSpec|DeviceDefinition) }], // A device accompanying a medicinal product
    "manufacturedItem" : [{ Reference(MedicinalProductManufactured) }], // The manufactured item as contained in the packaged medicinal product
    "packageItem" : [{ Content as for MedicinalProductPackaged.packageItem }], // Allows containers within containers
    "physicalCharacteristics" : { ProdCharacteristic }, // Dimensions, color etc.
    "otherCharacteristics" : [{ CodeableConcept }], // Other codeable characteristics
    "shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
    "manufacturer" : [{ Reference(Organization) }] // Manufacturer of this Package Item
  }]
}

Turtle Template

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


[ a fhir:MedicinalProductPackaged;
  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:MedicinalProductPackaged.identifier [ Identifier ]; # 1..1 Unique identifier
  fhir:MedicinalProductPackaged.description [ string ]; # 0..1 Textual description
  fhir:MedicinalProductPackaged.marketingStatus [ MarketingStatus ], ... ; # 0..* Marketing information
  fhir:MedicinalProductPackaged.marketingAuthorization [ Reference(MedicinalProductAuthorization) ]; # 0..1 Manufacturer of this Package Item
  fhir:MedicinalProductPackaged.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Package Item
  fhir:MedicinalProductPackaged.batchIdentifier [ # 0..* Batch numbering
    fhir:MedicinalProductPackaged.batchIdentifier.outerPackaging [ Identifier ]; # 1..1 A number appearing on the outer packaging of a specific batch
    fhir:MedicinalProductPackaged.batchIdentifier.immediatePackaging [ Identifier ]; # 0..1 A number appearing on the immediate packaging (and not the outer packaging)
  ], ...;
  fhir:MedicinalProductPackaged.packageItem [ # 1..* A packaging item, as a contained for medicine, possibly with other packaging items within
    fhir:MedicinalProductPackaged.packageItem.identifier [ Identifier ], ... ; # 0..* Including possibly Data Carrier Identifier
    fhir:MedicinalProductPackaged.packageItem.type [ CodeableConcept ]; # 1..1 The physical type of the container of the medicine
    fhir:MedicinalProductPackaged.packageItem.quantity [ Quantity ]; # 1..1 The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
    fhir:MedicinalProductPackaged.packageItem.material [ CodeableConcept ], ... ; # 0..* Material type of the package item
    fhir:MedicinalProductPackaged.packageItem.alternateMaterial [ CodeableConcept ], ... ; # 0..* A possible alternate material for the packaging
    fhir:MedicinalProductPackaged.packageItem.device [ Reference(MedicinalProductDeviceSpec|DeviceDefinition) ], ... ; # 0..* A device accompanying a medicinal product
    fhir:MedicinalProductPackaged.packageItem.manufacturedItem [ Reference(MedicinalProductManufactured) ], ... ; # 0..* The manufactured item as contained in the packaged medicinal product
    fhir:MedicinalProductPackaged.packageItem.packageItem [ See MedicinalProductPackaged.packageItem ], ... ; # 0..* Allows containers within containers
    fhir:MedicinalProductPackaged.packageItem.physicalCharacteristics [ ProdCharacteristic ]; # 0..1 Dimensions, color etc.
    fhir:MedicinalProductPackaged.packageItem.otherCharacteristics [ CodeableConcept ], ... ; # 0..* Other codeable characteristics
    fhir:MedicinalProductPackaged.packageItem.shelfLifeStorage [ ProductShelfLife ], ... ; # 0..* Shelf Life and storage information
    fhir:MedicinalProductPackaged.packageItem.manufacturer [ Reference(Organization) ], ... ; # 0..* Manufacturer of this Package Item
  ], ...;
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

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