Pharmaceutical Quality (Industry)
1.0.0 - STU1 International flag

This page is part of the Pharmaceutical Quality (Industry) (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: PackagedProductDefinitionDrugPq - Detailed Descriptions

Active as of 2024-05-08

Definitions for the PackagedProductDefinition-drug-pq resource profile.

Guidance on how to interpret the contents of this table can be found here

0. PackagedProductDefinition
2. PackagedProductDefinition.type
BindingFor example codes, see PackageType
(example to http://hl7.org/fhir/ValueSet/package-type)
Must Supporttrue
4. PackagedProductDefinition.packageFor
Must Supporttrue
6. PackagedProductDefinition.description
Must Supporttrue
8. PackagedProductDefinition.packaging
Must Supporttrue
10. PackagedProductDefinition.packaging.type
BindingThe codes SHOULD be taken from PackagingType
(preferred to http://hl7.org/fhir/ValueSet/packaging-type)

A high level categorisation of a package.

Must Supporttrue
12. PackagedProductDefinition.packaging.material
BindingThe codes SHOULD be taken from PackageMaterial
(preferred to http://hl7.org/fhir/ValueSet/package-material)

A material used in the construction of packages and their components.

Must Supporttrue
14. PackagedProductDefinition.packaging.shelfLifeStorage
Must Supporttrue
16. PackagedProductDefinition.packaging.manufacturer
Must Supporttrue
18. PackagedProductDefinition.packaging.property
Must Supporttrue
20. PackagedProductDefinition.packaging.property.type
BindingFor example codes, see Package Property
(example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-packageProperty-pq)
Must Supporttrue
22. PackagedProductDefinition.packaging.property.value[x]
TypeChoice of: CodeableConcept, Quantity, date, boolean, Attachment
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
SlicingThis element introduces a set of slices on PackagedProductDefinition.packaging.property.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 24. PackagedProductDefinition.packaging.property.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    BindingFor example codes, see Grades
    (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-grade-pq)
    Additional BindingsPurpose
    ColorsExtensible Binding
    TypeCodeableConcept
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Must Supporttrue
    26. PackagedProductDefinition.packaging.property.value[x]:valueQuantity
    Slice NamevalueQuantity
    TypeQuantity
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Must Supporttrue
    28. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.system
    Pattern Valuehttp://unitsofmeasure.org
    30. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.code
    BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
    (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)

    UCUM codes for unit

    32. PackagedProductDefinition.packaging.property.value[x]:valueBoolean
    Slice NamevalueBoolean
    Typeboolean
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    34. PackagedProductDefinition.packaging.containedItem
    Must Supporttrue
    36. PackagedProductDefinition.packaging.containedItem.amount
    Must Supporttrue
    38. PackagedProductDefinition.packaging.packaging
    TypeSee ttp://hl7.org/fhir/StructureDefinition/PackagedProductDefinition#PackagedProductDefinition.packaging
    Must Supporttrue

    Guidance on how to interpret the contents of this table can be found here

    0. PackagedProductDefinition
    Definition

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

    ShortA medically related item or items, in a container or package
    Control0..*
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. PackagedProductDefinition.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. PackagedProductDefinition.contained
    Definition

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

    ShortContained, inline Resources
    Comments

    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

    Control0..*
    This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
    TypeResource
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Alternate Namesinline resources, anonymous resources, contained resources
    6. PackagedProductDefinition.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. PackagedProductDefinition.type
    Definition

    A high level category e.g. medicinal product, raw material, shipping/transport container, etc.

    ShortA high level category e.g. medicinal product, raw material, shipping container etc
    Control0..1
    BindingFor example codes, see PackageTypehttp://hl7.org/fhir/ValueSet/package-type
    (example to http://hl7.org/fhir/ValueSet/package-type)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. PackagedProductDefinition.packageFor
    Definition

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

    ShortThe product that this is a pack for
    Control0..*
    TypeReference(MedicinalProductDefinition)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. 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.

    ShortThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
    Control0..1
    BindingThe codes SHOULD be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status
    (preferred to http://hl7.org/fhir/ValueSet/publication-status)

    The lifecycle status of an artifact.

    TypeCodeableConcept
    Is Modifiertrue because 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
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. PackagedProductDefinition.description
    Definition

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

    ShortTextual description. Note that this is not the name of the package or product
    Control0..1
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. PackagedProductDefinition.packaging
    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).

    ShortA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
    Control0..1
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. PackagedProductDefinition.packaging.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. PackagedProductDefinition.packaging.type
    Definition

    The physical type of the container of the items.

    ShortThe physical type of the container of the items
    Control0..1
    BindingThe codes SHOULD be taken from For example codes, see PackagingTypehttp://hl7.org/fhir/ValueSet/packaging-type
    (preferred to http://hl7.org/fhir/ValueSet/packaging-type)

    A high level categorisation of a package.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. PackagedProductDefinition.packaging.material
    Definition

    Material type of the package item.

    ShortMaterial type of the package item
    Control0..*
    BindingThe codes SHOULD be taken from For example codes, see PackageMaterialhttp://hl7.org/fhir/ValueSet/package-material
    (preferred to http://hl7.org/fhir/ValueSet/package-material)

    A material used in the construction of packages and their components.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. PackagedProductDefinition.packaging.shelfLifeStorage
    Definition

    Shelf Life and storage information.

    ShortShelf Life and storage information
    Control0..*
    TypeProductShelfLife
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. PackagedProductDefinition.packaging.manufacturer
    Definition

    Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.

    ShortManufacturer of this packaging item (multiple means these are all potential manufacturers)
    Control0..*
    TypeReference(Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. PackagedProductDefinition.packaging.property
    Definition

    General characteristics of this item.

    ShortGeneral characteristics of this item
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. PackagedProductDefinition.packaging.property.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    32. PackagedProductDefinition.packaging.property.type
    Definition

    A code expressing the type of characteristic.

    ShortA code expressing the type of characteristic
    Control1..1
    BindingFor example codes, see Package Propertyhttp://hl7.org/fhir/ValueSet/product-characteristic-codes
    (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-packageProperty-pq)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. PackagedProductDefinition.packaging.property.value[x]
    Definition

    A value for the characteristic.

    ShortA value for the characteristic
    Control0..1
    TypeChoice of: CodeableConcept, Quantity, date, boolean, Attachment
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on PackagedProductDefinition.packaging.property.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 36. PackagedProductDefinition.packaging.property.value[x]:valueCodeableConcept
      Slice NamevalueCodeableConcept
      Definition

      A value for the characteristic.

      ShortA value for the characteristic
      Control0..1
      BindingFor example codes, see For codes, see Grades
      (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-grade-pq)
      Additional BindingsPurpose
      ColorsExtensible Binding
      TypeCodeableConcept, date, boolean, Quantity, Attachment
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. PackagedProductDefinition.packaging.property.value[x]:valueQuantity
      Slice NamevalueQuantity
      Definition

      A value for the characteristic.

      ShortA value for the characteristic
      Control0..1
      TypeQuantity, date, boolean, Attachment, CodeableConcept
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.comparator
      Definition

      How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

      Short< | <= | >= | > | ad - how to understand the value
      Control0..1
      BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
      (required to http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0)

      How the Quantity should be understood and represented.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

      Meaning if MissingIf there is no comparator, then there is no modification of the value
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.system
      Definition

      The identification of the system that provides the coded form of the unit.

      ShortSystem that defines coded unit form
      Control0..1
      This element is affected by the following invariants: qty-3
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to know the system that defines the coded form of the unit.

      Pattern Valuehttp://unitsofmeasure.org
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.code
      Definition

      A computer processable form of the unit in some unit representation system.

      ShortCoded form of the unit
      Comments

      The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

      Control0..1
      This element is affected by the following invariants: qty-3
      BindingThe codes SHALL be taken from For codes, see UnitsOfMeasureCaseSensitive
      (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)

      UCUM codes for unit

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. PackagedProductDefinition.packaging.property.value[x]:valueBoolean
      Slice NamevalueBoolean
      Definition

      A value for the characteristic.

      ShortA value for the characteristic
      Control0..1
      Typeboolean, date, Quantity, Attachment, CodeableConcept
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. PackagedProductDefinition.packaging.containedItem
      Definition

      The item(s) within the packaging.

      ShortThe item(s) within the packaging
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. PackagedProductDefinition.packaging.containedItem.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      52. PackagedProductDefinition.packaging.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.packaging.packaging).

      ShortThe 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
      Control1..1
      TypeCodeableReference(ManufacturedItemDefinition, DeviceDefinition, PackagedProductDefinition, BiologicallyDerivedProduct, NutritionProduct)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. PackagedProductDefinition.packaging.containedItem.amount
      Definition

      The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition).

      ShortThe number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition)
      Control0..1
      TypeQuantity
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. PackagedProductDefinition.packaging.packaging
      Definition

      Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).

      ShortAllows containers (and parts of containers) within containers, still as a part of single packaged product
      Control0..*
      TypeSee ttp://hl7.org/fhir/StructureDefinition/PackagedProductDefinition#PackagedProductDefinition.packaging
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. PackagedProductDefinition
      Definition

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

      ShortA medically related item or items, in a container or package
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. PackagedProductDefinition.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      4. PackagedProductDefinition.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. PackagedProductDefinition.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. PackagedProductDefinition.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHALL be taken from AllLanguages
      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

      IETF language tag for a human language

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. PackagedProductDefinition.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      This element is affected by the following invariants: dom-6
      TypeNarrative
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. PackagedProductDefinition.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. PackagedProductDefinition.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. PackagedProductDefinition.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Must Supportfalse
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. PackagedProductDefinition.identifier
      Definition

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

      ShortA unique identifier for this package as whole - not for the content of the package
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. PackagedProductDefinition.name
      Definition

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

      ShortA name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. PackagedProductDefinition.type
      Definition

      A high level category e.g. medicinal product, raw material, shipping/transport container, etc.

      ShortA high level category e.g. medicinal product, raw material, shipping container etc
      Control0..1
      BindingFor example codes, see PackageType
      (example to http://hl7.org/fhir/ValueSet/package-type)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. PackagedProductDefinition.packageFor
      Definition

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

      ShortThe product that this is a pack for
      Control0..*
      TypeReference(MedicinalProductDefinition)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. 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.

      ShortThe status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
      Control0..1
      BindingThe codes SHOULD be taken from PublicationStatus
      (preferred to http://hl7.org/fhir/ValueSet/publication-status)

      The lifecycle status of an artifact.

      TypeCodeableConcept
      Is Modifiertrue because 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
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. PackagedProductDefinition.statusDate
      Definition

      The date at which the given status became applicable.

      ShortThe date at which the given status became applicable
      Control0..1
      TypedateTime
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. 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.

      ShortA 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. See also packaging.containedItem.amount (especially the long definition)
      Control0..*
      TypeQuantity
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. PackagedProductDefinition.description
      Definition

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

      ShortTextual description. Note that this is not the name of the package or product
      Control0..1
      Typemarkdown
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      34. PackagedProductDefinition.legalStatusOfSupply
      Definition

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

      ShortThe legal status of supply of the packaged item as classified by the regulator
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. PackagedProductDefinition.legalStatusOfSupply.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      38. PackagedProductDefinition.legalStatusOfSupply.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      40. PackagedProductDefinition.legalStatusOfSupply.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      42. PackagedProductDefinition.legalStatusOfSupply.code
      Definition

      The actual status of supply. Conveys in what situation this package type may be supplied for use.

      ShortThe actual status of supply. In what situation this package type may be supplied for use
      Control0..1
      BindingFor example codes, see LegalStatusOfSupply
      (example to http://hl7.org/fhir/ValueSet/legal-status-of-supply)

      The prescription supply types appropriate to a medicinal product

      TypeCodeableConcept
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. PackagedProductDefinition.legalStatusOfSupply.jurisdiction
      Definition

      The place where the legal status of supply applies. When not specified, this indicates it is unknown in this context.

      ShortThe place where the legal status of supply applies
      Control0..1
      BindingFor example codes, see JurisdictionValueSet
      (example to http://hl7.org/fhir/ValueSet/jurisdiction)

      Jurisdiction codes

      TypeCodeableConcept
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. 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.

      ShortAllows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
      Control0..*
      TypeMarketingStatus
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. PackagedProductDefinition.copackagedIndicator
      Definition

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

      ShortIdentifies if the drug product is supplied with another item such as a diluent or adjuvant
      Control0..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Meaning if MissingIf this value is not present, there is no statement being made about whether this is co-packaged or not. No inference can be made
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. PackagedProductDefinition.manufacturer
      Definition

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

      ShortManufacturer of this package type (multiple means these are all possible manufacturers)
      Control0..*
      TypeReference(Organization)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      52. PackagedProductDefinition.attachedDocument
      Definition

      Additional information or supporting documentation about the packaged product.

      ShortAdditional information or supporting documentation about the packaged product
      Control0..*
      TypeReference(DocumentReference)
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      54. PackagedProductDefinition.packaging
      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).

      ShortA packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
      Control0..1
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. PackagedProductDefinition.packaging.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      58. PackagedProductDefinition.packaging.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      60. PackagedProductDefinition.packaging.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      62. PackagedProductDefinition.packaging.identifier
      Definition

      A 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).

      ShortAn identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      64. PackagedProductDefinition.packaging.type
      Definition

      The physical type of the container of the items.

      ShortThe physical type of the container of the items
      Control0..1
      BindingThe codes SHOULD be taken from PackagingType
      (preferred to http://hl7.org/fhir/ValueSet/packaging-type)

      A high level categorisation of a package.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      66. PackagedProductDefinition.packaging.componentPart
      Definition

      Is this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial). The latter type are designed be a container, but the former are not.

      ShortIs this a part of the packaging (e.g. a cap or bottle stopper), rather than the packaging itself (e.g. a bottle or vial)
      Control0..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Meaning if MissingIf absent, it cannot be assumed that the item is packaging (a container) or a part of the packaging - it is just 'packaging'. Systems can sometimes infer this from the packaging.type (e.g. bottles are containers, bottle caps are not), or from the fact that a container will usually have other items within it (though it is possible that these exist but are not mentioned). Often the distinction is not critical - and can easily be understood by humans - but if that is necessary for machine processing it is recommended that this attribute is given a value.
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      68. PackagedProductDefinition.packaging.quantity
      Definition

      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 2.

      ShortThe quantity of this level of packaging in the package that contains it (with the outermost level being 1)
      Control0..1
      Typeinteger
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      70. PackagedProductDefinition.packaging.material
      Definition

      Material type of the package item.

      ShortMaterial type of the package item
      Control0..*
      BindingThe codes SHOULD be taken from PackageMaterial
      (preferred to http://hl7.org/fhir/ValueSet/package-material)

      A material used in the construction of packages and their components.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. PackagedProductDefinition.packaging.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).

      ShortA possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
      Control0..*
      BindingFor example codes, see PackageMaterial
      (example to http://hl7.org/fhir/ValueSet/package-material)

      A material used in the construction of packages and their components.

      TypeCodeableConcept
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      74. PackagedProductDefinition.packaging.shelfLifeStorage
      Definition

      Shelf Life and storage information.

      ShortShelf Life and storage information
      Control0..*
      TypeProductShelfLife
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      76. PackagedProductDefinition.packaging.manufacturer
      Definition

      Manufacturer of this packaging item. When there are multiple values each one is a potential manufacturer of this packaging item.

      ShortManufacturer of this packaging item (multiple means these are all potential manufacturers)
      Control0..*
      TypeReference(Organization)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      78. PackagedProductDefinition.packaging.property
      Definition

      General characteristics of this item.

      ShortGeneral characteristics of this item
      Control0..*
      TypeBackboneElement
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      80. PackagedProductDefinition.packaging.property.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      82. PackagedProductDefinition.packaging.property.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      84. PackagedProductDefinition.packaging.property.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      86. PackagedProductDefinition.packaging.property.type
      Definition

      A code expressing the type of characteristic.

      ShortA code expressing the type of characteristic
      Control1..1
      BindingFor example codes, see Package Property
      (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-packageProperty-pq)
      TypeCodeableConcept
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      88. PackagedProductDefinition.packaging.property.value[x]
      Definition

      A value for the characteristic.

      ShortA value for the characteristic
      Control0..1
      TypeChoice of: CodeableConcept, Quantity, date, boolean, Attachment
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on PackagedProductDefinition.packaging.property.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 90. PackagedProductDefinition.packaging.property.value[x]:valueCodeableConcept
        Slice NamevalueCodeableConcept
        Definition

        A value for the characteristic.

        ShortA value for the characteristic
        Control0..1
        BindingFor example codes, see Grades
        (example to http://hl7.org/fhir/uv/pharm-quality/ValueSet/vs-grade-pq)
        Additional BindingsPurpose
        ColorsExtensible Binding
        TypeCodeableConcept
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        92. PackagedProductDefinition.packaging.property.value[x]:valueQuantity
        Slice NamevalueQuantity
        Definition

        A value for the characteristic.

        ShortA value for the characteristic
        Control0..1
        TypeQuantity
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeid
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        96. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on PackagedProductDefinition.packaging.property.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 98. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.value
          Definition

          The value of the measured amount. The value includes an implicit precision in the presentation of the value.

          ShortNumerical value (with implicit precision)
          Comments

          The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

          Control0..1
          Typedecimal
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Precision is handled implicitly in almost all cases of measurement.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          100. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.comparator
          Definition

          How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

          Short< | <= | >= | > | ad - how to understand the value
          Control0..1
          BindingThe codes SHALL be taken from QuantityComparator
          (required to http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0)

          How the Quantity should be understood and represented.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

          Meaning if MissingIf there is no comparator, then there is no modification of the value
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          102. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.unit
          Definition

          A human-readable form of the unit.

          ShortUnit representation
          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          104. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.system
          Definition

          The identification of the system that provides the coded form of the unit.

          ShortSystem that defines coded unit form
          Control0..1
          This element is affected by the following invariants: qty-3
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need to know the system that defines the coded form of the unit.

          Pattern Valuehttp://unitsofmeasure.org
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          106. PackagedProductDefinition.packaging.property.value[x]:valueQuantity.code
          Definition

          A computer processable form of the unit in some unit representation system.

          ShortCoded form of the unit
          Comments

          The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

          Control0..1
          This element is affected by the following invariants: qty-3
          BindingThe codes SHALL be taken from UnitsOfMeasureCaseSensitive
          (required to http://terminology.hl7.org/ValueSet/v3-UnitsOfMeasureCaseSensitive)

          UCUM codes for unit

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          108. PackagedProductDefinition.packaging.property.value[x]:valueBoolean
          Slice NamevalueBoolean
          Definition

          A value for the characteristic.

          ShortA value for the characteristic
          Control0..1
          Typeboolean
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          110. PackagedProductDefinition.packaging.containedItem
          Definition

          The item(s) within the packaging.

          ShortThe item(s) within the packaging
          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          112. PackagedProductDefinition.packaging.containedItem.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          114. PackagedProductDefinition.packaging.containedItem.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          116. PackagedProductDefinition.packaging.containedItem.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          118. PackagedProductDefinition.packaging.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.packaging.packaging).

          ShortThe 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
          Control1..1
          TypeCodeableReference(ManufacturedItemDefinition, DeviceDefinition, PackagedProductDefinition, BiologicallyDerivedProduct, NutritionProduct)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          120. PackagedProductDefinition.packaging.containedItem.amount
          Definition

          The number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition).

          ShortThe number of this type of item within this packaging or for continuous items such as liquids it is the quantity (for example 25ml). See also PackagedProductDefinition.containedItemQuantity (especially the long definition)
          Control0..1
          TypeQuantity
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          122. PackagedProductDefinition.packaging.packaging
          Definition

          Allows containers (and parts of containers) within containers, still as a part of a single packaged product. See also PackagedProductDefinition.packaging.containedItem.item(PackagedProductDefinition).

          ShortAllows containers (and parts of containers) within containers, still as a part of single packaged product
          Control0..*
          TypeSee ttp://hl7.org/fhir/StructureDefinition/PackagedProductDefinition#PackagedProductDefinition.packaging
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          124. PackagedProductDefinition.characteristic
          Definition

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

          ShortAllows the key features to be recorded, such as "hospital pack", "nurse prescribable"
          Control0..*
          TypeSee ttp://hl7.org/fhir/StructureDefinition/PackagedProductDefinition#PackagedProductDefinition.packaging.property
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))