# ImmunizationEvaluation

Canonical page: https://docs.ovok.com/api/fhir/r4/immunization-evaluation

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/ImmunizationEvaluation/[id]` |
| Vread | `GET` | `/fhir/R4/ImmunizationEvaluation/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/ImmunizationEvaluation/[id]` |
| Patch | `PATCH` | `/fhir/R4/ImmunizationEvaluation/[id]` |
| Delete | `DELETE` | `/fhir/R4/ImmunizationEvaluation/[id]` |
| Create | `POST` | `/fhir/R4/ImmunizationEvaluation` |
| Search | `GET` | `/fhir/R4/ImmunizationEvaluation` |
| History | `GET` | `/fhir/R4/ImmunizationEvaluation/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifier |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | completed \| entered-in-error |
| <span id="element-patient"></span>`patient` | [Reference](/fhir-elements/complex/reference) | `1..1` | Who this evaluation is for |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date evaluation was performed |
| <span id="element-authority"></span>`authority` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who is responsible for publishing the recommendations |
| <span id="element-target-disease"></span>`targetDisease` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Evaluation target disease |
| <span id="element-immunization-event"></span>`immunizationEvent` | [Reference](/fhir-elements/complex/reference) | `1..1` | Immunization being evaluated |
| <span id="element-dose-status"></span>`doseStatus` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..1` | Status of the dose relative to published recommendations |
| <span id="element-dose-status-reason"></span>`doseStatusReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Reason for the dose status |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Evaluation notes |
| <span id="element-series"></span>`series` | [string](/fhir-elements/primitive/string) | `0..1` | Name of vaccine series |
| <span id="element-dose-number-x"></span>`doseNumber[x]` | [positiveInt](/fhir-elements/primitive/positive-int), [string](/fhir-elements/primitive/string) | `0..1` | Dose number within series |
| <span id="element-series-doses-x"></span>`seriesDoses[x]` | [positiveInt](/fhir-elements/primitive/positive-int), [string](/fhir-elements/primitive/string) | `0..1` | Recommended number of doses for immunity |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `date` | date | Date the evaluation was generated |
| `dose-status` | token | The status of the dose relative to published recommendations |
| `identifier` | token | ID of the evaluation |
| `immunization-event` | reference | The vaccine administration event being evaluated |
| `patient` | reference | The patient being evaluated |
| `status` | token | Immunization evaluation status |
| `target-disease` | token | The vaccine preventable disease being evaluated against |

## Reference [#reference]

Official FHIR R4 spec: [ImmunizationEvaluation](https://hl7.org/fhir/R4/immunizationevaluation.html).  
Maturity: Draft (FMM 0).
