Overview
The Immunization resource describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. At it`s minimum, Immunization contains vaccine code, date, reference to the patient and status of the immunization, but may also contain data about the administered vaccine including the manufacturer, lot number and expiration date.
If an immunization was not given, this would be represented as:
Immunization.status = “not-done”
Each Immunization has next elements:
- a status
- a vaccine code that identifies the kind of vaccine administered
- a date the vaccine was administered
- a patient
Each Immunization must support:
- a statusReason if the vaccine wasn’t given
- a flag to indicate whether the vaccine was reported by someone other than the person who administered the vaccine
This resource conforms to USCDI V2 profile for Immunization - refer to US Core Immunization Profile. Immunization response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.
| USCore Data Element | FHIR Resource Field |
|---|---|
| status | Immunization.status |
| vaccine | Immunization.vaccineCode |
| date | Immunization.occurence |
| patient | Immunization.patient |
Must support elements, mandatory and optional search parameters
Immunization must support these elements:
patientstatusstatusReasonvaccineCodepatientoccurrence[x]occurrenceDateTime
primarySource
The following search parameters and search parameter combinations SHALL be supported:
The syntax used to describe the interactions is described here.
SHALL support searching for all immunizations for a patient using the patient search parameter:
GET [base url]/Immunization?patient={Type/}[id]
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and date search parameters:
- including support for these date comparators: gt,lt,ge,le
- including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)
GET [base url]/Immunization?patient={Type/}[id]&date=[date]
The following search parameter combinations SHOULD be supported (optional):
SHOULD support searching using the combination of the patient and status search parameters:
GET [base url]/Immunization?patient={Type/}[id]&status={system|}[code]
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
Immunization By Patient Id
Search for immunizations by patient id.
METHOD GET
[base url]/Immunization?patient={Type/}[id]
PARAMS
[base url] - FHIR base url
[id] - Id for the Patient
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | 'Bearer' |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Immunization?patient=Patient/c5137fa5-3216-b12a-cbbc-a0c6bef361g7' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'
Immunization By Id
Get Immunization by ID.
METHOD GET
[base url]/Immunization/{id}
or
[base url]/Immunization?_id={id}
PARAMS
[base url] - FHIR base url
{id} - Id of Immunization resource
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | 'Bearer' |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Immunization/c5137fa5-3216-b12a-cbbc-a0c6bef361g7' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'