Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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 UseSecurity Category: Patient 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.

Short DisplayImmunization evaluation information
Cardinality0..*
TypeDomainResource
Summaryfalse
ImmunizationEvaluation.identifier
Element IdImmunizationEvaluation.identifier
Definition

A unique identifier assigned to this immunization evaluation record.

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
ImmunizationEvaluation.status
Element IdImmunizationEvaluation.status
Definition

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

Short Displaycompleted | entered-in-error
Cardinality1..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.

Short DisplayWho this evaluation is for
Cardinality1..1
TypeReference(Patient)
Summarytrue
ImmunizationEvaluation.date
Element IdImmunizationEvaluation.date
Definition

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

Short DisplayDate evaluation was performed
Cardinality0..1
TypedateTime
Summaryfalse
ImmunizationEvaluation.authority
Element IdImmunizationEvaluation.authority
Definition

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

Short DisplayWho is responsible for publishing the recommendations
Cardinality0..1
TypeReference(Organization)
Summaryfalse
ImmunizationEvaluation.targetDisease
Element IdImmunizationEvaluation.targetDisease
Definition

The vaccine preventable disease the dose is being evaluated against.

Short DisplayThe vaccine preventable disease schedule being evaluated
Cardinality1..1
Terminology BindingImmunization Target Disease Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationEvaluation.immunizationEvent
Element IdImmunizationEvaluation.immunizationEvent
Definition

The vaccine administration event being evaluated.

Short DisplayImmunization being evaluated
Cardinality1..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.

Short DisplayStatus of the dose relative to published recommendations
Cardinality1..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.

Short DisplayReason why the doese is considered valid, invalid or some other status
Cardinality0..*
Terminology BindingImmunization Evaluation Dose Status Reason codes (Example)
TypeCodeableConcept
Summaryfalse
ImmunizationEvaluation.description
Element IdImmunizationEvaluation.description
Definition

Additional information about the evaluation.

Short DisplayEvaluation notes
Cardinality0..1
Typestring
Summaryfalse
ImmunizationEvaluation.series
Element IdImmunizationEvaluation.series
Definition

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

Short DisplayName of vaccine series
Cardinality0..1
Typestring
Summaryfalse
ImmunizationEvaluation.doseNumber
Element IdImmunizationEvaluation.doseNumber
Definition

Nominal position in a series as determined by the outcome of the evaluation process.

Short DisplayDose number within series
Cardinality0..1
Typestring
Summaryfalse
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
Element IdImmunizationEvaluation.seriesDoses
Definition

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

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

The use of an integer is preferred if known.