Implementation Guide CH VACD
4.0.0 - 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 4.0.0 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 Recommendations

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization-recommendation Version: 4.0.0
Active as of 2023-11-29 Computable Name: CHVACDImmunizationRecommendation

Copyright/Legal: CC0-1.0

Definition of the immunization recommendation part for all documents, except recommendation request and response documents.

Usage:

Formal Views of Profile Content

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

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... patient 1..1Reference(CH Core Patient)Patient
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation
.... vaccineCode 0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.

.... targetDisease S1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... forecastReason S1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.

.... dateCriterion S1..*BackboneElementDates governing proposed immunization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease SΣ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason SΣ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.


.... dateCriterion S1..*BackboneElementDates governing proposed immunization
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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..1dateTimeRecommended date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease SΣ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason SΣ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.


.... dateCriterion S1..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... patient 1..1Reference(CH Core Patient)Patient
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation
.... vaccineCode 0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.

.... targetDisease S1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... forecastReason S1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.

.... dateCriterion S1..*BackboneElementDates governing proposed immunization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease SΣ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason SΣ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.


.... dateCriterion S1..*BackboneElementDates governing proposed immunization
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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..1dateTimeRecommended date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationCH VACD Immunization Recommendation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... relatesTo 0..1(Complex)Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization)Who is responsible for protocol
... recommendation ΣC1..*BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease SΣ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason SΣ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done.


.... dateCriterion S1..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaseextensibleTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonextensibleEmpfehlungskategorien
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

 

Other representations of profile: CSV, Excel, Schematron