> ## 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.

## Properties

| Name | Required | Type | Description |
| - | - | - | - |
| identifier | No | [Identifier](/medical-api/fhir/data-types/identifier)\[] | Business identifier |
| status | Yes | code | completed / entered-in-error / not-done |
| statusReason | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | Reason not done |
| vaccineCode | Yes | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | Vaccine product administered |
| patient | Yes | Reference\<[Patient](/medical-api/fhir/resources/patient)> | Who was immunized |
| encounter | No | Reference\<[Encounter](/medical-api/fhir/resources/encounter)> | Encounter immunization was part of |
| occurrence\[x] | Yes | dateTime, string | Vaccine administration date |
| recorded | No | dateTime | When the immunization was first captured in the subject's record |
| primarySource | No | boolean | Indicates context the data was recorded in |
| reportOrigin | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | Indicates the source of a secondarily reported record |
| location | No | Reference\<[Location](/medical-api/fhir/resources/location)> | Where immunization occurred |
| manufacturer | No | Reference\<[Organization](/medical-api/fhir/resources/organization)> | Vaccine manufacturer |
| lotNumber | No | string | Vaccine lot number |
| expirationDate | No | date | Vaccine expiration date |
| site | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | Body site vaccine was administered |
| route | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | How vaccine entered body |
| doseQuantity | No | [Quantity](/medical-api/fhir/data-types/quantity) | Amount of vaccine administered |
| performer | No | ImmunizationPerformer | Who performed event |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - function | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | What type of performance was done |
| - actor | Yes | Reference\<[Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [Organization](/medical-api/fhir/resources/organization)> | Individual or organization who was performing |
| note | No | [Annotation](/medical-api/fhir/data-types/annotation)\[] | Additional immunization notes |
| reasonCode | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Why immunization occurred |
| reasonReference | No | Reference\<[Condition](/medical-api/fhir/resources/condition) / [Observation](/medical-api/fhir/resources/observation) / [DiagnosticReport](/medical-api/fhir/resources/diagnosticreport)>\[] | Why immunization occurred |
| isSubpotent | No | boolean | Dose potency |
| subpotentReason | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Reason for being subpotent |
| education | No | ImmunizationEducation | Educational material presented to patient |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - documentType | No | string | Educational material document identifier |
| - reference | No | uri | Educational material reference pointer |
| - publicationDate | No | dateTime | Educational material publication date |
| - presentationDate | No | dateTime | Educational material presentation date |
| programEligibility | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Patient eligibility for a vaccination program |
| fundingSource | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept) | Funding source for the vaccine |
| reaction | No | ImmunizationReaction | Details of a reaction that follows immunization |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - date | No | dateTime | When reaction started |
| - detail | No | Reference\<[Observation](/medical-api/fhir/resources/observation)> | Additional information on reaction |
| - reported | No | boolean | Indicates self-reported reaction |
| protocolApplied | No | ImmunizationProtocolApplied | Protocol followed by the provider |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| - modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored even if unrecognized |
| - series | No | string | Name of vaccine series |
| - authority | No | Reference\<[Organization](/medical-api/fhir/resources/organization)> | Who is responsible for publishing the recommendations |
| - targetDisease | No | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Vaccine preventatable disease being targetted |
| - doseNumber\[x] | Yes | positiveInt, string | Dose number within series |
| - seriesDoses\[x] | No | positiveInt, string | Recommended number of doses for immunity |

## Search Parameters

| Name | Type | Description | Expression |
| - | - | - | - |
| date | date | Vaccination (non)-Administration Date | Immunization.occurrence |
| identifier | token | Business identifier | Immunization.identifier |
| patient | reference | The patient for the vaccination record | Immunization.patient |
| location | reference | The service delivery location or facility in which the vaccine was / was to be administered | Immunization.location |
| lot-number | string | Vaccine Lot Number | Immunization.lotNumber |
| manufacturer | reference | Vaccine Manufacturer | Immunization.manufacturer |
| performer | reference | The practitioner or organization who played a role in the vaccination | Immunization.performer.actor |
| reaction | reference | Additional information on reaction | Immunization.reaction.detail |
| reaction-date | date | When reaction started | Immunization.reaction.date |
| reason-code | token | Reason why the vaccine was administered | Immunization.reasonCode |
| reason-reference | reference | Why immunization occurred | Immunization.reasonReference |
| series | string | The series being followed by the provider | Immunization.protocolApplied.series |
| status | token | Immunization event status | Immunization.status |
| status-reason | token | Reason why the vaccine was not administered | Immunization.statusReason |
| target-disease | token | The target disease the dose is being administered against | Immunization.protocolApplied.targetDisease |
| vaccine-code | token | Vaccine Product Administered | Immunization.vaccineCode |

## Inherited Properties

| Name | Required | Type | Description |
| - | - | - | - |
| id | No | string | Logical id of this artifact |
| meta | No | [Meta](/medical-api/fhir/data-types/meta) | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | [Narrative](/medical-api/fhir/data-types/narrative) | Text summary of the resource, for human interpretation |
| contained | No | Resource\[] | Contained, inline Resources |
| extension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations |
| modifierExtension | No | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored |

To view the FHIR specification for this resource, see [Immunization](https://www.hl7.org/fhir/StructureDefinition/Immunization).


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