Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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 icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Patient Compartments: Patient

Detailed Descriptions for the elements in the ImmunizationRecommendation resource.

ImmunizationRecommendation
Element IdImmunizationRecommendation
Definition

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Short DisplayGuidance or advice relating to an immunization
Cardinality0..*
TypeDomainResource
Summaryfalse
ImmunizationRecommendation.identifier
Element IdImmunizationRecommendation.identifier
Definition

A unique identifier assigned to this particular recommendation record.

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
ImmunizationRecommendation.patient
Element IdImmunizationRecommendation.patient
Definition

The patient the recommendation(s) are for.

Short DisplayWho this profile is for
Cardinality1..1
TypeReference(Patient)
Summarytrue
ImmunizationRecommendation.date
Element IdImmunizationRecommendation.date
Definition

The date the immunization recommendation(s) were created.

Short DisplayDate recommendation(s) created
Cardinality1..1
TypedateTime
Summarytrue
ImmunizationRecommendation.authority
Element IdImmunizationRecommendation.authority
Definition

Indicates the authority who published the protocol (e.g. ACIP).

Short DisplayWho is responsible for protocol
Cardinality0..1
TypeReference(Organization)
Summaryfalse
ImmunizationRecommendation.recommendation
Element IdImmunizationRecommendation.recommendation
Definition

Vaccine administration recommendations.

Short DisplayVaccine administration recommendations
Cardinality1..*
Summarytrue
Comments

A given instance of the .recommendation backbone element should correspond to a single recommended administration.

Invariants
Defined on this element
imr-1Rule One of vaccineCode or targetDisease SHALL be presentvaccineCode.exists() or targetDisease.exists()
ImmunizationRecommendation.recommendation.vaccineCode
Element IdImmunizationRecommendation.recommendation.vaccineCode
Definition

Vaccine(s) or vaccine group that pertain to the recommendation.

Short DisplayVaccine or vaccine group recommendation applies to
Cardinality0..*
Terminology BindingVaccine Administered Value Set (Example)
TypeCodeableConcept
Summarytrue
Invariants
Affect this element
imr-1Rule One of vaccineCode or targetDisease SHALL be presentvaccineCode.exists() or targetDisease.exists()
ImmunizationRecommendation.recommendation.targetDisease
Element IdImmunizationRecommendation.recommendation.targetDisease
Definition

The targeted disease for the recommendation.

Short DisplayDisease to be immunized against
Cardinality0..*
Terminology BindingImmunization Target Disease Codes (Example)
TypeCodeableConcept
Summarytrue
Comments

A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (e.g. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat.

Invariants
Affect this element
imr-1Rule One of vaccineCode or targetDisease SHALL be presentvaccineCode.exists() or targetDisease.exists()
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Element IdImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Definition

Vaccine(s) which should not be used to fulfill the recommendation.

Short DisplayVaccine which is contraindicated to fulfill the recommendation
Cardinality0..*
Terminology BindingVaccine Administered Value Set (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.forecastStatus
Element IdImmunizationRecommendation.recommendation.forecastStatus
Definition

Indicates the patient status with respect to the path to immunity for the target disease.

Short DisplayVaccine recommendation status
Cardinality1..1
Terminology BindingImmunization Recommendation Status Codes (Example)
TypeCodeableConcept
Is Modifiertrue (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.).)
Summarytrue
ImmunizationRecommendation.recommendation.forecastReason
Element IdImmunizationRecommendation.recommendation.forecastReason
Definition

The reason for the assigned forecast status.

Short DisplayVaccine administration status reason
Cardinality0..*
Terminology BindingImmunization Recommendation Reason Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.dateCriterion
Element IdImmunizationRecommendation.recommendation.dateCriterion
Definition

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

Short DisplayDates governing proposed immunization
Cardinality0..*
Summaryfalse
ImmunizationRecommendation.recommendation.dateCriterion.code
Element IdImmunizationRecommendation.recommendation.dateCriterion.code
Definition

Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

Short DisplayType of date
Cardinality1..1
Terminology BindingImmunization Recommendation Date Criterion Codes (Example)
TypeCodeableConcept
Summaryfalse
ImmunizationRecommendation.recommendation.dateCriterion.value
Element IdImmunizationRecommendation.recommendation.dateCriterion.value
Definition

The date whose meaning is specified by dateCriterion.code.

Short DisplayRecommended date
Cardinality1..1
TypedateTime
Summaryfalse
ImmunizationRecommendation.recommendation.description
Element IdImmunizationRecommendation.recommendation.description
Definition

Contains the description about the protocol under which the vaccine was administered.

Short DisplayProtocol details
Cardinality0..1
Typemarkdown
Summaryfalse
ImmunizationRecommendation.recommendation.series
Element IdImmunizationRecommendation.recommendation.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Short DisplayName of vaccination series
Cardinality0..1
Typestring
Summaryfalse
ImmunizationRecommendation.recommendation.doseNumber
Element IdImmunizationRecommendation.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 DisplayRecommended dose number within series
Cardinality0..1
Typestring
Summarytrue
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 IdImmunizationRecommendation.recommendation.seriesDoses
Definition

The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.

Short DisplayRecommended number of doses for immunity
Cardinality0..1
Typestring
Summaryfalse
Comments

The use of an integer is preferred if known.

ImmunizationRecommendation.recommendation.supportingImmunization
Element IdImmunizationRecommendation.recommendation.supportingImmunization
Definition

Immunization event history and/or evaluation that supports the status and recommendation.

Short DisplayPast immunizations supporting recommendation
Cardinality0..*
TypeReference(Immunization | ImmunizationEvaluation)
Summaryfalse
ImmunizationRecommendation.recommendation.supportingPatientInformation
Element IdImmunizationRecommendation.recommendation.supportingPatientInformation
Definition

Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Short DisplayPatient observations supporting recommendation
Cardinality0..*
TypeReference(Any)
Summaryfalse