FHIR Release 3 (STU) R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.5.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.recommendation.protocol.authority
ImmunizationRecommendation
Element Id ImmunizationRecommendation
Definition

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

Control 1..1
Type DomainResource
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 recommendations 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 : Rule One of vaccineCode or targetDisease SHALL be present ( expression vaccineCode.exists() or targetDisease.exists(), xpath: exists(f:vaccineCode) or exists(f:targetDisease)) targetDisease.exists()
ImmunizationRecommendation.recommendation.date ImmunizationRecommendation.recommendation.vaccineCode
Element Id ImmunizationRecommendation.recommendation.vaccineCode
Definition

The date Vaccine(s) or vaccine group that pertain to the immunization recommendation was created. recommendation.

Control 1..1 0..*
Terminology Binding Vaccine Administered Value Set ( Example )
Type dateTime CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.vaccineCode ImmunizationRecommendation.recommendation.targetDisease
Element Id ImmunizationRecommendation.recommendation.targetDisease
Definition

Vaccine that pertains to The targeted disease for the recommendation.

Control 0..1
Terminology Binding Vaccine Administered Value Set Immunization Recommendation Target Disease Codes ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.targetDisease ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Element Id ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Definition

The targeted disease for Vaccine(s) which should not be used to fulfill the recommendation.

Control 0..1 0..*
Terminology Binding Immunization Recommendation Target Disease Codes Vaccine Administered Value Set ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.doseNumber ImmunizationRecommendation.recommendation.forecastStatus
Element Id ImmunizationRecommendation.recommendation.forecastStatus
Definition

The next recommended dose number (e.g. dose 2 is Indicates the next recommended dose). patient status with respect to the path to immunity for the target disease.

Control 0..1 1..1
Terminology Binding Immunization Recommendation Status Codes ( Example )
Type positiveInt CodeableConcept
Summary 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).)
Comments Summary May need other dose concepts such as administered vs. valid. true
ImmunizationRecommendation.recommendation.forecastStatus ImmunizationRecommendation.recommendation.forecastReason
Element Id ImmunizationRecommendation.recommendation.forecastReason
Definition

Vaccine administration The reason for the assigned forecast status.

Control 1..1 0..*
Terminology Binding Immunization Recommendation Status 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.protocol ImmunizationRecommendation.recommendation.description
Element Id ImmunizationRecommendation.recommendation.description
Definition

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

Control 0..1
Type string
ImmunizationRecommendation.recommendation.protocol.doseSequence ImmunizationRecommendation.recommendation.series
Element Id ImmunizationRecommendation.recommendation.series
Definition

Indicates the nominal position in One possible path to achieve presumed immunity against a series of the next dose. This is disease - within the recommended dose number as per a specified protocol. context of an authority.

Control 0..1
Type positiveInt string
ImmunizationRecommendation.recommendation.protocol.description ImmunizationRecommendation.recommendation.doseNumber[x]
Element Id ImmunizationRecommendation.recommendation.doseNumber[x]
Definition

Contains the description about Nominal position of the protocol under which recommended dose in a series (e.g. dose 2 is the vaccine was administered. next recommended dose).

Control 0..1
Type positiveInt | string
Definition [x] Note Indicates the authority who published the protocol. For example, ACIP. See Choice of Data Types for further information about how to use [x]
Control Summary 0..1 true
Type Comments Reference ( Organization )

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.protocol.series ImmunizationRecommendation.recommendation.seriesDoses[x]
Element Id ImmunizationRecommendation.recommendation.seriesDoses[x]
Definition

One possible path The recommended number of doses to achieve presumed immunity against a disease - within the context of an authority. 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 ( Observation | AllergyIntolerance Any )