0.1.0 - ci-build

AGESMedicinalProductR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Packaged product definition

Official URL: https://www.ages.at/fhir/medicinalproduct/StructureDefinition/at-medprod-packagedProductDefinition Version: 0.1.0
Draft as of 2024-05-27 Computable Name: AT_MedicinalProduct_PackagedProductDefinition

Defines the package information of a medicinal product

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... Slices for identifier 2..* AT_MedicinalProduct_Identifier A unique identifier for this package as whole - not for the content of the package (pharmaceutical registration number (Pharmazentralnummer (PZN)))
Slice: Unordered, Open by value:system
.... identifier:PZN 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
.... identifier:referenceNumber 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... packageFor 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... containedItemQuantity 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... value 1..1 decimal Numerical value (with implicit precision)
.... system 1..1 uri System that defines coded unit form
.... code 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)
... packaging
.... type 0..1 AT_MedicinalProduct_CodeableConcept The physical type of the container of the items (package type container) (Presentation List)
Binding: The Packaging Value Set (required)
.... containedItem
..... amount 0..1 Quantity The amount of the manufactured Item inside this packaging (E.g. Number of ml in a bottle). Not to be mistaken with the .containedItemQuantity which is the total presentable items in the package.
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
...... code 1..1 code Coded form of the unit
Binding: The Units of Measurement Value Set (required)
.... packaging 0..* In order to add more package types, additional packagings must be added first with a reference to the packaging it is included in.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG
PackagedProductDefinition.packaging.typerequiredPackagingVs (a valid code from Domain)
https://ema.europa.eu/fhir/vs/packaging
from this IG
PackagedProductDefinition.packaging.containedItem.amount.coderequiredUnitsOfMeasurementVs (a valid code from Units Of Measurement)
https://ema.europa.eu/fhir/vs/unitsOfMeasurement
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:PZN Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
.... identifier:referenceNumber Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... packageFor Σ 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... status ?!Σ 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... containedItemQuantity Σ 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... system ΣC 1..1 uri System that defines coded unit form
.... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
... marketingStatus Σ 1..1 MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated (delivery state of the package)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.identifier:PZN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 2..* AT_MedicinalProduct_Identifier A unique identifier for this package as whole - not for the content of the package (pharmaceutical registration number (Pharmazentralnummer (PZN)))
Slice: Unordered, Open by value:system
.... identifier:PZN Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:referenceNumber Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name Σ 0..1 string A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ 0..1 CodeableConcept A high level category e.g. medicinal product, raw material, shipping container etc
Binding: PackageType (example): A high level categorisation of a package.

... packageFor Σ 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... status ?!Σ 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ 0..1 dateTime The date at which the given status became applicable
... containedItemQuantity Σ 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ 0..1 string Unit representation
.... system ΣC 1..1 uri System that defines coded unit form
.... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
... description Σ 0..1 markdown Textual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ 0..* BackboneElement The legal status of supply of the packaged item as classified by the regulator
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..1 CodeableConcept The actual status of supply. In what situation this package type may be supplied for use
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

.... jurisdiction Σ 0..1 CodeableConcept The place where the legal status of supply applies
Binding: JurisdictionValueSet (example): Jurisdiction codes

... marketingStatus Σ 1..1 MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated (delivery state of the package)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country Σ 0..1 CodeableConcept The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
.... jurisdiction Σ 0..1 CodeableConcept Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)
.... dateRange Σ 0..1 Period The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
.... restoreDate Σ 0..1 dateTime The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
... copackagedIndicator Σ 0..1 boolean Identifies if the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ 0..* Reference(Organization) Manufacturer of this package type (multiple means these are all possible manufacturers)
... attachedDocument Σ 0..* Reference(DocumentReference) Additional information or supporting documentation about the packaged product
... packaging Σ 0..1 BackboneElement A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type 0..1 AT_MedicinalProduct_CodeableConcept The physical type of the container of the items (package type container) (Presentation List)
Binding: The Packaging Value Set (required)
.... componentPart Σ 0..1 boolean 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)
.... quantity Σ 0..1 integer The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ 0..* CodeableConcept Material type of the package item
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... alternateMaterial Σ 0..* CodeableConcept A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ 0..* ProductShelfLife Shelf Life and storage information
.... manufacturer Σ 0..* Reference(Organization) Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ 0..* BackboneElement General characteristics of this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept A code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ 0..1 A value for the characteristic
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueDate date
...... valueBoolean boolean
...... valueAttachment Attachment
.... containedItem Σ 0..* BackboneElement The item(s) within the packaging
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... item Σ 1..1 CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct) The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ 0..1 Quantity The amount of the manufactured Item inside this packaging (E.g. Number of ml in a bottle). Not to be mistaken with the .containedItemQuantity which is the total presentable items in the package.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
...... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Measurement Value Set (required)
.... packaging Σ 0..* See packaging (PackagedProductDefinition) In order to add more package types, additional packagings must be added first with a reference to the packaging it is included in.
... characteristic Σ 0..* See property (PackagedProductDefinition) Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:PZN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:PZN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PackagedProductDefinition.typeexamplePackageType
http://hl7.org/fhir/ValueSet/package-type
from the FHIR Standard
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.legalStatusOfSupply.codeexampleLegalStatusOfSupply
http://hl7.org/fhir/ValueSet/legal-status-of-supply
from the FHIR Standard
PackagedProductDefinition.legalStatusOfSupply.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG
PackagedProductDefinition.packaging.typerequiredPackagingVs (a valid code from Domain)
https://ema.europa.eu/fhir/vs/packaging
from this IG
PackagedProductDefinition.packaging.materialexamplePackageMaterial
http://hl7.org/fhir/ValueSet/package-material
from the FHIR Standard
PackagedProductDefinition.packaging.alternateMaterialexamplePackageMaterial
http://hl7.org/fhir/ValueSet/package-material
from the FHIR Standard
PackagedProductDefinition.packaging.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
PackagedProductDefinition.packaging.containedItem.amount.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.packaging.containedItem.amount.coderequiredUnitsOfMeasurementVs (a valid code from Units Of Measurement)
https://ema.europa.eu/fhir/vs/unitsOfMeasurement
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PackagedProductDefinition

Differential View

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... Slices for identifier 2..* AT_MedicinalProduct_Identifier A unique identifier for this package as whole - not for the content of the package (pharmaceutical registration number (Pharmazentralnummer (PZN)))
Slice: Unordered, Open by value:system
.... identifier:PZN 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
.... identifier:referenceNumber 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... system 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... packageFor 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... containedItemQuantity 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... value 1..1 decimal Numerical value (with implicit precision)
.... system 1..1 uri System that defines coded unit form
.... code 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)
... packaging
.... type 0..1 AT_MedicinalProduct_CodeableConcept The physical type of the container of the items (package type container) (Presentation List)
Binding: The Packaging Value Set (required)
.... containedItem
..... amount 0..1 Quantity The amount of the manufactured Item inside this packaging (E.g. Number of ml in a bottle). Not to be mistaken with the .containedItemQuantity which is the total presentable items in the package.
...... value 1..1 decimal Numerical value (with implicit precision)
...... unit 1..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
...... code 1..1 code Coded form of the unit
Binding: The Units of Measurement Value Set (required)
.... packaging 0..* In order to add more package types, additional packagings must be added first with a reference to the packaging it is included in.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG
PackagedProductDefinition.packaging.typerequiredPackagingVs (a valid code from Domain)
https://ema.europa.eu/fhir/vs/packaging
from this IG
PackagedProductDefinition.packaging.containedItem.amount.coderequiredUnitsOfMeasurementVs (a valid code from Units Of Measurement)
https://ema.europa.eu/fhir/vs/unitsOfMeasurement
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier:PZN Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
.... identifier:referenceNumber Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... packageFor Σ 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... status ?!Σ 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... containedItemQuantity Σ 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... system ΣC 1..1 uri System that defines coded unit form
.... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
... marketingStatus Σ 1..1 MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated (delivery state of the package)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.identifier:PZN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition A medically related item or items, in a container or package
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 2..* AT_MedicinalProduct_Identifier A unique identifier for this package as whole - not for the content of the package (pharmaceutical registration number (Pharmazentralnummer (PZN)))
Slice: Unordered, Open by value:system
.... identifier:PZN Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://argepharma.fcio.at
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:referenceNumber Σ 1..1 Identifier A unique identifier for this package as whole - not for the content of the package
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... name Σ 0..1 string A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
... type Σ 0..1 CodeableConcept A high level category e.g. medicinal product, raw material, shipping container etc
Binding: PackageType (example): A high level categorisation of a package.

... packageFor Σ 1..1 Reference(Medicinal Product Definition) The product that this is a pack for
... status ?!Σ 0..1 CodeableConcept The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... statusDate Σ 0..1 dateTime The date at which the given status became applicable
... containedItemQuantity Σ 1..1 Quantity 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. See also packaging.containedItem.amount (size / weight of the package)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

.... unit Σ 0..1 string Unit representation
.... system ΣC 1..1 uri System that defines coded unit form
.... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Presentation Value Set (required)
... description Σ 0..1 markdown Textual description. Note that this is not the name of the package or product
... legalStatusOfSupply Σ 0..* BackboneElement The legal status of supply of the packaged item as classified by the regulator
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..1 CodeableConcept The actual status of supply. In what situation this package type may be supplied for use
Binding: LegalStatusOfSupply (example): The prescription supply types appropriate to a medicinal product

.... jurisdiction Σ 0..1 CodeableConcept The place where the legal status of supply applies
Binding: JurisdictionValueSet (example): Jurisdiction codes

... marketingStatus Σ 1..1 MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated (delivery state of the package)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... country Σ 0..1 CodeableConcept The country in which the marketing authorization has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
.... jurisdiction Σ 0..1 CodeableConcept Where a Medicines Regulatory Agency has granted a marketing authorization for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
.... status 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Marketing Status value Set (required)
.... dateRange Σ 0..1 Period The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
.... restoreDate Σ 0..1 dateTime The date when the Medicinal Product is placed on the market by the Marketing Authorization Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
... copackagedIndicator Σ 0..1 boolean Identifies if the drug product is supplied with another item such as a diluent or adjuvant
... manufacturer Σ 0..* Reference(Organization) Manufacturer of this package type (multiple means these are all possible manufacturers)
... attachedDocument Σ 0..* Reference(DocumentReference) Additional information or supporting documentation about the packaged product
... packaging Σ 0..1 BackboneElement A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 0..* Identifier An identifier that is specific to this particular part of the packaging. Including possibly a Data Carrier Identifier
.... type 0..1 AT_MedicinalProduct_CodeableConcept The physical type of the container of the items (package type container) (Presentation List)
Binding: The Packaging Value Set (required)
.... componentPart Σ 0..1 boolean 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)
.... quantity Σ 0..1 integer The quantity of this level of packaging in the package that contains it (with the outermost level being 1)
.... material Σ 0..* CodeableConcept Material type of the package item
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... alternateMaterial Σ 0..* CodeableConcept A possible alternate material for this part of the packaging, that is allowed to be used instead of the usual material
Binding: PackageMaterial (example): A material used in the construction of packages and their components.


.... shelfLifeStorage Σ 0..* ProductShelfLife Shelf Life and storage information
.... manufacturer Σ 0..* Reference(Organization) Manufacturer of this packaging item (multiple means these are all potential manufacturers)
.... property Σ 0..* BackboneElement General characteristics of this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 1..1 CodeableConcept A code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

..... value[x] Σ 0..1 A value for the characteristic
...... valueCodeableConcept CodeableConcept
...... valueQuantity Quantity
...... valueDate date
...... valueBoolean boolean
...... valueAttachment Attachment
.... containedItem Σ 0..* BackboneElement The item(s) within the packaging
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... item Σ 1..1 CodeableReference(ManufacturedItemDefinition | DeviceDefinition | PackagedProductDefinition | BiologicallyDerivedProduct | NutritionProduct) The actual item(s) of medication, as manufactured, or a device, or other medically related item (food, biologicals, raw materials, medical fluids, gases etc.), as contained in the package
..... amount Σ 0..1 Quantity The amount of the manufactured Item inside this packaging (E.g. Number of ml in a bottle). Not to be mistaken with the .containedItemQuantity which is the total presentable items in the package.
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... value Σ 1..1 decimal Numerical value (with implicit precision)
...... comparator ?!Σ 0..1 code < | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

...... unit Σ 1..1 string Unit representation
...... system ΣC 1..1 uri System that defines coded unit form
...... code ΣC 1..1 code Coded form of the unit
Binding: The Units of Measurement Value Set (required)
.... packaging Σ 0..* See packaging (PackagedProductDefinition) In order to add more package types, additional packagings must be added first with a reference to the packaging it is included in.
... characteristic Σ 0..* See property (PackagedProductDefinition) Allows the key features to be recorded, such as "hospital pack", "nurse prescribable"

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:PZN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:PZN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
PackagedProductDefinition.identifier:referenceNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PackagedProductDefinition.typeexamplePackageType
http://hl7.org/fhir/ValueSet/package-type
from the FHIR Standard
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.containedItemQuantity.coderequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
PackagedProductDefinition.legalStatusOfSupply.codeexampleLegalStatusOfSupply
http://hl7.org/fhir/ValueSet/legal-status-of-supply
from the FHIR Standard
PackagedProductDefinition.legalStatusOfSupply.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
PackagedProductDefinition.marketingStatus.statusrequiredMarketingStatusVs (a valid code from Marketing Status)
https://ema.europa.eu/fhir/vs/marketingStatus
from this IG
PackagedProductDefinition.packaging.typerequiredPackagingVs (a valid code from Domain)
https://ema.europa.eu/fhir/vs/packaging
from this IG
PackagedProductDefinition.packaging.materialexamplePackageMaterial
http://hl7.org/fhir/ValueSet/package-material
from the FHIR Standard
PackagedProductDefinition.packaging.alternateMaterialexamplePackageMaterial
http://hl7.org/fhir/ValueSet/package-material
from the FHIR Standard
PackagedProductDefinition.packaging.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
PackagedProductDefinition.packaging.containedItem.amount.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|5.0.0
from the FHIR Standard
PackagedProductDefinition.packaging.containedItem.amount.coderequiredUnitsOfMeasurementVs (a valid code from Units Of Measurement)
https://ema.europa.eu/fhir/vs/unitsOfMeasurement
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PackagedProductDefinition

 

Other representations of profile: CSV, Excel, Schematron