The FHIR STU3 Immunization resource describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

FHIR Resource: Immunization <https://www.hl7.org/fhir/immunization.html>

Supported Attributes

Name	Comment
status
notGiven
vaccineCode
manufacturer
lotNumber
patient
date
deceased
expirationDate
doseQuanity
route
practitioner
location
site
note
explanation
primarySource

https://api.healthgorilla.com/fhir/Immunization

FHIR Operations

The following operations are currently supported:

1. Read

HTTP Request	Method	Action
/Immunization/`{ID}`	GET	Retrieve Immunization resource by ID

2. Search

HTTP Request	Method	Action
/Immunization?[parameter=`{value}`]	GET	Retrieve Immunization resources by the specified search criteria

Parameters:

Key	Type	Description
patient	Reference	Patient Identifier
_lastUpdated	Date
_offset	Number
_count	Number

Examples

2.1 Retrieve immunizations records by patient

https://api.healthgorilla.com/fhir/Immunization?patient=8063965523692105bfc35def

2.2 Search records updated since March 2019

https://api.healthgorilla.com/fhir/Immunization?_lastUpdated=gt2019-03&_offset=0&_count=5

2.3 Retrieve records for the given patient updated in 2018

https://api.healthgorilla.com/fhir/Immunization?patient=8063965523692105bfc35def&_lastUpdated=2018

3. Create

HTTP Request	Method	Action
/Immunization	POST	Creates Immunization resource

The following attributes are required:

Name	Details
patient
vaccineCode
primarySource
notGiven

4. Update

HTTP Request	Method	Action
/Immunization/`{ID}`	PUT	Updates Immunization resource

The following attributes are immutable:

Name	Details
patient
practitioner
vaccineCode

5. Delete

HTTP Request	Method	Action
/Immunization/`{ID}`	DELETE	Deletes Immunization resource