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.
Properties
| Name | Required | Type | Description |
|---|
| identifier | No | Identifier[] | Business identifier |
| status | Yes | code | completed / entered-in-error / not-done |
| statusReason | No | CodeableConcept | Reason not done |
| vaccineCode | Yes | CodeableConcept | Vaccine product administered |
| patient | Yes | Reference<Patient> | Who was immunized |
| encounter | No | Reference<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 | Indicates the source of a secondarily reported record |
| location | No | Reference<Location> | Where immunization occurred |
| manufacturer | No | Reference<Organization> | Vaccine manufacturer |
| lotNumber | No | string | Vaccine lot number |
| expirationDate | No | date | Vaccine expiration date |
| site | No | CodeableConcept | Body site vaccine was administered |
| route | No | CodeableConcept | How vaccine entered body |
| doseQuantity | No | Quantity | Amount of vaccine administered |
| performer | No | ImmunizationPerformer | Who performed event |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - function | No | CodeableConcept | What type of performance was done |
| - actor | Yes | Reference<Practitioner / PractitionerRole / Organization> | Individual or organization who was performing |
| note | No | Annotation[] | Additional immunization notes |
| reasonCode | No | CodeableConcept[] | Why immunization occurred |
| reasonReference | No | Reference<Condition / Observation / DiagnosticReport>[] | Why immunization occurred |
| isSubpotent | No | boolean | Dose potency |
| subpotentReason | No | 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[] | Additional content defined by implementations |
| - modifierExtension | No | 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[] | Patient eligibility for a vaccination program |
| fundingSource | No | 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[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - date | No | dateTime | When reaction started |
| - detail | No | Reference<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[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - series | No | string | Name of vaccine series |
| - authority | No | Reference<Organization> | Who is responsible for publishing the recommendations |
| - targetDisease | No | 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 | 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 | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
