Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0-ballot - STU Ballot International flag

This page is part of the Electronic Medicinal Product Information (ePI) FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR v5.0.0-ballot. . For a full list of available versions, see the Directory of published versions

Resource Profile: PackagedProductDefinition (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/PackagedProductDefinition-uv-epi Version: 1.0.0-ballot
Active as of 2022-12-04 Computable Name: PackagedProductDefinitionUvEpi

PackagedProductDefinition (ePI)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... identifier
.... system 1..1uriThe namespace for the identifier value
Binding: PackagedProductDefinition identifier systems (extensible)
.... value 1..1stringThe value that is unique
... name 0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... type 0..1CodeableConceptA high level category e.g., medicinal product pack, sample pack, shipping container.
Binding: High level Pack Type (preferred)
... 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
Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate 0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity 0..*QuantityNumber of items in this overall pack
... description 0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... 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
Binding: Legal Status for the Supply (preferred)
.... jurisdiction 0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... country 0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... status 1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
... copackagedIndicator 0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer 0..*Reference(Organization (ePI))Manufacturer of this package type (multiple means these are all possible manufacturers)
... packaging
.... identifier 1..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
..... system 1..1uriThe namespace for the identifier value
Binding: Data Carrier Identifiers (preferred)
..... value 1..1stringThe value that is unique
.... type 0..1CodeableConceptThe physical type of the container of the items
Binding: Pack Type (preferred)
.... material 0..*CodeableConceptMaterial type of the package item
Binding: Package Material (preferred)
.... shelfLifeStorage 0..*ProductShelfLifeShelf Life and storage information.
..... type 0..1CodeableConceptThis 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
Binding: Shelf Life Type (preferred)
..... periodDuration 0..1DurationThe 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
...... code 0..1codeCoded form of the unit
Binding: Units of Measure (preferred)
..... specialPrecautionsForStorage 0..*CodeableConceptSpecial precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
Binding: Special Precautions For Storage (preferred)
.... manufacturer 0..*Reference(Organization (ePI))Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... containedItem
..... item 1..1CodeableReference(ManufacturedItemDefinition (ePI) | DeviceDefinition)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
.... packaging 0..*Used to nest layers of packaging; e.g., outside to inside with secondary package and then primary package)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PackagedProductDefinition.identifier.systemextensibleVsPackagedProductIdSystems
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)
PackagedProductDefinition.packaging.identifier.systempreferredVsDataCarrierIdSystem
PackagedProductDefinition.packaging.typepreferredVsSecondaryPrimaryPackType (a valid code from http://example.org)
PackagedProductDefinition.packaging.materialpreferredVsPackageMaterial (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.typepreferredVsShelfLifeType (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.periodDuration.codepreferredVsUnitofMeasure
PackagedProductDefinition.packaging.shelfLifeStorage.specialPrecautionsForStoragepreferredVsSpecialPrecautionsForStorage (a valid code from https://spor.ema.europa.eu/rmswi/100000073344)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... packageFor Σ0..*Reference(MedicinalProductDefinition (ePI))The product that this is a pack for
... 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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity Σ0..*QuantityNumber of items in this overall pack
... description Σ0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: Legal Status for the Supply (preferred)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country Σ0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... status Σ1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer Σ0..*Reference(Organization (ePI))Manufacturer of this package type (multiple means these are all possible manufacturers)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA unique identifier for this package as whole - not for the content of the package
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Binding: PackagedProductDefinition identifier systems (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... type Σ0..1CodeableConceptA high level category e.g., medicinal product pack, sample pack, shipping container.
Binding: High level Pack Type (preferred)
... packageFor Σ0..*Reference(MedicinalProductDefinition (ePI))The product that this is a pack for
... 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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity Σ0..*QuantityNumber of items in this overall pack
... description Σ0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: Legal Status for the Supply (preferred)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country Σ0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... jurisdiction Σ0..1CodeableConceptWhere a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
.... status Σ1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
.... dateRange Σ0..1PeriodThe date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
.... restoreDate Σ0..1dateTimeThe date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
Binding: PackageCharacteristic (example): A characteristic of a package.


... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer Σ0..*Reference(Organization (ePI))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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Binding: Data Carrier Identifiers (preferred)
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... type Σ0..1CodeableConceptThe physical type of the container of the items
Binding: Pack Type (preferred)
.... 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
Binding: Package Material (preferred)
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information.
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptThis 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
Binding: Shelf Life Type (preferred)
..... Slices for period[x] Σ0..1The 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
Slice: Unordered, Open by type:$this
...... periodDurationDuration
...... periodStringstring
...... period[x]:periodDuration Σ0..1DurationThe 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
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ0..1decimalNumerical value (with implicit precision)
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required)
....... unit Σ0..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code Σ0..1codeCoded form of the unit
Binding: Units of Measure (preferred)
..... specialPrecautionsForStorage Σ0..*CodeableConceptSpecial precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
Binding: Special Precautions For Storage (preferred)
.... manufacturer Σ0..*Reference(Organization (ePI))Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... item Σ1..1CodeableReference(ManufacturedItemDefinition (ePI) | DeviceDefinition)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 packaging (PackagedProductDefinition)Used to nest layers of packaging; e.g., outside to inside with secondary package and then primary package)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PackagedProductDefinition.identifier.userequiredIdentifierUse
PackagedProductDefinition.identifier.typeextensibleIdentifier Type Codes
PackagedProductDefinition.identifier.systemextensibleVsPackagedProductIdSystems
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)
PackagedProductDefinition.characteristicexamplePackageCharacteristic
PackagedProductDefinition.packaging.identifier.userequiredIdentifierUse
PackagedProductDefinition.packaging.identifier.typeextensibleIdentifier Type Codes
PackagedProductDefinition.packaging.identifier.systempreferredVsDataCarrierIdSystem
PackagedProductDefinition.packaging.typepreferredVsSecondaryPrimaryPackType (a valid code from http://example.org)
PackagedProductDefinition.packaging.materialpreferredVsPackageMaterial (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.alternateMaterialexamplePackageMaterial
PackagedProductDefinition.packaging.shelfLifeStorage.typepreferredVsShelfLifeType (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.period[x]:periodDuration.comparatorrequiredQuantityComparator
PackagedProductDefinition.packaging.shelfLifeStorage.period[x]:periodDuration.codepreferredVsUnitofMeasure
PackagedProductDefinition.packaging.shelfLifeStorage.specialPrecautionsForStoragepreferredVsSpecialPrecautionsForStorage (a valid code from https://spor.ema.europa.eu/rmswi/100000073344)
PackagedProductDefinition.packaging.property.typeexampleProductCharacteristic

Differential View

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... identifier
.... system 1..1uriThe namespace for the identifier value
Binding: PackagedProductDefinition identifier systems (extensible)
.... value 1..1stringThe value that is unique
... name 0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... type 0..1CodeableConceptA high level category e.g., medicinal product pack, sample pack, shipping container.
Binding: High level Pack Type (preferred)
... 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
Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate 0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity 0..*QuantityNumber of items in this overall pack
... description 0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... 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
Binding: Legal Status for the Supply (preferred)
.... jurisdiction 0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... country 0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... status 1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
... copackagedIndicator 0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer 0..*Reference(Organization (ePI))Manufacturer of this package type (multiple means these are all possible manufacturers)
... packaging
.... identifier 1..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
..... system 1..1uriThe namespace for the identifier value
Binding: Data Carrier Identifiers (preferred)
..... value 1..1stringThe value that is unique
.... type 0..1CodeableConceptThe physical type of the container of the items
Binding: Pack Type (preferred)
.... material 0..*CodeableConceptMaterial type of the package item
Binding: Package Material (preferred)
.... shelfLifeStorage 0..*ProductShelfLifeShelf Life and storage information.
..... type 0..1CodeableConceptThis 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
Binding: Shelf Life Type (preferred)
..... periodDuration 0..1DurationThe 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
...... code 0..1codeCoded form of the unit
Binding: Units of Measure (preferred)
..... specialPrecautionsForStorage 0..*CodeableConceptSpecial precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
Binding: Special Precautions For Storage (preferred)
.... manufacturer 0..*Reference(Organization (ePI))Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... containedItem
..... item 1..1CodeableReference(ManufacturedItemDefinition (ePI) | DeviceDefinition)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
.... packaging 0..*Used to nest layers of packaging; e.g., outside to inside with secondary package and then primary package)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PackagedProductDefinition.identifier.systemextensibleVsPackagedProductIdSystems
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)
PackagedProductDefinition.packaging.identifier.systempreferredVsDataCarrierIdSystem
PackagedProductDefinition.packaging.typepreferredVsSecondaryPrimaryPackType (a valid code from http://example.org)
PackagedProductDefinition.packaging.materialpreferredVsPackageMaterial (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.typepreferredVsShelfLifeType (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.periodDuration.codepreferredVsUnitofMeasure
PackagedProductDefinition.packaging.shelfLifeStorage.specialPrecautionsForStoragepreferredVsSpecialPrecautionsForStorage (a valid code from https://spor.ema.europa.eu/rmswi/100000073344)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... packageFor Σ0..*Reference(MedicinalProductDefinition (ePI))The product that this is a pack for
... 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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity Σ0..*QuantityNumber of items in this overall pack
... description Σ0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: Legal Status for the Supply (preferred)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country Σ0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... status Σ1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer Σ0..*Reference(Organization (ePI))Manufacturer of this package type (multiple means these are all possible manufacturers)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA unique identifier for this package as whole - not for the content of the package
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Binding: PackagedProductDefinition identifier systems (extensible)
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... name Σ0..1stringA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
Example name: 3 ml cartridge (glass) in a pre-filled pen
... type Σ0..1CodeableConceptA high level category e.g., medicinal product pack, sample pack, shipping container.
Binding: High level Pack Type (preferred)
... packageFor Σ0..*Reference(MedicinalProductDefinition (ePI))The product that this is a pack for
... 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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


Example Example Status: {"coding":[{"system":"http://hl7.org/fhir/publication-status","code":"active"}]}
... statusDate Σ0..1dateTimeThe date at which the given status became applicable
Example statusDate: 2015-02-07T13:28:17Z
... containedItemQuantity Σ0..*QuantityNumber of items in this overall pack
... description Σ0..1markdownNarrative description of the overall pack; e.g., description of a sample pack
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe actual status of supply. In what situation this package type may be supplied for use
Binding: Legal Status for the Supply (preferred)
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies
Binding: Country2 (preferred)
... 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.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... country Σ0..1CodeableConceptThe country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Binding: Country2 (preferred)
.... jurisdiction Σ0..1CodeableConceptWhere a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
.... status Σ1..1CodeableConceptThis attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: Marketing Status (preferred)
.... dateRange Σ0..1PeriodThe date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
.... restoreDate Σ0..1dateTimeThe date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
Binding: PackageCharacteristic (example): A characteristic of a package.


... copackagedIndicator Σ0..1booleanIf the drug product is supplied with another item such as a diluent
... manufacturer Σ0..*Reference(Organization (ePI))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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..*IdentifierAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriThe namespace for the identifier value
Binding: Data Carrier Identifiers (preferred)
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... type Σ0..1CodeableConceptThe physical type of the container of the items
Binding: Pack Type (preferred)
.... 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
Binding: Package Material (preferred)
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information.
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptThis 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
Binding: Shelf Life Type (preferred)
..... Slices for period[x] Σ0..1The 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
Slice: Unordered, Open by type:$this
...... periodDurationDuration
...... periodStringstring
...... period[x]:periodDuration Σ0..1DurationThe 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
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... value Σ0..1decimalNumerical value (with implicit precision)
....... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required)
....... unit Σ0..1stringUnit representation
....... system ΣC0..1uriSystem that defines coded unit form
....... code Σ0..1codeCoded form of the unit
Binding: Units of Measure (preferred)
..... specialPrecautionsForStorage Σ0..*CodeableConceptSpecial precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
Binding: Special Precautions For Storage (preferred)
.... manufacturer Σ0..*Reference(Organization (ePI))Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1CodeableConceptA code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... item Σ1..1CodeableReference(ManufacturedItemDefinition (ePI) | DeviceDefinition)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 packaging (PackagedProductDefinition)Used to nest layers of packaging; e.g., outside to inside with secondary package and then primary package)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PackagedProductDefinition.identifier.userequiredIdentifierUse
PackagedProductDefinition.identifier.typeextensibleIdentifier Type Codes
PackagedProductDefinition.identifier.systemextensibleVsPackagedProductIdSystems
PackagedProductDefinition.typepreferredVsPackageType
PackagedProductDefinition.statuspreferredPublicationStatus
PackagedProductDefinition.legalStatusOfSupply.codepreferredVsLegalStatusOfSupply (a valid code from https://spor.ema.europa.eu/rmswi/100000072051)
PackagedProductDefinition.legalStatusOfSupply.jurisdictionpreferredCountry2
PackagedProductDefinition.marketingStatus.countrypreferredCountry2
PackagedProductDefinition.marketingStatus.statuspreferredVsMarketingStatus (a valid code from https://spor.ema.europa.eu/rmswi/100000072052)
PackagedProductDefinition.characteristicexamplePackageCharacteristic
PackagedProductDefinition.packaging.identifier.userequiredIdentifierUse
PackagedProductDefinition.packaging.identifier.typeextensibleIdentifier Type Codes
PackagedProductDefinition.packaging.identifier.systempreferredVsDataCarrierIdSystem
PackagedProductDefinition.packaging.typepreferredVsSecondaryPrimaryPackType (a valid code from http://example.org)
PackagedProductDefinition.packaging.materialpreferredVsPackageMaterial (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.alternateMaterialexamplePackageMaterial
PackagedProductDefinition.packaging.shelfLifeStorage.typepreferredVsShelfLifeType (a valid code from https://spor.ema.europa.eu/omswi)
PackagedProductDefinition.packaging.shelfLifeStorage.period[x]:periodDuration.comparatorrequiredQuantityComparator
PackagedProductDefinition.packaging.shelfLifeStorage.period[x]:periodDuration.codepreferredVsUnitofMeasure
PackagedProductDefinition.packaging.shelfLifeStorage.specialPrecautionsForStoragepreferredVsSpecialPrecautionsForStorage (a valid code from https://spor.ema.europa.eu/rmswi/100000073344)
PackagedProductDefinition.packaging.property.typeexampleProductCharacteristic

 

Other representations of profile: CSV, Excel, Schematron