DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). 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 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
Definition

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

Control 1..1
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
Definition

The patient for whom the recommendations are for.

Control 1..1
Type Reference ( Patient )
Summary true
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.date
Definition

The date the immunization recommendation was created.

Control 1..1
Type dateTime
Summary true
ImmunizationRecommendation.recommendation.vaccineCode
Definition

Vaccine that pertains to the recommendation.

Control 1..1 0..1
Terminology Binding Vaccine Administered Value Set: Set ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.targetDisease
Definition

The type of vaccine administered targeted disease for the recommendation.

Control 0..1
Terminology Binding Immunization Recommendation Target Disease Codes ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.doseNumber
Definition

This indicates the The next recommended dose number (e.g. dose 2 is the next recommended dose).

Control 0..1
Type positiveInt
Summary true
Comments

May need other dose concepts such as administered vs. valid.

ImmunizationRecommendation.recommendation.forecastStatus
Definition

Vaccine administration status.

Control 1..1
Terminology Binding Immunization Recommendation Status Codes: The patient's status with respect to a vaccination protocol Codes ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.dateCriterion
Definition

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

Control 0..*
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: Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.) Codes ( Example )
Type CodeableConcept
ImmunizationRecommendation.recommendation.dateCriterion.value
Definition

The date whose meaning is specified by dateCriterion.code.

Control 1..1
Type dateTime
ImmunizationRecommendation.recommendation.protocol
Definition

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

Control 0..1
ImmunizationRecommendation.recommendation.protocol.doseSequence
Definition

Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.

Control 0..1
Type integer positiveInt
ImmunizationRecommendation.recommendation.protocol.description
Definition

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

Control 0..1
Type string
ImmunizationRecommendation.recommendation.protocol.authority
Definition

Indicates the authority who published the protocol. For example, ACIP.

Control 0..1
Type Reference ( Organization )
ImmunizationRecommendation.recommendation.protocol.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.supportingImmunization
Definition

Immunization event history that supports the status and recommendation.

Control 0..*
Type Reference ( Immunization )
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 )