R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (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

Public Health and Emergency Response Work GroupMaturity Level: 0 Trial Use Compartments: Patient

Detailed Descriptions for the elements in the ImmunizationEvaluation resource.

ImmunizationEvaluation
Element IdImmunizationEvaluation
Definition

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

Control1..1
TypeDomainResource
ImmunizationEvaluation.identifier
Element IdImmunizationEvaluation.identifier
Definition

A unique identifier assigned to this immunization evaluation record.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
ImmunizationEvaluation.status
Element IdImmunizationEvaluation.status
Definition

Indicates the current status of the evaluation of the vaccination administration event.

Control1..1
Terminology BindingImmunization Evaluation Status Codes (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid).)
Summarytrue
ImmunizationEvaluation.patient
Element IdImmunizationEvaluation.patient
Definition

The individual for whom the evaluation is being done.

Control1..1
TypeReference(Patient)
Summarytrue
ImmunizationEvaluation.date
Element IdImmunizationEvaluation.date
Definition

The date the evaluation of the vaccine administration event was performed.

Control0..1
TypedateTime
ImmunizationEvaluation.authority
Element IdImmunizationEvaluation.authority
Definition

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

Control0..1
TypeReference(Organization)
ImmunizationEvaluation.targetDisease
Element IdImmunizationEvaluation.targetDisease
Definition

The vaccine preventable disease the dose is being evaluated against.

Control1..1
Terminology BindingImmunization Evaluation Target Disease Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationEvaluation.immunizationEvent
Element IdImmunizationEvaluation.immunizationEvent
Definition

The vaccine administration event being evaluated.

Control1..1
TypeReference(Immunization)
Summarytrue
ImmunizationEvaluation.doseStatus
Element IdImmunizationEvaluation.doseStatus
Definition

Indicates if the dose is valid or not valid with respect to the published recommendations.

Control1..1
Terminology BindingImmunization Evaluation Dose Status codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationEvaluation.doseStatusReason
Element IdImmunizationEvaluation.doseStatusReason
Definition

Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.

Control0..*
Terminology BindingImmunization Evaluation Dose Status Reason codes (Example)
TypeCodeableConcept
ImmunizationEvaluation.description
Element IdImmunizationEvaluation.description
Definition

Additional information about the evaluation.

Control0..1
Typestring
ImmunizationEvaluation.series
Element IdImmunizationEvaluation.series
Definition

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

Control0..1
Typestring
ImmunizationEvaluation.doseNumber[x]
Element IdImmunizationEvaluation.doseNumber[x]
Definition

Nominal position in a series.

Control0..1
TypepositiveInt|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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).

ImmunizationEvaluation.seriesDoses[x]
Element IdImmunizationEvaluation.seriesDoses[x]
Definition

The recommended number of doses to achieve immunity.

Control0..1
TypepositiveInt|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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).