Immunization

The 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

NameComment
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 RequestMethodAction
/Immunization/{ID}GETRetrieve Immunization resource by ID

2. Search

HTTP RequestMethodAction
/Immunization?[parameter={value}]GETRetrieve Immunization resources by the specified search criteria

Parameters:

KeyTypeDescription
patientReferencePatient Identifier
_lastUpdatedDate
_offsetNumber
_countNumber

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 RequestMethodAction
/ImmunizationPOSTCreates Immunization resource

The following attributes are required:

NameDetails
patient
vaccineCode
primarySource
notGiven

4. Update

HTTP RequestMethodAction
/Immunization/{ID}PUTUpdates Immunization resource

The following attributes are immutable:

NameDetails
patient
practitioner
vaccineCode

5. Delete

HTTP RequestMethodAction
/Immunization/{ID}DELETEDeletes Immunization resource