The FHIR R4 Immunization resource captures details about vaccines administered to a patient. It includes information about the vaccine type, dosage, administration details, and other relevant data. This resource helps healthcare providers track immunization history and ensure patients receive appropriate vaccinations.
Use Cases
- Record vaccine administration for a patient
- Retrieve immunization history for a patient
- Update immunization details for ongoing vaccination plans
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/Immunization
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/Immunization
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required Scopes:
immunization.readfor GETimmunization.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read Immunization | Retrieves a specific Immunization record by its FHIR ID. |
GET | Search Immunization | Searches for Immunization records for a specified patient. |
POST | Create Immunization | Submits a new Immunization record to the Health Gorilla FHIR server. |
PUT | Update Immunization | Updates an existing Immunization record by full resource replacement. |
DELETE | Delete Immunization | Removes an existing Immunization record from the system by full resource deletion. |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
date | Filters by the date the immunization was administered | ge2022-01-01, le2023-12-31 | date | No |
vaccineCode | Filters by the vaccine code | SNOMED CT or CVX code (e.g., 207287001) | token | No |
status | Filters by immunization status | ImmunizationStatus (completed) | token | No |
manufacturer | Filters by the vaccine manufacturer | Organization/{id} | Reference | No |
lotNumber | Filters by the vaccine lot number | e.g., AB12345 | string | No |
encounter | Filters by the encounter associated with the immunization | Encounter/{id} | Reference | No |
location | Filters by the location of vaccine administration | Location/{id} | Reference | No |
notGiven | Filters for vaccines that were not administered | true, false | boolean | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Reference to the patient who received the immunization | Patient/{id} | Reference(Patient) | Yes |
vaccineCode | The vaccine administered | SNOMED CT or CVX code (e.g., 207287001) | CodeableConcept | Yes |
status | The status of the immunization (e.g., completed, entered in error) | ImmunizationStatus | CodeableConcept | Yes |
date | The date the immunization was administered | 2022-01-01 | dateTime | Yes |
lotNumber | The lot number of the vaccine administered | AB12345 | string | No |
manufacturer | The manufacturer of the vaccine | Organization/{id} | Reference | No |
encounter | The encounter during which the immunization was given | Encounter/{id} | Reference | No |
location | The location where the immunization was given | Location/{id} | Reference | No |
performer | The practitioner or organization who administered the vaccine | Practitioner/{id}, Organization/{id} | Reference | No |
note | Additional notes about the immunization | Patient had a mild reaction after vaccine administration. | string | No |
reaction | Reaction details, if any, following the immunization | hives, dyspnea, etc. | CodeableConcept[] | No |
Webhooks
Clients can subscribe to receive notifications when new immunizations are recorded or existing immunization records are updated. For more information, go to: Webhooks & Polling.
Error Handling
All Immunization operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling.