Implementation Guide CH VACD
2.1.0 - STU 3 Ballot
Implementation Guide CH VACD
2.1.0 - STU 3 Ballot
This page is part of the CH VACD (R4) (v2.1.0: STU 3 Ballot) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.0.0. 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: 2.1.0 | |||
| Active as of 2022-07-07 | Computable Name: CHVACDImmunizationRecommendation | |||
Copyright/Legal: CC-BY-SA-4.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
Summary
Mandatory: 4 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from ImmunizationRecommendation
| 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): 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 | |||||
 ch-vacd-ext-cross-reference | S | 0..1 | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference | ||||
 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 | ΣI | 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | CH VACD Immunization Recommendation | |
| ch-vacd-ext-cross-reference | 0..1 | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference | |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| targetDisease | Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease. |
| forecastReason | Σ | 1..* | CodeableConcept | Vaccine administration status reason Binding: Recommendation-Categories for Immunizations (extensible): The reason the forecast is done. |
| dateCriterion | 1..* | BackboneElement | Dates governing proposed immunization | |
| Documentation for this format | ||||
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
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): 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 | |||||
| ch-vacd-ext-cross-reference | S | 0..1 | (Complex) | Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference | ||||
| 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 | ΣI | 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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| 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 | 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 | ImmunizationRecommendation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.extension:relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.extension:relatesTo | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() | |
| ele-1 | error | ImmunizationRecommendation.recommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.recommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.recommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.recommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.recommendation.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.forecastStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.forecastReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.supportingImmunization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | ImmunizationRecommendation.recommendation.supportingPatientInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
