CH Core (R4)
6.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 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-core/ and changes regularly. See the Directory of published versions

Resource Profile: CH Core Immunization Recommendation

Official URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-immunization-recommendation Version: 6.0.0-ci-build
Active as of 2025-10-18 Computable Name: CHCoreImmunizationRecommendation

Copyright/Legal: CC0-1.0

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

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
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(CH Core Patient) Patient
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3

Constraints

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

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... patient 1..1 Reference(CH Core Patient) Patient
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation
.... vaccineCode 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(CH Core Patient) Patient
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-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
.... vaccineCode Σ 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... dateCriterion 0..* BackboneElement Dates governing proposed 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
..... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
..... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(CH Core Patient) Patient
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3

Constraints

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

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... patient 1..1 Reference(CH Core Patient) Patient
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation
.... vaccineCode 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation CH Core Immunization Recommendation
... 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(CH Core Patient) Patient
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(CH Core Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-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
.... vaccineCode Σ 0..* CodeableConcept Immunization Recommendation Vaccine Code
Binding: CH VACD Swiss Vaccination Plan Immunizations (preferred): The code for vaccine product administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: CH VACD Swiss Recommendation Forecast Status (preferred): The reason the forecast is done.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: CH VACD Recommendation Categories for Immunizations (preferred): The reason the forecast is done.
.... dateCriterion 0..* BackboneElement Dates governing proposed 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
..... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
..... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(CH Core Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred CH VACD Swiss Vaccination Plan Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.targetDisease Base preferred CH VACD Target disease and illnesses undergone for immunization 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base preferred CH VACD Swiss Recommendation Forecast Status 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.forecastReason Base preferred CH VACD Recommendation Categories for Immunizations 📦3.3.0-ci-build CH Term v3.3
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron