CH Core (R4)
7.0.0-ballot-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot-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-core/ and changes regularly. See the Directory of published versions

Resource Profile: CH Core Immunization

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-immunization Version: 7.0.0-ballot-ci-build
Active as of 2026-03-12 Computable Name: CHCoreImmunization

Copyright/Legal: CC0-1.0

Base definition of the Immunization resource for use in Swiss specific use cases.

Vaccine Code Bindings

Default

The CH VACD All Swiss Vaccine Codes is the default binding for Immunization.vaccineCode. The ValueSet contains the codes for from the CodeSystems CH VACD Swissmedic Authorized Vaccines and CH VACD Old Swiss Vaccines (Swiss Legacy).

Additional

As additional binding there are further ValueSets defined:

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
.. Immunization 0..* Immunization CH Core Immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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 Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization CH Core Immunization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient 1..1 Reference(CH Core Patient) Patient
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... performer
.... actor 1..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) The performer who applied the vaccine
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3
Immunization.protocolApplied.​targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0 CH Term v3.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization CH Core Immunization
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
.... actor Σ 1..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) The performer who applied the vaccine
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization CH Core Immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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 Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization CH Core Immunization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient 1..1 Reference(CH Core Patient) Patient
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... performer
.... actor 1..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) The performer who applied the vaccine
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3
Immunization.protocolApplied.​targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0 CH Term v3.3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization CH Core Immunization
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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:recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson) Optional Extensions Element
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD All Swiss Vaccine Codes (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunoglobulin Codes candidate
For when Swissmedic Immunoglobulin code system is preferred
ValueSet_NUVA_All . candidate
For usage of NUVA codes.
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... occurrence[x] Σ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
.... actor Σ 1..1 Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization) The performer who applied the vaccine
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred CH VACD All Swiss Vaccine Codes 📦3.3.0 CH Term v3.3
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base preferred CH VACD Route of Administration for Immunization 📦3.3.0 CH Term v3.3
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0 CH Term v3.3

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization 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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

 

Other representations of profile: CSV, Excel, Schematron