CH VACD (R4)
1.0.0 - STU 2 Ballot
CH VACD (R4)
1.0.0 - STU 2 Ballot
This page is part of the CH VACD (R4) (v1.0.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medication-for-immunization |
| Version: | 1.0.0 |
| Name: | CHVACDMedicationForImmunization |
| Title: | CH VACD Medication For Immunization Profile |
| Status: | Draft as of 2021-06-18T09:34:15+02:00 |
| Definition: | Definition of the medication for immunization. |
| Publisher: | eHealth Suisse |
| Copyright: | CC-BY-SA-4.0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-medication-for-immunization
The current FHIR Resource Immunization does not have a complete set of attributes to identify the Medication of the immunization administration.
From different sides this topic was announced to the HL7 WG public health to change the resource.
In the meantime there is the proposal to reference the Medication via an Immunization Resource extension as defined.
Please add your feedback via the 'Propose a change'-link in the footer of the page.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | 0..* | Medication | CH VACD Medication | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | CH VACD Medication | |
  id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | 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: 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 | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
| amount | Σ | 0..1 | Ratio | Amount of drug in package |
 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[x] | 1..1 | The actual ingredient or content | ||
| itemCodeableConcept | CodeableConcept | |||
 itemReference | Reference(Substance | Medication) | |||
| isActive | 0..1 | boolean | Active ingredient indicator | |
| strength | 0..1 | Ratio | Quantity of ingredient 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 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | CH VACD Medication | |
| Documentation for this format | ||||
This structure is derived from Medication
Differential View
This structure is derived from Medication
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | CH VACD Medication | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | Medication | CH VACD Medication | |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | 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: 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 | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |
| amount | Σ | 0..1 | Ratio | Amount of drug in package |
| 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[x] | 1..1 | The actual ingredient or content | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Substance | Medication) | |||
| isActive | 0..1 | boolean | Active ingredient indicator | |
| strength | 0..1 | Ratio | Quantity of ingredient 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 | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Medication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Medication.code | example | SNOMEDCTMedicationCodes |
| Medication.status | required | Medication Status Codes |
| Medication.form | example | SNOMEDCTFormCodes |
| Id | Path | Details | Requirements |
| dom-2 | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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().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-4 | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Medication.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.form | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.ingredient.item[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.isActive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.ingredient.strength | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.batch.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.batch.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Medication.batch.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Medication.batch.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Medication.batch.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |