> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# immunization

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. See the [HL7 FHIR R4 spec](https://hl7.org/fhir/R4/immunization.html) for full details.

**Previous version:** [immunization](/medical-api/handling-data/schema-v000/immunization)

**Tables in this resource:**

* **immunization** – Main immunization record (this page)
* [immunization\_vaccinecode\_coding](/medical-api/handling-data/schema-v100/immunization/vaccinecode_coding)
* [immunization\_statusreason\_coding](/medical-api/handling-data/schema-v100/immunization/statusreason_coding)
* [immunization\_route\_coding](/medical-api/handling-data/schema-v100/immunization/route_coding)
* [immunization\_site\_coding](/medical-api/handling-data/schema-v100/immunization/site_coding)
* [immunization\_extension](/medical-api/handling-data/schema-v100/immunization/extension)
* [immunization\_extension\_vcc\_coding](/medical-api/handling-data/schema-v100/immunization/extension_vcc_coding)
* **immunization\_references** – Normalized references; see [Reference Tables](/medical-api/handling-data/schema-v100/reference_tables)

**Reference Table:**

The `immunization_references` table contains normalized references from the immunization to other entities. It supports the following reference properties:

* **patient** (required): links to the [patient](/medical-api/handling-data/schema-v100/patient/base) who received the immunization
* **performer.actor**: links to [practitioner](/medical-api/handling-data/schema-v100/practitioner/base) or [organization](/medical-api/handling-data/schema-v100/organization/base) per `reference_type`

For detailed information about reference table structure and indexing, see the [Reference Tables documentation](/medical-api/handling-data/schema-v100/reference_tables).

**Primary Keys:**

* immunization\_id

**Foreign Keys:**

* patient\_id - links to the [patient](/medical-api/handling-data/schema-v100/patient/base) table

<div style={{textAlign: 'right'}}><sub>† Metriport Platform added</sub></div>

| Column | Data Type | Description |
| - | - | - |
| immunization\_id | varchar | Unique identifier for the immunization |
| patient\_id | varchar | Unique identifier for the patient |
| status | varchar | Status of the immunization record (e.g. completed, not-done) |
| occurrencedatetime | datetime | Occurrence date/time if provided directly |
| occurrencestring | varchar | Occurrence date/time as a string when not a structured date |
| occurrence\_date† | datetime | Coalesced occurrence date (occurrencedatetime or occurrencestring) |
| vaccinecode\_text | varchar | Free-text vaccine description |
| vaccinecode\_cvx\_code† | varchar | CVX vaccine code |
| vaccinecode\_cvx\_display† | varchar | Human-readable CVX description |
| statusreason\_text | varchar | Free-text status reason |
| route\_text | varchar | Free-text route of administration |
| site\_text | varchar | Free-text administration site |
| dosequantity\_value | varchar | Dose quantity value |
| dosequantity\_unit | varchar | Dose quantity unit |
| lotnumber | varchar | Lot number of the vaccine |
| note\_text† | varchar | Additional notes about the immunization (first note) |
| meta\_source | varchar | Source document filename from FHIR meta.source |
| data\_source\_ext† | varchar | Integration source of the data, derived from FHIR extension |

**Related Tables:**

**Parent:**

* [patient](/medical-api/handling-data/schema-v100/patient/base)

**Child:**

* [immunization\_extension](/medical-api/handling-data/schema-v100/immunization/extension)
* [immunization\_route\_coding](/medical-api/handling-data/schema-v100/immunization/route_coding)
* [immunization\_site\_coding](/medical-api/handling-data/schema-v100/immunization/site_coding)
* [immunization\_statusreason\_coding](/medical-api/handling-data/schema-v100/immunization/statusreason_coding)
* [immunization\_vaccinecode\_coding](/medical-api/handling-data/schema-v100/immunization/vaccinecode_coding)

## Version diff

**Renamed**

* `cvx_code` → `vaccinecode_cvx_code`
* `cvx_display` → `vaccinecode_cvx_display`
* `dose_amount` → `dosequantity_value`
* `dose_unit` → `dosequantity_unit`
* `data_source` → `meta_source`

**Moved to separate tables**

* `source_vaccine_code_code` → [`immunization_vaccinecode_coding.code`](/medical-api/handling-data/schema-v100/immunization/vaccinecode_coding) w/ `code_rank = 1`
* `source_vaccine_code_display` → [`immunization_vaccinecode_coding.display`](/medical-api/handling-data/schema-v100/immunization/vaccinecode_coding) w/ `code_rank = 1`
* `source_vaccine_code_system` → [`immunization_vaccinecode_coding.system`](/medical-api/handling-data/schema-v100/immunization/vaccinecode_coding) w/ `code_rank = 1`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.