CH Core (R4)
5.0.0-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 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-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: 5.0.0-ci-build
Active as of 2024-05-17 Computable Name: CHCoreImmunization

Copyright/Legal: CC0-1.0

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization CH Core Immunization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
... 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)

PathConformanceValueSetURI
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.protocolApplied.targetDiseasepreferredChVacdTargetDiseasesAndIllnessesUndergoneForImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines Σ 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines Σ 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
... 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

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.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines Σ 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines Σ 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
.... text Σ 0..1 string Plain text representation of the concept
... 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 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
imm-1: One of documentType or reference SHALL be present
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
from the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
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
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
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()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization CH Core Immunization
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
... 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)

PathConformanceValueSetURI
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.protocolApplied.targetDiseasepreferredChVacdTargetDiseasesAndIllnessesUndergoneForImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines Σ 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines Σ 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
... 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

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.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.routepreferredRouteOfAdministrationImmunization
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... recorder 0..1 Reference(CH Core Patient | CH Core PractitionerRole | 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 Swissmedic code for vaccine code (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:swissVaccines Σ 0..1 Coding Swiss Vaccine Code
Binding: CH VACD Swissmedic code for vaccine code (required)
..... coding:snomedctVaccines Σ 0..1 Coding Vaccine Code by SNOMED CT
Binding: CH VACD Snomed CT for vaccine code (required)
.... text Σ 0..1 string Plain text representation of the concept
... 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 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
imm-1: One of documentType or reference SHALL be present
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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
from the FHIR Standard
Immunization.vaccineCodepreferredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccinesrequiredSwissVaccines
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccinesrequiredSnomedCTForVaccineCode
http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
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
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
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()

 

Other representations of profile: CSV, Excel, Schematron