CH VACD (R4)
1.0.0 - STU 2 Ballot
CH VACD (R4)
1.0.0 - STU 2 Ballot
This page is part of the CH VACD (R4) (v1.0.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization-recommendations |
| Version: | 1.0.0 |
| Name: | CHVACDRecommendationImmunizationRecommendations |
| Title: | CH VACD Recommendation Immunization Recommendations Profile |
| Status: | Draft as of 2021-06-18T09:34:15+02:00 |
| Definition: | Definition of the immunization recommendation part for immunization recommendation request and response documents. |
| Publisher: | eHealth Suisse |
| Copyright: | CC-BY-SA-4.0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization-recommendations
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationRecommendation
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
  contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 identifier | 1..* | Identifier | Immunization Recommendation item ID | |
 system | 0..1 | uri | The namespace for the identifier value | |
 value | 0..1 | string | The value that is unique | |
 patient | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient | |
 recommendation | ||||
 vaccineCode | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. | |
| targetDisease | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (required): The code for disease. | |
| forecastReason | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (required): The code for disease. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| patient | Σ | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease 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 |
| vaccineCode | Σ | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. |
| targetDisease | Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (required): 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 | Σ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (required): The code for disease. |
| 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
| Documentation for this format | ||||
This structure is derived from ImmunizationRecommendation
Differential View
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
| contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| identifier | 1..* | Identifier | Immunization Recommendation item ID | |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | 0..1 | string | The value that is unique | |
| patient | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient | |
| recommendation | ||||
| vaccineCode | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. | |
| targetDisease | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (required): The code for disease. | |
| forecastReason | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (required): The code for disease. | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..1 | Resource | ImmunizationRecommendation inline resource | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..* | Identifier | Immunization Recommendation item ID |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| patient | Σ | 1..1 | Reference(CH VACD Recommendation Patient Profile) | Patient |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease 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 |
| vaccineCode | Σ | 0..* | CodeableConcept | Immunization Recommendation Vaccine Code Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered. |
| targetDisease | Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (required): 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 | Σ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (required): The code for disease. |
| 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationRecommendation.identifier.use | required | IdentifierUse |
| ImmunizationRecommendation.identifier.type | extensible | Identifier Type Codes |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | SwissVaccinationPlanImmunizations |
| ImmunizationRecommendation.recommendation.targetDisease | required | TargetDiseasesAndIllnessesUndergoneForImmunization |
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSet |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes |
| ImmunizationRecommendation.recommendation.forecastReason | required | Empfehlungskategorien |
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodes |
| Id | Path | Details | Requirements |
| dom-2 | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | ImmunizationRecommendation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | ImmunizationRecommendation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| imr-1 | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.recommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.recommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.forecastStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.forecastReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.recommendation.dateCriterion.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.supportingImmunization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.supportingPatientInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |