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
. Page versions: R5 R4B R4
| Public Health and Emergency Response  Work Group | Maturity Level: 1 | Trial Use | Security Category: Patient | Compartments: Patient | 
Detailed Descriptions for the elements in the ImmunizationEvaluation resource.
| ImmunizationEvaluation | |
| Element Id | ImmunizationEvaluation | 
| Definition | Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations. | 
| Short Display | Immunization evaluation information | 
| Cardinality | 0..* | 
| Type | DomainResource | 
| Summary | false | 
| ImmunizationEvaluation.identifier | |
| Element Id | ImmunizationEvaluation.identifier | 
| Definition | A unique identifier assigned to this immunization evaluation record. | 
| Short Display | Business identifier | 
| Note | This is a business identifier, not a resource identifier (see discussion) | 
| Cardinality | 0..* | 
| Type | Identifier | 
| Summary | false | 
| ImmunizationEvaluation.status | |
| Element Id | ImmunizationEvaluation.status | 
| Definition | Indicates the current status of the evaluation of the vaccination administration event. | 
| Short Display | completed | entered-in-error | 
| Cardinality | 1..1 | 
| Terminology Binding | Immunization Evaluation Status Codes (Required) | 
| Type | code | 
| Is Modifier | true (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).) | 
| Summary | true | 
| ImmunizationEvaluation.patient | |
| Element Id | ImmunizationEvaluation.patient | 
| Definition | The individual for whom the evaluation is being done. | 
| Short Display | Who this evaluation is for | 
| Cardinality | 1..1 | 
| Type | Reference(Patient) | 
| Summary | true | 
| ImmunizationEvaluation.date | |
| Element Id | ImmunizationEvaluation.date | 
| Definition | The date the evaluation of the vaccine administration event was performed. | 
| Short Display | Date evaluation was performed | 
| Cardinality | 0..1 | 
| Type | dateTime | 
| Summary | false | 
| ImmunizationEvaluation.authority | |
| Element Id | ImmunizationEvaluation.authority | 
| Definition | Indicates the authority who published the protocol (e.g. ACIP). | 
| Short Display | Who is responsible for publishing the recommendations | 
| Cardinality | 0..1 | 
| Type | Reference(Organization) | 
| Summary | false | 
| ImmunizationEvaluation.targetDisease | |
| Element Id | ImmunizationEvaluation.targetDisease | 
| Definition | The vaccine preventable disease the dose is being evaluated against. | 
| Short Display | The vaccine preventable disease schedule being evaluated | 
| Cardinality | 1..1 | 
| Terminology Binding | Immunization Target Disease Codes (Example) | 
| Type | CodeableConcept | 
| Summary | true | 
| ImmunizationEvaluation.immunizationEvent | |
| Element Id | ImmunizationEvaluation.immunizationEvent | 
| Definition | The vaccine administration event being evaluated. | 
| Short Display | Immunization being evaluated | 
| Cardinality | 1..1 | 
| Type | Reference(Immunization) | 
| Summary | true | 
| ImmunizationEvaluation.doseStatus | |
| Element Id | ImmunizationEvaluation.doseStatus | 
| Definition | Indicates if the dose is valid or not valid with respect to the published recommendations. | 
| Short Display | Status of the dose relative to published recommendations | 
| Cardinality | 1..1 | 
| Terminology Binding | Immunization Evaluation Dose Status codes (Example) | 
| Type | CodeableConcept | 
| Summary | true | 
| ImmunizationEvaluation.doseStatusReason | |
| Element Id | ImmunizationEvaluation.doseStatusReason | 
| Definition | Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. | 
| Short Display | Reason why the doese is considered valid, invalid or some other status | 
| Cardinality | 0..* | 
| Terminology Binding | Immunization Evaluation Dose Status Reason codes (Example) | 
| Type | CodeableConcept | 
| Summary | false | 
| ImmunizationEvaluation.description | |
| Element Id | ImmunizationEvaluation.description | 
| Definition | Additional information about the evaluation. | 
| Short Display | Evaluation notes | 
| Cardinality | 0..1 | 
| Type | markdown | 
| Summary | false | 
| ImmunizationEvaluation.series | |
| Element Id | ImmunizationEvaluation.series | 
| Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. | 
| Short Display | Name of vaccine series | 
| Cardinality | 0..1 | 
| Type | string | 
| Summary | false | 
| ImmunizationEvaluation.doseNumber | |
| Element Id | ImmunizationEvaluation.doseNumber | 
| Definition | Nominal position in a series as determined by the outcome of the evaluation process. | 
| Short Display | Dose number within series | 
| Cardinality | 0..1 | 
| Type | string | 
| Summary | false | 
| 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 Id | ImmunizationEvaluation.seriesDoses | 
| Definition | The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process. | 
| Short Display | Recommended number of doses for immunity | 
| Cardinality | 0..1 | 
| Type | string | 
| Summary | false | 
| Comments | The use of an integer is preferred if known. |