HL7 Europe Patient Summary, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/eps/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/eps/StructureDefinition/immunizationRecommendation-eu-eps | Version: 0.0.1-ci | |||
Draft as of 2025-06-20 | Computable Name: ImmunizationRecommendationEuEps | |||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
This profile defines how to represent Immunization Recommandations for the purpose of the European patient summary.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (EU core)) | Who this profile is for | ||||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | When recomendation was created | ||||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) Constraints: imr-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | |
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr | |
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status From the FHIR Standard | |
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard | |
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code | example | Pattern Value: LOINC Code 30980-7http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
ImmunizationRecommendation | |||||||||
![]() ![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who this profile is for | |||||||
![]() ![]() ![]() |
1..1 | dateTime | When recomendation was created | |||||||
![]() ![]() ![]() |
1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) | |||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| |||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Recommendation status | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of date Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Dose Number | |||||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() |
Path | Conformance | ValueSet | URI |
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | |
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (EU core)) | Who this profile is for | ||||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | When recomendation was created | ||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) Constraints: imr-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Protocol details | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
ImmunizationRecommendation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | ||||
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr | ||||
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reason From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code | example | Pattern Value: LOINC Code 30980-7http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard |
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
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (EU core)) | Who this profile is for | ||||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | When recomendation was created | ||||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) Constraints: imr-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | |
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr | |
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status From the FHIR Standard | |
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard | |
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code | example | Pattern Value: LOINC Code 30980-7http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard |
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() |
Differential View
This structure is derived from ImmunizationRecommendation
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
ImmunizationRecommendation | |||||||||
![]() ![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who this profile is for | |||||||
![]() ![]() ![]() |
1..1 | dateTime | When recomendation was created | |||||||
![]() ![]() ![]() |
1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) | |||||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| |||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | |||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Recommendation status | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of date Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Dose Number | |||||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() |
Path | Conformance | ValueSet | URI |
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | |
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() ![]() |
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 | |||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient (EU core)) | Who this profile is for | ||||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | When recomendation was created | ||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Generic description of the vaccine/prophylaxis or its component(s) Constraints: imr-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by value:code | |||||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Protocol details | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
ImmunizationRecommendation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
ImmunizationRecommendation.recommendation.vaccineCode | preferred | VaccinesUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips | ||||
ImmunizationRecommendation.recommendation.targetDisease | preferred | ConditionHdrVShttp://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr | ||||
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reason From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard | ||||
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code | example | Pattern Value: LOINC Code 30980-7http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion From the FHIR Standard |
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
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron