This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Public Health and Emergency Response Work Group | Maturity Level: 1 | Trial Use | Compartments: Patient |
Detailed Descriptions for the elements in the ImmunizationRecommendation resource.
ImmunizationRecommendation | |
Element Id | ImmunizationRecommendation |
Definition | A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification. |
Control | 1..1 |
ImmunizationRecommendation.identifier | |
Element Id | ImmunizationRecommendation.identifier |
Definition | A unique identifier assigned to this particular recommendation record. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
ImmunizationRecommendation.patient | |
Element Id | ImmunizationRecommendation.patient |
Definition | The patient the recommendation(s) are for. |
Control | 1..1 |
Type | Reference(Patient) |
Summary | true |
ImmunizationRecommendation.date | |
Element Id | ImmunizationRecommendation.date |
Definition | The date the immunization recommendation(s) were created. |
Control | 1..1 |
Type | dateTime |
Summary | true |
ImmunizationRecommendation.authority | |
Element Id | ImmunizationRecommendation.authority |
Definition | Indicates the authority who published the protocol (e.g. ACIP). |
Control | 0..1 |
Type | Reference(Organization) |
ImmunizationRecommendation.recommendation | |
Element Id | ImmunizationRecommendation.recommendation |
Definition | Vaccine administration recommendations. |
Control | 1..* |
Summary | true |
Invariants | Defined on this element imr-1: One of vaccineCode or targetDisease SHALL be present (expression : vaccineCode.exists() or targetDisease.exists(), xpath: exists(f:vaccineCode) or exists(f:targetDisease)) |
ImmunizationRecommendation.recommendation.vaccineCode | |
Element Id | ImmunizationRecommendation.recommendation.vaccineCode |
Definition | Vaccine(s) or vaccine group that pertain to the recommendation. |
Control | 0..* |
Terminology Binding | Vaccine Administered Value Set (Example) |
Type | CodeableConcept |
Summary | true |
ImmunizationRecommendation.recommendation.targetDisease | |
Element Id | ImmunizationRecommendation.recommendation.targetDisease |
Definition | The targeted disease for the recommendation. |
Control | 0..1 |
Terminology Binding | Immunization Recommendation Target Disease Codes (Example) |
Type | CodeableConcept |
Summary | true |
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | |
Element Id | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode |
Definition | Vaccine(s) which should not be used to fulfill the recommendation. |
Control | 0..* |
Terminology Binding | Vaccine Administered Value Set (Example) |
Type | CodeableConcept |
Summary | true |
ImmunizationRecommendation.recommendation.forecastStatus | |
Element Id | ImmunizationRecommendation.recommendation.forecastStatus |
Definition | Indicates the patient status with respect to the path to immunity for the target disease. |
Control | 1..1 |
Terminology Binding | Immunization Recommendation Status Codes (Example) |
Type | CodeableConcept |
Is Modifier | true (Reason: This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc) or not (contraindicated, complete, etc).) |
Summary | true |
ImmunizationRecommendation.recommendation.forecastReason | |
Element Id | ImmunizationRecommendation.recommendation.forecastReason |
Definition | The reason for the assigned forecast status. |
Control | 0..* |
Terminology Binding | Immunization Recommendation Reason Codes (Example) |
Type | CodeableConcept |
Summary | true |
ImmunizationRecommendation.recommendation.dateCriterion | |
Element Id | ImmunizationRecommendation.recommendation.dateCriterion |
Definition | Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc. |
Control | 0..* |
ImmunizationRecommendation.recommendation.dateCriterion.code | |
Element Id | ImmunizationRecommendation.recommendation.dateCriterion.code |
Definition | Date classification of recommendation. For example, earliest date to give, latest date to give, etc. |
Control | 1..1 |
Terminology Binding | Immunization Recommendation Date Criterion Codes (Example) |
Type | CodeableConcept |
ImmunizationRecommendation.recommendation.dateCriterion.value | |
Element Id | ImmunizationRecommendation.recommendation.dateCriterion.value |
Definition | The date whose meaning is specified by dateCriterion.code. |
Control | 1..1 |
Type | dateTime |
ImmunizationRecommendation.recommendation.description | |
Element Id | ImmunizationRecommendation.recommendation.description |
Definition | Contains the description about the protocol under which the vaccine was administered. |
Control | 0..1 |
Type | string |
ImmunizationRecommendation.recommendation.series | |
Element Id | ImmunizationRecommendation.recommendation.series |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Control | 0..1 |
Type | string |
ImmunizationRecommendation.recommendation.doseNumber[x] | |
Element Id | ImmunizationRecommendation.recommendation.doseNumber[x] |
Definition | Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose). |
Control | 0..1 |
Type | positiveInt|string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
ImmunizationRecommendation.recommendation.seriesDoses[x] | |
Element Id | ImmunizationRecommendation.recommendation.seriesDoses[x] |
Definition | The recommended number of doses to achieve immunity. |
Control | 0..1 |
Type | positiveInt|string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | The use of an integer is prefered if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose). |
ImmunizationRecommendation.recommendation.supportingImmunization | |
Element Id | ImmunizationRecommendation.recommendation.supportingImmunization |
Definition | Immunization event history and/or evaluation that supports the status and recommendation. |
Control | 0..* |
Type | Reference(Immunization | ImmunizationEvaluation) |
ImmunizationRecommendation.recommendation.supportingPatientInformation | |
Element Id | ImmunizationRecommendation.recommendation.supportingPatientInformation |
Definition | Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information. |
Control | 0..* |
Type | Reference(Any) |