Implementation Guide CH VACD
5.0.0-ci-build - ci-build Switzerland flag

Implementation Guide CH VACD, published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-vacd/ and changes regularly. See the Directory of published versions

Resource Profile: CH VACD Medication For Immunization

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medication-for-immunization Version: 5.0.0-ci-build
Draft as of 2024-05-23 Computable Name: CHVACDMedicationForImmunization

Copyright/Legal: CC0-1.0

Definition of the medication for immunization.

Usage:

Formal Views of Profile Content

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

This structure is derived from CHCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD Medication
... identifier 1..* Identifier Observation item ID
... code
.... coding 0..* Coding Code of the medication
.... Slices for coding Content/Rules for all slices
..... coding:GTIN S 0..* Coding GTIN for Swiss products
.... text S 1..1 string Medication name
... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding S 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... ingredient
.... Slices for item[x] 1..1 CodeableConcept, Reference(Substance | CH Core Medication) The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
...... coding 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text S 1..1 string Ingredient name
.... strength S 0..1 CHCoreRatioWithEmedUnits Dose per unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Observation item ID
.... Slices for coding Σ 0..* Coding Code of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ 0..* Coding GTIN for Swiss products
...... system Σ 1..1 uri Global Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:ATC Σ 0..* Coding ATC for foreign products
...... system Σ 1..1 uri Anatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text SΣ 1..1 string Medication name
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... amount C 0..1 CHCoreRatioWithEmedUnits Package size
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 0..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1 The actual ingredient or content
Slice: Unordered, Open by type:$this
Binding: ActivePharmaceuticalIngredient (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | CH Core Medication)
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
Binding: ActivePharmaceuticalIngredient (preferred)
...... coding Σ 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ 1..1 string Ingredient name
.... strength SC 0..1 CHCoreRatioWithEmedUnits Dose per unit
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]preferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConceptpreferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Observation item ID
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ 0..* Coding GTIN for Swiss products
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Global Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ATC Σ 0..* Coding ATC for foreign products
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Anatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 1..1 string Medication name
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string 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
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... 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
... amount C 0..1 CHCoreRatioWithEmedUnits Package size
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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
.... Slices for item[x] 1..1 The actual ingredient or content
Slice: Unordered, Open by type:$this
Binding: ActivePharmaceuticalIngredient (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | CH Core Medication)
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
Binding: ActivePharmaceuticalIngredient (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ 1..1 string Ingredient name
.... isActive 0..1 boolean Active ingredient indicator
.... strength SC 0..1 CHCoreRatioWithEmedUnits Dose per unit
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]preferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConceptpreferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

This structure is derived from CHCoreMedication

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.item[x]

Differential View

This structure is derived from CHCoreMedication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD Medication
... identifier 1..* Identifier Observation item ID
... code
.... coding 0..* Coding Code of the medication
.... Slices for coding Content/Rules for all slices
..... coding:GTIN S 0..* Coding GTIN for Swiss products
.... text S 1..1 string Medication name
... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding S 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... ingredient
.... Slices for item[x] 1..1 CodeableConcept, Reference(Substance | CH Core Medication) The actual ingredient or content
Slice: Unordered, Open by type:$this
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
...... coding 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text S 1..1 string Ingredient name
.... strength S 0..1 CHCoreRatioWithEmedUnits Dose per unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD Medication
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Observation item ID
.... Slices for coding Σ 0..* Coding Code of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ 0..* Coding GTIN for Swiss products
...... system Σ 1..1 uri Global Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:ATC Σ 0..* Coding ATC for foreign products
...... system Σ 1..1 uri Anatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... code Σ 1..1 code Symbol in syntax defined by the system
.... text SΣ 1..1 string Medication name
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... amount C 0..1 CHCoreRatioWithEmedUnits Package size
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... ingredient 0..* BackboneElement Active or inactive ingredient
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1 The actual ingredient or content
Slice: Unordered, Open by type:$this
Binding: ActivePharmaceuticalIngredient (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | CH Core Medication)
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
Binding: ActivePharmaceuticalIngredient (preferred)
...... coding Σ 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ 1..1 string Ingredient name
.... strength SC 0..1 CHCoreRatioWithEmedUnits Dose per unit
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]preferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConceptpreferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* CHCoreMedication CH VACD 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier Observation item ID
... code Σ 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ 0..* Coding GTIN for Swiss products
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Global Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ATC Σ 0..* Coding ATC for foreign products
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Anatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 1..1 string Medication name
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
... form 0..1 CodeableConcept Galenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string 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
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... 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
... amount C 0..1 CHCoreRatioWithEmedUnits Package size
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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
.... Slices for item[x] 1..1 The actual ingredient or content
Slice: Unordered, Open by type:$this
Binding: ActivePharmaceuticalIngredient (preferred)
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | CH Core Medication)
..... item[x]:itemCodeableConcept 0..1 CodeableConcept The actual ingredient or content
Binding: ActivePharmaceuticalIngredient (preferred)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Ingredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ 1..1 string Ingredient name
.... isActive 0..1 boolean Active ingredient indicator
.... strength SC 0..1 CHCoreRatioWithEmedUnits Dose per unit
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formrequiredPharmaceuticalDoseFormEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform
Medication.ingredient.item[x]preferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConceptpreferredActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient
http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA 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()
rat-1errorMedication.amount, Medication.ingredient.strengthNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

This structure is derived from CHCoreMedication

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Medication.ingredient.item[x]

 

Other representations of profile: CSV, Excel, Schematron