Immunization
ClinicalDescribes 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| Immunization | 0..* | — | Immunization event information |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .identifier | 0..* | Identifier | Business identifier |
| .status?!Σ | 1..1 | code | completed | entered-in-error | not-done Bindingimmunization-status(required) |
| .statusReason | 0..1 | CodeableConcept | Reason not done Bindingimmunization-status-reason(example) |
| .vaccineCodeΣ | 1..1 | CodeableConcept | Vaccine product administered Bindingvaccine-code(example) |
| .patientΣ | 1..1 | Reference(Patient) | Who was immunized |
| .encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of |
| .occurrence[x]Σ | 1..1 | dateTime | string | Vaccine administration date |
| .recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record |
| .primarySourceΣ | 0..1 | boolean | Indicates context the data was recorded in |
| .reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Bindingimmunization-origin(example) |
| .location | 0..1 | Reference(Location) | Where immunization occurred |
| .manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer |
| .lotNumber | 0..1 | string | Vaccine lot number |
| .expirationDate | 0..1 | date | Vaccine expiration date |
| .site | 0..1 | CodeableConcept | Body site vaccine was administered Bindingimmunization-site(example) |
| .route | 0..1 | CodeableConcept | How vaccine entered body Bindingimmunization-route(example) |
| .doseQuantity | 0..1 | Quantity | Amount of vaccine administered |
| .performerΣ | 0..* | BackboneElement | Who performed event |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .functionΣ | 0..1 | CodeableConcept | What type of performance was done Bindingimmunization-function(extensible) |
| .actorΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| .noteΣ | 0..* | Annotation | Additional immunization notes |
| .reasonCode | 0..* | CodeableConcept | Why immunization occurred Bindingimmunization-reason(example) |
| .reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
| .isSubpotent?!Σ | 0..1 | boolean | Dose potency |
| .subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Bindingimmunization-subpotent-reason(example) |
| .education | 0..* | BackboneElement | Educational material presented to patient |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .documentType | 0..1 | string | Educational material document identifier |
| .reference | 0..1 | uri | Educational material reference pointer |
| .publicationDate | 0..1 | dateTime | Educational material publication date |
| .presentationDate | 0..1 | dateTime | Educational material presentation date |
| .programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Bindingimmunization-program-eligibility(example) |
| .fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Bindingimmunization-funding-source(example) |
| .reaction | 0..* | BackboneElement | Details of a reaction that follows immunization |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .date | 0..1 | dateTime | When reaction started |
| .detail | 0..1 | Reference(Observation) | Additional information on reaction |
| .reported | 0..1 | boolean | Indicates self-reported reaction |
| .protocolApplied | 0..* | BackboneElement | Protocol followed by the provider |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .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 targetted Bindingimmunization-target-disease(example) |
| .doseNumber[x] | 1..1 | positiveInt | string | Dose number within series |
| .seriesDoses[x] | 0..1 | positiveInt | string | Recommended number of doses for immunity |