Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XIB ImmunizationRecommendation

Official URL: https://fhir.cumuluz.org/xib/StructureDefinition/xib-ImmunizationRecommendation Version: 0.1.0
Draft as of 2026-07-11 Computable Name: XibImmunizationRecommendation

Generic XIB immunization recommendation target for nl-core ImmunizationRecommendation profiles.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority S 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
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

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... patient S 1..1 Reference(Patient) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... recommendation S 1..* BackboneElement Vaccine administration recommendations

doco Documentatie voor dit formaat
NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority S 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
.... 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 Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... 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

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
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

Samenvatting

Moet-ondersteunen: 5 elements

Extensies

Deze structuur verwijst naar deze extensies:

Key Elements View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority S 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

Differential View

This structure is derived from ImmunizationRecommendation

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... patient S 1..1 Reference(Patient) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... recommendation S 1..* BackboneElement Vaccine administration recommendations

doco Documentatie voor dit formaat

Snapshot View

NaamMarkeringenKard.TypeOmschrijving & constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices voor extension 0..* Extension Extension
Slice: Zonder volgorde, Open op value:url
.... extension:orderStatus S 0..1 CodeableConcept XIB Vaccination Recommendation Order Status
Url: https://fhir.cumuluz.org/xib/StructureDefinition/xib-VaccinationRecommendationOrderStatus
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority S 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
.... 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 Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... 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

doco Documentatie voor dit formaat

Terminologiebindings

Pad Status Gebruik ValueSet Versie Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constrains

Id Grade Pad(en) Omschrijving Expressie
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

Samenvatting

Moet-ondersteunen: 5 elements

Extensies

Deze structuur verwijst naar deze extensies:

 

Other representations of profile: CSV, Excel, Schematron