Implementation Guide CH VACD
4.0.1 - trial-use
This page is part of the CH VACD (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization-recommendation | Version: 4.0.1 | |||
Active as of 2023-12-28 | Computable Name: CHVACDImmunizationRecommendation | |||
Copyright/Legal: CC0-1.0 |
Definition of the immunization recommendation part for all documents, except recommendation request and response documents.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationRecommendation
Path | Conformance | ValueSet |
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations |
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization |
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
Slices for extension | 0..* | Extension | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID |
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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccineCode | Σ | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. |
targetDisease | SΣ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease. |
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
forecastReason | SΣ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done. |
dateCriterion | S | 1..* | BackboneElement | Dates governing proposed immunization |
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 | |
Documentation for this format |
Path | Conformance | ValueSet |
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations |
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization |
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes |
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien |
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |||||
Slices for extension | 0..* | Extension | Extension 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..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID | ||||
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 | ||||
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: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. | ||||
targetDisease | SΣ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (extensible): 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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
forecastReason | SΣ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done. | ||||
dateCriterion | S | 1..* | 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ImmunizationRecommendation.language | preferred | CommonLanguages
| ||||
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations | ||||
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization | ||||
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSet | ||||
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes | ||||
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien | ||||
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodes |
Id | Grade | Path(s) | Details | Requirements |
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
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ImmunizationRecommendation
Path | Conformance | ValueSet |
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations |
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization |
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
Slices for extension | 0..* | Extension | Extension 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..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID |
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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
vaccineCode | Σ | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. |
targetDisease | SΣ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease. |
forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
forecastReason | SΣ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done. |
dateCriterion | S | 1..* | BackboneElement | Dates governing proposed immunization |
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 | |
Documentation for this format |
Path | Conformance | ValueSet |
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations |
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization |
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes |
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien |
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodes |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |||||
Slices for extension | 0..* | Extension | Extension 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..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID | ||||
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 | ||||
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: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. | ||||
targetDisease | SΣ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (extensible): 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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
forecastReason | SΣ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done. | ||||
dateCriterion | S | 1..* | 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
ImmunizationRecommendation.language | preferred | CommonLanguages
| ||||
ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations | ||||
ImmunizationRecommendation.recommendation.targetDisease | extensible | TargetDiseasesAndIllnessesUndergoneForImmunization | ||||
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSet | ||||
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes | ||||
ImmunizationRecommendation.recommendation.forecastReason | extensible | Empfehlungskategorien | ||||
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodes |
Id | Grade | Path(s) | Details | Requirements |
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
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron