Implementation Guide CH VACD
4.0.1 - trial-use Switzerland flag

This page is part of the CH VACD (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, 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: 4.0.1
Draft as of 2023-12-28 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*CHEMEDMedicationCH VACD Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierObservation item ID
.... Slices for coding Σ0..*CodingCode of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ0..*CodingUse GTIN for Swiss products
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code Σ1..1codeSymbol in syntax defined by the system
..... coding:ATC Σ0..*CodingUse ATC for foreign products
...... system Σ1..1uriAnatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... code Σ1..1codeSymbol in syntax defined by the system
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding SΣ1..*CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
..... code Σ1..1codeSymbol in syntax defined by the system
... ingredient 0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptThe actual ingredient or content
...... text SΣ1..1stringIngredient name
.... strength SC0..1CHEMEDRatioWithEmedUnitsDose per unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formrequiredPharmaceuticalDoseFormEDQM

Constraints

IdGradePath(s)DetailsRequirements
ch-emed-med-1errorMedicationMedication or ingredient name has to be specified
: code.text.exists() or ingredient.item.text.exists()
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.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 C0..*CHEMEDMedicationCH VACD Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierObservation item ID
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ0..*CodingUse GTIN for Swiss products
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:ATC Σ0..*CodingUse ATC for foreign products
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriAnatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... amount C0..1CHEMEDRatioWithEmedUnitsPackage size
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptThe actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ1..1stringIngredient name
.... isActive 0..1booleanActive ingredient indicator
.... strength SC0..1CHEMEDRatioWithEmedUnitsDose per unit
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formrequiredPharmaceuticalDoseFormEDQM
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
ch-emed-med-1errorMedicationMedication or ingredient name has to be specified
: code.text.exists() or ingredient.item.text.exists()
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 CHEMEDMedication

Summary

Mandatory: 1 element

Differential View

This structure is derived from CHEMEDMedication

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication C0..*CHEMEDMedicationCH VACD Medication
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierObservation item ID
.... Slices for coding Σ0..*CodingCode of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ0..*CodingUse GTIN for Swiss products
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... code Σ1..1codeSymbol in syntax defined by the system
..... coding:ATC Σ0..*CodingUse ATC for foreign products
...... system Σ1..1uriAnatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... code Σ1..1codeSymbol in syntax defined by the system
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... coding SΣ1..*CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
..... code Σ1..1codeSymbol in syntax defined by the system
... ingredient 0..*BackboneElementActive or inactive ingredient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptThe actual ingredient or content
...... text SΣ1..1stringIngredient name
.... strength SC0..1CHEMEDRatioWithEmedUnitsDose per unit

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formrequiredPharmaceuticalDoseFormEDQM

Constraints

IdGradePath(s)DetailsRequirements
ch-emed-med-1errorMedicationMedication or ingredient name has to be specified
: code.text.exists() or ingredient.item.text.exists()
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.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 C0..*CHEMEDMedicationCH VACD Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierObservation item ID
... code Σ0..1CodeableConceptCodes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode of the medication
Slice: Unordered, Open by value:system
..... coding:GTIN SΣ0..*CodingUse GTIN for Swiss products
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriGlobal Trade Item Number (GS1)
Fixed Value: urn:oid:2.51.1.1
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:ATC Σ0..*CodingUse ATC for foreign products
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriAnatomical Therapeutic Chemical (ATC) Classification
Fixed Value: http://www.whocc.no/atc
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringMedication name
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form 0..1CodeableConceptGalenic form
Binding: EDQM - Pharmaceutical Dose Form (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... amount C0..1CHEMEDRatioWithEmedUnitsPackage size
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for item[x] 1..1The actual ingredient or content
Slice: Unordered, Open by type:$this
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance | Medication)
..... item[x]:itemCodeableConcept 0..1CodeableConceptThe actual ingredient or content
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingIngredients coded with SNOMED CT
Binding: ActivePharmaceuticalIngredient (extensible)
...... text SΣ1..1stringIngredient name
.... isActive 0..1booleanActive ingredient indicator
.... strength SC0..1CHEMEDRatioWithEmedUnitsDose per unit
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Medication.codeexampleSNOMEDCTMedicationCodes
Medication.statusrequiredMedication Status Codes
Medication.formrequiredPharmaceuticalDoseFormEDQM
Medication.ingredient.item[x]:itemCodeableConcept.codingextensibleActivePharmaceuticalIngredient

Constraints

IdGradePath(s)DetailsRequirements
ch-emed-med-1errorMedicationMedication or ingredient name has to be specified
: code.text.exists() or ingredient.item.text.exists()
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 CHEMEDMedication

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron