ImmunizationEvaluation
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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Business identifier |
status | code | 1..1 | completed | entered-in-error |
patient | Reference | 1..1 | Who this evaluation is for |
date | dateTime | 0..1 | Date evaluation was performed |
authority | Reference | 0..1 | Who is responsible for publishing the recommendations |
targetDisease | CodeableConcept | 1..1 | Evaluation target disease |
immunizationEvent | Reference | 1..1 | Immunization being evaluated |
doseStatus | CodeableConcept | 1..1 | Status of the dose relative to published recommendations |
doseStatusReason | CodeableConcept | 0..* | Reason for the dose status |
description | string | 0..1 | Evaluation notes |
series | string | 0..1 | Name of vaccine series |
doseNumber[x] | positiveInt, string | 0..1 | Dose number within series |
seriesDoses[x] | positiveInt, string | 0..1 | Recommended number of doses for immunity |
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
Official FHIR R4 spec: ImmunizationEvaluation.
Maturity: Draft (FMM 0).