Implementation Guide CH VACD
6.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 6.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 Immunization

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization Version: 6.0.0-ci-build
Active as of 2025-09-24 Computable Name: CHVACDImmunization

Copyright/Legal: CC0-1.0

Definition of the immunization part for all documents.

Validation and VerificationStatus

An Immunization entry can be recorded by an Practitioner or a Patient (Extension: Author of the content).

a) In the case a practitioner is recorder, the entry is directly validated defining the verificationStatus (extension) to Comfirmed

b) In the case a patient is recording an entry the verificationStatus (extension) has to be Not confirmed, a practitioner has to validate the entry.

see more about the Validation and VerificationStatus

Duplicate Conflict

By aggregation of different Immunization Administration documents, duplicates could be detected. If so, the entries in the Vaccination Record document (as result of the aggregation) should be completed with the extension CH VACD Extension Merging Conflict Entry Reference. The criterias of duplicate detection can be found here.

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..* CHCoreImmunization CH VACD Immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..1 Resource Immunization inline resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder S 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
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD Swissmedic code for VaccineCode (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunglobuline Codes candidate
For when Swissmedic Immunglobuline code system is preferred
... patient Σ 1..1 Reference(CH Core Patient) Patient
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
... lotNumber S 0..1 string Vaccine lot number
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route S 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... performer Σ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... reasonCode S 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site|4.0.1
From the FHIR Standard
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA 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()

This structure is derived from CHCoreImmunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* CHCoreImmunization CH VACD Immunization
... contained 0..1 Resource Immunization inline resource
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:recorder S 0..1 Author Optional Extensions Element
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
... lotNumber S 0..1 string Vaccine lot number
... site S 0..1 CodeableConcept Body site vaccine was administered
... route S 0..1 CodeableConcept How vaccine entered body.
... performer
.... actor S 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... reasonCode S 0..* CodeableConcept Why immunization occurred
... protocolApplied
.... Slices for doseNumber[x] 1..1 positiveInt, string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* CHCoreImmunization CH VACD 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..1 Resource Immunization inline resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder S 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
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 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 SΣ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD Swissmedic code for VaccineCode (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunglobuline Codes candidate
For when Swissmedic Immunglobuline code system is preferred
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
..... value 0..1 dateTime Primitive value for dateTime
... 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 S 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route S 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 SΣ 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... note Σ 0..* Annotation Additional immunization notes
... reasonCode S 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.
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1
From the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin|4.0.1
From the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site|4.0.1
From the FHIR Standard
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function|4.0.1
From the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|4.0.1
From the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility|4.0.1
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source|4.0.1
From the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredChVacdTargetDiseasesAndIllnessesUndergoneForImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA 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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from CHCoreImmunization

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* CHCoreImmunization CH VACD Immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..1 Resource Immunization inline resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder S 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
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD Swissmedic code for VaccineCode (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunglobuline Codes candidate
For when Swissmedic Immunglobuline code system is preferred
... patient Σ 1..1 Reference(CH Core Patient) Patient
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
... lotNumber S 0..1 string Vaccine lot number
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route S 0..1 CodeableConcept How vaccine entered body.
Binding: CH VACD Route of Administration for Immunization (preferred)
... performer Σ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... reasonCode S 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site|4.0.1
From the FHIR Standard
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA 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()

Differential View

This structure is derived from CHCoreImmunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* CHCoreImmunization CH VACD Immunization
... contained 0..1 Resource Immunization inline resource
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:recorder S 0..1 Author Optional Extensions Element
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
... lotNumber S 0..1 string Vaccine lot number
... site S 0..1 CodeableConcept Body site vaccine was administered
... route S 0..1 CodeableConcept How vaccine entered body.
... performer
.... actor S 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... reasonCode S 0..* CodeableConcept Why immunization occurred
... protocolApplied
.... Slices for doseNumber[x] 1..1 positiveInt, string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* CHCoreImmunization CH VACD 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..1 Resource Immunization inline resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:recorder S 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
.... extension:relatesTo 0..1 (Complex) Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
.... extension:medication 0..1 Reference(CH VACD Medication For Immunization) Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
.... extension:conflict 0..* (Complex) Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
.... extension:verificationStatus 1..1 Coding Verification Status
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-verification-status
Binding: Verification Status Codes (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 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 SΣ 1..1 CodeableConcept Vaccine product administered
Binding: CH VACD Swissmedic code for VaccineCode (preferred)
Additional BindingsPurposeDocumentation
CH VACD Snomed CT for VaccineCode candidate
For when SNOMED CT code system is preferred
CH VACD Swissmedic Authorized Immunglobuline Codes candidate
For when Swissmedic Immunglobuline code system is preferred
... patient Σ 1..1 Reference(CH Core Patient) Patient
... encounter 0..1 Reference(CH Core Encounter) Encounter
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
..... value 0..1 dateTime Primitive value for dateTime
... 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 S 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route S 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 SΣ 1..1 Reference(CH Core PractitionerRole) The performer who applied the vaccine
... note Σ 0..* Annotation Additional immunization notes
... reasonCode S 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.
.... Slices for doseNumber[x] 1..1 Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
..... doseNumber[x]:doseNumberPositiveInt S 0..1 positiveInt Dose number within series
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1
From the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin|4.0.1
From the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site|4.0.1
From the FHIR Standard
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function|4.0.1
From the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|4.0.1
From the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility|4.0.1
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source|4.0.1
From the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredChVacdTargetDiseasesAndIllnessesUndergoneForImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA 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()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from CHCoreImmunization

Summary

Mandatory: 2 elements
Must-Support: 11 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

 

Other representations of profile: CSV, Excel, Schematron