HL7 Europe Base and Core FHIR IG
0.2.0-ci-build - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base-r5/ and changes regularly. See the Directory of published versions

Resource Profile: Medication (EU core) [WIP]

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/medication-eu-core Version: 0.2.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: MedicationEuCore

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile sets minimum expectations for the Medication resource common to most of the use cases. This profile is adapted from the MPD work.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:device 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "device"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
...... extension:quantity 1..1 Extension Number of defined devices in te package
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "quantity"
..... url 1..1 uri "https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device"
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume Σ 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... Slices for extension Content/Rules for all slices
...... extension:device 1..1 Extension Extension
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.
.... item 1..1 CodeableReference(Substance | Medication (EU core) [WIP]) Substance (Substance resource or concept from terminology) or a medicinal product (Medication resource or concept from terminology). Medicinal product can be an ingredient in case of extemporal medications or combination packs (e.g Creme + 6 tablets)
Binding: Medicine Active Substances - IPS . (example)
Additional BindingsPurpose
eHDSI Substance . candidate
.... strength[x] 0..1 Ratio, CodeableConcept, Quantity Amount of substance in product (presentation or concentration strength)
..... Slices for extension Content/Rules for all slices
...... extension:basisOfStrengthSubstance 0..1 CodeableConcept Basis of strength substance - substance for which the strength is provided (this could be different from the precise active ingredient).
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-strengthsubstance
Binding: SNOMEDCTSubstanceCodes (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.
Medication.ingredient.​item Base example Medicine Active Substances - IPS . ⏿2.0.0-ballot tx.hl7europe.eu
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:device 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "device"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
...... extension:quantity 1..1 Extension Number of defined devices in te package
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "quantity"
....... value[x] 0..1 Quantity Value of extension
..... url 1..1 uri "https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device"
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume Σ 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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(Substance | Medication (EU core) [WIP]) Substance (Substance resource or concept from terminology) or a medicinal product (Medication resource or concept from terminology). Medicinal product can be an ingredient in case of extemporal medications or combination packs (e.g Creme + 6 tablets)
Binding: Medicine Active Substances - IPS . (example)
Additional BindingsPurpose
eHDSI Substance . candidate
.... isActive 0..1 boolean Active ingredient indicator
.... strength[x] 0..1 Amount of substance in product (presentation or concentration strength)
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
..... strength[x]All Types Content/Rules for all Types
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:basisOfStrengthSubstance 0..1 CodeableConcept Basis of strength substance - substance for which the strength is provided (this could be different from the precise active ingredient).
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-strengthsubstance
Binding: SNOMEDCTSubstanceCodes (example)
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base required All Languages 📍5.0.0 FHIR Std.
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.code Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.
Medication.ingredient.​item Base example Medicine Active Substances - IPS . ⏿2.0.0-ballot tx.hl7europe.eu
Medication.ingredient.​strength[x] Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:device 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "device"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
...... extension:quantity 1..1 Extension Number of defined devices in te package
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "quantity"
..... url 1..1 uri "https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device"
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume Σ 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... Slices for extension Content/Rules for all slices
...... extension:device 1..1 Extension Extension
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.
.... item 1..1 CodeableReference(Substance | Medication (EU core) [WIP]) Substance (Substance resource or concept from terminology) or a medicinal product (Medication resource or concept from terminology). Medicinal product can be an ingredient in case of extemporal medications or combination packs (e.g Creme + 6 tablets)
Binding: Medicine Active Substances - IPS . (example)
Additional BindingsPurpose
eHDSI Substance . candidate
.... strength[x] 0..1 Ratio, CodeableConcept, Quantity Amount of substance in product (presentation or concentration strength)
..... Slices for extension Content/Rules for all slices
...... extension:basisOfStrengthSubstance 0..1 CodeableConcept Basis of strength substance - substance for which the strength is provided (this could be different from the precise active ingredient).
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-strengthsubstance
Binding: SNOMEDCTSubstanceCodes (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.
Medication.ingredient.​item Base example Medicine Active Substances - IPS . ⏿2.0.0-ballot tx.hl7europe.eu

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Medication 0..* Medication Definition of a Medication
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productName 0..1 string Name of the medicinal product. Names of different types (full name, short name, etc) and in different languages can be provided if relevant.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-productname
.... extension:classification 0..* CodeableConcept Classifications of the product, e.g ATC, narcotic/psychotropic, orphan drug, etc
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-classification
Binding: ProductClassification (example)
.... extension:sizeOfItem 0..1 Quantity Size of one item (for example, in a pack of 5 vials, this would represent the size of 1 vial)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-sizeofitem
.... extension:characteristic 0..* (Complex) Specifies other descriptive properties of the medication.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-characteristic
.... extension:unitOfPresentation 0..1 CodeableConcept Unit of presentation of the product (e.g. tablet, vial, ampoule, etc)
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-unitofpresentation
Binding: UnitOfPresentation (example)
.... extension:packageType 0..1 CodeableConcept Type of container. This information is more relevant in cases when the packaging has an impact on administration of the product (e.g. pre-filled syringe)
URL: http://hl7.eu/fhir/StructureDefinition/medication-package-type
Binding: eHDSI Package . (example)
.... extension:device 0..* (Complex) Device, typically an administration device, included in the product.
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:device 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "device"
....... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Package . (example)
...... extension:quantity 1..1 Extension Number of defined devices in te package
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "quantity"
....... value[x] 0..1 Quantity Value of extension
..... url 1..1 uri "https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-device"
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: MedicationStatusCodes (required): A coded concept defining if the medication is in active use.
... marketingAuthorizationHolder Σ 0..1 Reference(Organization) Organization that has authorization to market medication
... doseForm 0..1 CodeableConcept Dose form. For a branded product, this would most likely be authorised dose form, but it could also be administrable dose form. For package items, it could be item's individual dose form.
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Additional BindingsPurpose
eHDSI Dose Form . candidate
... totalVolume Σ 0..1 Quantity Total volume or number of package items inside a package. This element should not contain overall prescribed amount, but describe the product itself. In case of complex packages, this element could be left empty, and number of different items could be indicated in the nested Medications.
... ingredient 0..* BackboneElement Active or inactive ingredient
.... 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(Substance | Medication (EU core) [WIP]) Substance (Substance resource or concept from terminology) or a medicinal product (Medication resource or concept from terminology). Medicinal product can be an ingredient in case of extemporal medications or combination packs (e.g Creme + 6 tablets)
Binding: Medicine Active Substances - IPS . (example)
Additional BindingsPurpose
eHDSI Substance . candidate
.... isActive 0..1 boolean Active ingredient indicator
.... strength[x] 0..1 Amount of substance in product (presentation or concentration strength)
Binding: MedicationIngredientStrengthCodes (preferred): A coded concpet defining the strength of an ingredient.
..... strength[x]All Types Content/Rules for all Types
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:basisOfStrengthSubstance 0..1 CodeableConcept Basis of strength substance - substance for which the strength is provided (this could be different from the precise active ingredient).
URL: https://profiles.ihe.net/PHARM/MPD/StructureDefinition/ihe-ext-medication-strengthsubstance
Binding: SNOMEDCTSubstanceCodes (example)
..... strengthRatio Ratio
..... strengthCodeableConcept CodeableConcept
..... strengthQuantity Quantity
... batch 0..1 BackboneElement Details about packaged medications
.... 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
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire
... definition 0..1 Reference(MedicationKnowledge) Knowledge about this medication

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base required All Languages 📍5.0.0 FHIR Std.
Medication.extension:device.​extension:device.value[x] Base example eHDSI Package . ⏿8.1.0 tx.hl7europe.eu
Medication.code Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
Medication.status Base required Medication Status Codes 📍5.0.0 FHIR Std.
Medication.doseForm Base example SNOMED CT Form Codes 📦5.0.0 FHIR Std.
Medication.ingredient.​item Base example Medicine Active Substances - IPS . ⏿2.0.0-ballot tx.hl7europe.eu
Medication.ingredient.​strength[x] Base preferred Medication Ingredient Strength Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron