Order Catalog Implementation Guide
current - CI Build

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: DrugPackage Profile

Defining URL:http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DrugPackage
Version:current
Name:DrugPackage
Title:definition of a packaging of a medication
Status:Draft as of 2022-06-10 11:57:00+0100
Definition:

This profile constrains the base resource PackagedProductDefinition to represent a definition of a packaging in a catalog of medications.

Publisher:HL7 International - Orders and Observations Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DrugPackage

Formal Views of Profile Content

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

This structure is derived from PackagedProductDefinition

Summary

Mandatory: 1 element
Must-Support: 1 element

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... name S0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
... type 1..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping/transport container, etc

doco Documentation for this format
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..*IdentifierUnique identifier
... name SΣ0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
... type Σ1..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping/transport container, etc
... packageFor Σ0..*Reference(MedicinalProductDefinition)The product that this is a pack for
... status ?!Σ0..1CodeableConceptThe 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
Binding: PublicationStatus (preferred): Identifies the level of importance to be assigned to actioning the request.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*QuantityA total of the amount of items in the package, per item type. 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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... id 0..1idUnique 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
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies. When not specified, this indicates it is unknown in this context
... marketingStatus Σ0..*MarketingStatusMarketing information
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack"
... copackagedIndicator Σ0..1booleanStates whether a drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type. When there are multiple it means these are all possible manufacturers
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the packaged product
... package Σ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 (which is not a device or a medication manufactured item)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierIncluding possibly Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it. If specified, the outermost level is always 1
.... material Σ0..*CodeableConceptMaterial type of the package item
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for the packaging
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1idUnique 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
..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1idUnique 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 | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package)
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... package Σ0..*See package (PackagedProductDefinition)Allows containers (and parts of containers) within containers, still a single packaged product. See also PackagedProductDefinition.package.containedItem.item(PackagedProductDefinition)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... name Σ0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc

doco Documentation for this format

This structure is derived from PackagedProductDefinition

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..*PackagedProductDefinitionA medically related item or items, in a container or package
... name S0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
... type 1..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping/transport container, etc

doco Documentation for this format

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..*IdentifierUnique identifier
... name SΣ0..1stringA name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc
... type Σ1..1CodeableConceptA high level category e.g. medicinal product, raw material, shipping/transport container, etc
... packageFor Σ0..*Reference(MedicinalProductDefinition)The product that this is a pack for
... status ?!Σ0..1CodeableConceptThe 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
Binding: PublicationStatus (preferred): Identifies the level of importance to be assigned to actioning the request.

... statusDate Σ0..1dateTimeThe date at which the given status became applicable
... containedItemQuantity Σ0..*QuantityA total of the amount of items in the package, per item type. 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
... description Σ0..1markdownTextual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ0..*BackboneElementThe legal status of supply of the packaged item as classified by the regulator
.... id 0..1idUnique 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
.... jurisdiction Σ0..1CodeableConceptThe place where the legal status of supply applies. When not specified, this indicates it is unknown in this context
... marketingStatus Σ0..*MarketingStatusMarketing information
... characteristic Σ0..*CodeableConceptAllows the key features to be recorded, such as "hospital pack", "nurse prescribable", "calendar pack"
... copackagedIndicator Σ0..1booleanStates whether a drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ0..*Reference(Organization)Manufacturer of this package type. When there are multiple it means these are all possible manufacturers
... attachedDocument Σ0..*Reference(DocumentReference)Additional information or supporting documentation about the packaged product
... package Σ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 (which is not a device or a medication manufactured item)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierIncluding possibly Data Carrier Identifier
.... type Σ0..1CodeableConceptThe physical type of the container of the items
.... quantity Σ0..1integerThe quantity of this level of packaging in the package that contains it. If specified, the outermost level is always 1
.... material Σ0..*CodeableConceptMaterial type of the package item
.... alternateMaterial Σ0..*CodeableConceptA possible alternate material for the packaging
.... shelfLifeStorage Σ0..*ProductShelfLifeShelf Life and storage information
.... manufacturer Σ0..*Reference(Organization)Manufacturer of this package Item. When there are multiple it means these are all possible manufacturers
.... property Σ0..*BackboneElementGeneral characteristics of this item
..... id 0..1idUnique 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
..... value[x] Σ0..1A value for the characteristic
...... valueCodeableConceptCodeableConcept
...... valueQuantityQuantity
...... valueDatedate
...... valueBooleanboolean
...... valueAttachmentAttachment
.... containedItem Σ0..*BackboneElementThe item(s) within the packaging
..... id 0..1idUnique 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 | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct)The actual item(s) of medication, as manufactured, or a device (typically, but not necessarily, a co-packaged one), or other medically related item (such as food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package. This also allows another whole packaged product to be included, which is solely for the case where a package of other entire packages is wanted - such as a wholesale or distribution pack (for layers within one package, use PackagedProductDefinition.package.package)
..... amount Σ0..1QuantityThe number of this type of item within this packaging
.... package Σ0..*See package (PackagedProductDefinition)Allows containers (and parts of containers) within containers, still a single packaged product. See also PackagedProductDefinition.package.containedItem.item(PackagedProductDefinition)

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
PackagedProductDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
PackagedProductDefinition.statuspreferredPublicationStatus

Constraints

IdGradePathDetailsRequirements
dom-2errorPackagedProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPackagedProductDefinitionIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPackagedProductDefinitionIf 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-5errorPackagedProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticePackagedProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorPackagedProductDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.packageForAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.statusDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.containedItemQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.legalStatusOfSupplyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.legalStatusOfSupply.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.legalStatusOfSupply.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.legalStatusOfSupply.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.legalStatusOfSupply.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.legalStatusOfSupply.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.legalStatusOfSupply.jurisdictionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.marketingStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.characteristicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.copackagedIndicatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.attachedDocumentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.packageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.materialAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.alternateMaterialAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.shelfLifeStorageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.propertyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.property.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.property.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.property.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.property.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.property.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.property.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.containedItemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.containedItem.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.containedItem.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.containedItem.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPackagedProductDefinition.package.containedItem.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPackagedProductDefinition.package.containedItem.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.containedItem.amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPackagedProductDefinition.package.packageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())