Release 5 Ballot
MedicationsThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 | Security Category: Patient | 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. | ||||||||
| Short Display | Guidance or advice relating to an immunization | ||||||||
| Cardinality | 0..* | ||||||||
| Type | DomainResource | ||||||||
| Summary | false | ||||||||
| ImmunizationRecommendation.identifier | |||||||||
| Element Id | ImmunizationRecommendation.identifier | ||||||||
| Definition | A unique identifier assigned to this particular recommendation record. | ||||||||
| Short Display | Business identifier | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Identifier | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.patient | |||||||||
| Element Id | ImmunizationRecommendation.patient | ||||||||
| Definition | The patient the recommendation(s) are for. | ||||||||
| Short Display | Who this profile is for | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Reference(Patient) | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.date | |||||||||
| Element Id | ImmunizationRecommendation.date | ||||||||
| Definition | The date the immunization recommendation(s) were created. | ||||||||
| Short Display | Date recommendation(s) created | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.authority | |||||||||
| Element Id | ImmunizationRecommendation.authority | ||||||||
| Definition | Indicates the authority who published the protocol (e.g. ACIP). | ||||||||
| Short Display | Who is responsible for protocol | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | Reference(Organization) | ||||||||
| Summary | false | ||||||||
| ImmunizationRecommendation.recommendation | |||||||||
| Element Id | ImmunizationRecommendation.recommendation | ||||||||
| Definition | Vaccine administration recommendations. | ||||||||
| Short Display | Vaccine administration recommendations | ||||||||
| Cardinality | 1..* | ||||||||
| Summary | true | ||||||||
| Comments | A given instance of the .recommendation backbone element should correspond to a single recommended administration. | ||||||||
| Invariants |
| ||||||||
| ImmunizationRecommendation.recommendation.vaccineCode | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.vaccineCode | ||||||||
| Definition | Vaccine(s) or vaccine group that pertain to the recommendation. | ||||||||
| Short Display | Vaccine or vaccine group recommendation applies to | ||||||||
| Cardinality | 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. | ||||||||
| Short Display | Disease to be immunized against | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | Immunization Target Disease Codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments | A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (eg. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat. | ||||||||
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | ||||||||
| Definition | Vaccine(s) which should not be used to fulfill the recommendation. | ||||||||
| Short Display | Vaccine which is contraindicated to fulfill the recommendation | ||||||||
| Cardinality | 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. | ||||||||
| Short Display | Vaccine recommendation status | ||||||||
| Cardinality | 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. | ||||||||
| Short Display | Vaccine administration status reason | ||||||||
| Cardinality | 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. | ||||||||
| Short Display | Dates governing proposed immunization | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| 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. | ||||||||
| Short Display | Type of date | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Immunization Recommendation Date Criterion Codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ImmunizationRecommendation.recommendation.dateCriterion.value | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.dateCriterion.value | ||||||||
| Definition | The date whose meaning is specified by dateCriterion.code. | ||||||||
| Short Display | Recommended date | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | false | ||||||||
| ImmunizationRecommendation.recommendation.description | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.description | ||||||||
| Definition | Contains the description about the protocol under which the vaccine was administered. | ||||||||
| Short Display | Protocol details | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| 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. | ||||||||
| Short Display | Name of vaccination series | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| ImmunizationRecommendation.recommendation.doseNumber | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.doseNumber | ||||||||
| Definition | Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose). | ||||||||
| Short Display | Recommended dose number within series | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). | ||||||||
| ImmunizationRecommendation.recommendation.seriesDoses | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.seriesDoses | ||||||||
| Definition | The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process. | ||||||||
| Short Display | Recommended number of doses for immunity | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| Comments | The use of an integer is preferred if known. | ||||||||
| ImmunizationRecommendation.recommendation.supportingImmunization | |||||||||
| Element Id | ImmunizationRecommendation.recommendation.supportingImmunization | ||||||||
| Definition | Immunization event history and/or evaluation that supports the status and recommendation. | ||||||||
| Short Display | Past immunizations supporting recommendation | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(Immunization | ImmunizationEvaluation) | ||||||||
| Summary | false | ||||||||
| 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. | ||||||||
| Short Display | Patient observations supporting recommendation | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(Any) | ||||||||
| Summary | false | ||||||||
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:04+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change