CH EPL (R5)
0.1.0 - ci-build

CH EPL (R5), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/bag-epl/bag-epl-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: IDMP PackagedProductDefinition

Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-packagedproductdefinition Version: 0.1.0
Active as of 2024-09-16 Computable Name: CHIDMPPackagedProductDefinition

Copyright/Legal: CC0-1.0

Profile of the PackagedProductDefinition resource for representing a medically related item or items, in a container or package.

Usage:

Formal Views of Profile Content

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

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition CH IDMP PackagedProductDefinition
... packageFor 0..* Reference(IDMP MedicinalProductDefinition) The product that this is a pack for
... description 0..1 markdown Textual description (this is not the name of the package or product)
... marketingStatus
.... 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
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
.... status 1..1 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: CH SMC - Marketing Status (required)
..... Slices for coding 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-marketing-status
....... code 1..1 code Symbol in syntax defined by the system
.... type 0..1 CodeableConcept The physical type of the container of the items
Binding: EDQM - Packaging (required)
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:0.4.0.127.0.16.1.1.2.1
....... code 1..1 code Symbol in syntax defined by the system
.... quantity 0..1 integer The quantity of this level of packaging in the package that contains it (with the outermost level being 1).
.... property
..... value[x] 1..1 CodeableConcept, Quantity, date, boolean, Attachment A value for the characteristic
.... containedItem
..... item 1..1 CodeableReference(CH IDMP ManufacturedItemDefinition | IDMP PackagedProductDefinition) 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 1..1 Quantity 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)
...... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PackagedProductDefinition.marketingStatus.statusrequiredChSMCMarketingStatusVS (a valid code from CH SMC - Marketing Status)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-marketing-status
from this IG
PackagedProductDefinition.packaging.typerequiredEdqmPackagingVS
http://fhir.ch/ig/ch-epl/ValueSet/edqm-packaging
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition CH IDMP PackagedProductDefinition
... 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
... 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.

... description Σ 0..1 markdown Textual description (this is not the name of the package or product)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard

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 CH IDMP PackagedProductDefinition
... 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
... identifier Σ 0..* Identifier A unique identifier for this package as whole - not for the content of the package
... 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 Σ 0..* Reference(IDMP MedicinalProductDefinition) 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 Σ 0..* 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 (especially the long definition)
... description Σ 0..1 markdown Textual description (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 Σ 0..* MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
.... 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
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... 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 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: CH SMC - Marketing Status (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-marketing-status
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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 CodeableConcept The physical type of the container of the items
Binding: EDQM - Packaging (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:0.4.0.127.0.16.1.1.2.1
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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] Σ 1..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(CH IDMP ManufacturedItemDefinition | IDMP PackagedProductDefinition) 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 Σ 1..1 Quantity 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)
...... 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
.... packaging Σ 0..* See packaging (PackagedProductDefinition) Allows containers (and parts of containers) within containers, still as a part of single packaged product
... 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.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.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.statusrequiredChSMCMarketingStatusVS (a valid code from CH SMC - Marketing Status)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-marketing-status
from this IG
PackagedProductDefinition.packaging.typerequiredEdqmPackagingVS
http://fhir.ch/ig/ch-epl/ValueSet/edqm-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

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

Summary

Mandatory: 0 element(11 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PackagedProductDefinition.marketingStatus.status.coding
  • The element 1 is sliced based on the value of PackagedProductDefinition.packaging.type.coding

Differential View

This structure is derived from PackagedProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition CH IDMP PackagedProductDefinition
... packageFor 0..* Reference(IDMP MedicinalProductDefinition) The product that this is a pack for
... description 0..1 markdown Textual description (this is not the name of the package or product)
... marketingStatus
.... 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
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
.... status 1..1 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: CH SMC - Marketing Status (required)
..... Slices for coding 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-marketing-status
....... code 1..1 code Symbol in syntax defined by the system
.... type 0..1 CodeableConcept The physical type of the container of the items
Binding: EDQM - Packaging (required)
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC 0..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:0.4.0.127.0.16.1.1.2.1
....... code 1..1 code Symbol in syntax defined by the system
.... quantity 0..1 integer The quantity of this level of packaging in the package that contains it (with the outermost level being 1).
.... property
..... value[x] 1..1 CodeableConcept, Quantity, date, boolean, Attachment A value for the characteristic
.... containedItem
..... item 1..1 CodeableReference(CH IDMP ManufacturedItemDefinition | IDMP PackagedProductDefinition) 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 1..1 Quantity 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)
...... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PackagedProductDefinition.marketingStatus.statusrequiredChSMCMarketingStatusVS (a valid code from CH SMC - Marketing Status)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-marketing-status
from this IG
PackagedProductDefinition.packaging.typerequiredEdqmPackagingVS
http://fhir.ch/ig/ch-epl/ValueSet/edqm-packaging
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PackagedProductDefinition 0..* PackagedProductDefinition CH IDMP PackagedProductDefinition
... 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
... 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.

... description Σ 0..1 markdown Textual description (this is not the name of the package or product)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PackagedProductDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard

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 CH IDMP PackagedProductDefinition
... 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
... identifier Σ 0..* Identifier A unique identifier for this package as whole - not for the content of the package
... 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 Σ 0..* Reference(IDMP MedicinalProductDefinition) 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 Σ 0..* 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 (especially the long definition)
... description Σ 0..1 markdown Textual description (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 Σ 0..* MarketingStatus Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
.... 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
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:iso:std:iso:3166
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: CH
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... 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 CodeableConcept This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
Binding: CH SMC - Marketing Status (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..1 Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://fhir.ch/ig/ch-epl/CodeSystem/ch-SMC-marketing-status
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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 CodeableConcept The physical type of the container of the items
Binding: EDQM - Packaging (required)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:SMC Σ 0..1 Coding Code defined by a terminology system
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Required Pattern: urn:oid:0.4.0.127.0.16.1.1.2.1
....... version Σ 0..1 string Version of the system - if relevant
....... code ΣC 1..1 code Symbol in syntax defined by the system
....... display ΣC 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... 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] Σ 1..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(CH IDMP ManufacturedItemDefinition | IDMP PackagedProductDefinition) 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 Σ 1..1 Quantity 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)
...... 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
.... packaging Σ 0..* See packaging (PackagedProductDefinition) Allows containers (and parts of containers) within containers, still as a part of single packaged product
... 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.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.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.statusrequiredChSMCMarketingStatusVS (a valid code from CH SMC - Marketing Status)
http://fhir.ch/ig/ch-epl/ValueSet/ch-SMC-marketing-status
from this IG
PackagedProductDefinition.packaging.typerequiredEdqmPackagingVS
http://fhir.ch/ig/ch-epl/ValueSet/edqm-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

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

Summary

Mandatory: 0 element(11 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PackagedProductDefinition.marketingStatus.status.coding
  • The element 1 is sliced based on the value of PackagedProductDefinition.packaging.type.coding

 

Other representations of profile: CSV, Excel, Schematron