Immunization REST Endpoints

Sort by

Task Path Method

Description

Immunization

This topic describes information for the Immunization resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines, in all care settings, and all regions. This resource contains the functionality to query a patient's immunization history. You can find detailed administration records in the MedicationAdministration resource, while this Immunization resource represents the known vaccination history regardless of where the administration itself was done.

An immunization reaction may indicate an allergy or intolerance. If so, create a separate AllergyIntolerance resource instance as well.

Profile Support

This resource supports the US Core Immunization Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Immunization	DomainResource
Immunization.status	code
Immunization.statusReason	CodeableConcept
Immunization.vaccineCode	CodeableConcept
Immunization.patient	Reference(Patient)
Immunization.occurrence[x]	dateTime string
Immunization.primarySource	boolean

Terminology Bindings

Element	Description	Details
Immunization.status	The current status of the immunization event.	System
Immunization.statusReason	The reason the immunization event was not performed.	System
Immunization.vaccineCode	The vaccine that was administered or was to be administered.	CVX NDC

Immunization

The operations from the Immunization category.

Get a list of immunizations

Method: get

Path: /Immunization

Get an immunization by ID

Method: get

Path: /Immunization/{id}