Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | TU | DomainResource | Immunization event information Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | 0..* | Identifier | Business identifier | |
basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on |
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: Immunization Status Codes (Required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: Immunization Status Reason Codes (Example) | |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine administered Binding: Vaccine Administered Value Set (Example) |
administeredProduct | 0..1 | CodeableReference(Medication) | Product that was administered | |
manufacturer | 0..1 | CodeableReference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
supportingInformation | 0..* | Reference(Any) | Additional information in support of the immunization | |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
primarySource | Σ | 0..1 | boolean | Indicates context the data was captured in |
informationSource | 0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: Immunization Origin Codes (Example) | |
location | 0..1 | Reference(Location) | Where immunization occurred | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (Example) | |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (Example) | |
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
performer | Σ | 0..* | BackboneElement | Who performed event |
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Function Codes (Extensible) |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes |
reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: Immunization Reason Codes (Example) | |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: Immunization Subpotent Reason (Example) | |
programEligibility | 0..* | BackboneElement | Patient eligibility for a specific vaccination program | |
program | 1..1 | CodeableConcept | The program that eligibility is declared for Binding: Vaccine Funding Programs (Example) | |
programStatus | 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: Immunization Program Eligibility (Example) | |
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: Immunization Funding Source (Example) | |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |
date | 0..1 | dateTime | When reaction started | |
manifestation | 0..1 | CodeableReference(Observation) | Additional information on reaction | |
reported | 0..1 | boolean | Indicates self-reported reaction | |
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |
series | 0..1 | string | Name of vaccine series | |
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: Immunization Target Disease Codes (Example) | |
doseNumber | 1..1 | string | Dose number within series | |
seriesDoses | 0..1 | string | Recommended number of doses for immunity | |
Documentation for this format |