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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Immunization/[id] |
| Vread | GET | /fhir/R4/Immunization/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Immunization/[id] |
| Patch | PATCH | /fhir/R4/Immunization/[id] |
| Delete | DELETE | /fhir/R4/Immunization/[id] |
| Create | POST | /fhir/R4/Immunization |
| Search | GET | /fhir/R4/Immunization |
| History | GET | /fhir/R4/Immunization/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Business identifier |
status | code | 1..1 | completed | entered-in-error | not-done |
statusReason | CodeableConcept | 0..1 | Reason not done |
vaccineCode | CodeableConcept | 1..1 | Vaccine product administered |
patient | Reference | 1..1 | Who was immunized |
encounter | Reference | 0..1 | Encounter immunization was part of |
occurrence[x] | dateTime, string | 1..1 | Vaccine administration date |
recorded | dateTime | 0..1 | When the immunization was first captured in the subject's record |
primarySource | boolean | 0..1 | Indicates context the data was recorded in |
reportOrigin | CodeableConcept | 0..1 | Indicates the source of a secondarily reported record |
location | Reference | 0..1 | Where immunization occurred |
manufacturer | Reference | 0..1 | Vaccine manufacturer |
lotNumber | string | 0..1 | Vaccine lot number |
expirationDate | date | 0..1 | Vaccine expiration date |
site | CodeableConcept | 0..1 | Body site vaccine was administered |
route | CodeableConcept | 0..1 | How vaccine entered body |
doseQuantity | Quantity | 0..1 | Amount of vaccine administered |
performer | BackboneElement | 0..* | Who performed event |
note | Annotation | 0..* | Additional immunization notes |
reasonCode | CodeableConcept | 0..* | Why immunization occurred |
reasonReference | Reference | 0..* | Why immunization occurred |
isSubpotent | boolean | 0..1 | Dose potency |
subpotentReason | CodeableConcept | 0..* | Reason for being subpotent |
education | BackboneElement | 0..* | Educational material presented to patient |
programEligibility | CodeableConcept | 0..* | Patient eligibility for a vaccination program |
fundingSource | CodeableConcept | 0..1 | Funding source for the vaccine |
reaction | BackboneElement | 0..* | Details of a reaction that follows immunization |
protocolApplied | BackboneElement | 0..* | Protocol followed by the provider |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
date | date | Multiple Resources: AllergyIntolerance: Date first version of the resource instance was recorded ; CarePlan: Time period plan covers ; CareTeam: Time period team covers ; ClinicalImpression: When the assessment was documented ; Composition: Composition editing time ; Consent: When this Consent was created or indexed ; DiagnosticReport: The clinically relevant time of the report ; Encounter: A date within the period the Encounter lasted ; EpisodeOfCare: The provided date search value falls within the episode of care's period ; FamilyMemberHistory: When history was recorded or last updated ; Flag: Time period when flag is active ; Immunization: Vaccination (non)-Administration Date ; List: When the list was prepared ; Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period ; Procedure: When the procedure was performed ; RiskAssessment: When was assessment made? ; SupplyRequest: When the request was made |
identifier | token | Multiple Resources: AllergyIntolerance: External ids for this item ; CarePlan: External Ids for this plan ; CareTeam: External Ids for this team ; Composition: Version-independent identifier for the Composition ; Condition: A unique identifier of the condition record ; Consent: Identifier for this record (external references) ; DetectedIssue: Unique id for the detected issue ; DeviceRequest: Business identifier for request/order ; DiagnosticReport: An identifier for the report ; DocumentManifest: Unique Identifier for the set of documents ; DocumentReference: Master Version Specific Identifier ; Encounter: Identifier(s) by which this encounter is known ; EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare ; FamilyMemberHistory: A search by a record identifier ; Goal: External Ids for this goal ; ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number ; Immunization: Business identifier ; List: Business identifier ; MedicationAdministration: Return administrations with this external identifier ; MedicationDispense: Returns dispenses with this external identifier ; MedicationRequest: Return prescriptions with this external identifier ; MedicationStatement: Return statements with this external identifier ; NutritionOrder: Return nutrition orders with this external identifier ; Observation: The unique id for a particular observation ; Procedure: A unique identifier for a procedure ; RiskAssessment: Unique identifier for the assessment ; ServiceRequest: Identifiers assigned to this order ; SupplyDelivery: External identifier ; SupplyRequest: Business Identifier for SupplyRequest ; VisionPrescription: Return prescriptions with this external identifier |
location | reference | The service delivery location or facility in which the vaccine was / was to be administered |
lot-number | string | Vaccine Lot Number |
manufacturer | reference | Vaccine Manufacturer |
patient | reference | Multiple Resources: AllergyIntolerance: Who the sensitivity is for ; CarePlan: Who the care plan is for ; CareTeam: Who care team is for ; ClinicalImpression: Patient or group assessed ; Composition: Who and/or what the composition is about ; Condition: Who has the condition? ; Consent: Who the consent applies to ; DetectedIssue: Associated patient ; DeviceRequest: Individual the service is ordered for ; DeviceUseStatement: Search by subject - a patient ; DiagnosticReport: The subject of the report if a patient ; DocumentManifest: The subject of the set of documents ; DocumentReference: Who/what is the subject of the document ; Encounter: The patient or group present at the encounter ; EpisodeOfCare: The patient who is the focus of this episode of care ; FamilyMemberHistory: The identity of a subject to list family member history items for ; Flag: The identity of a subject to list flags for ; Goal: Who this goal is intended for ; ImagingStudy: Who the study is about ; Immunization: The patient for the vaccination record ; List: If all resources have the same subject ; MedicationAdministration: The identity of a patient to list administrations for ; MedicationDispense: The identity of a patient to list dispenses for ; MedicationRequest: Returns prescriptions for a specific patient ; MedicationStatement: Returns statements for a specific patient. ; NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement ; Observation: The subject that the observation is about (if patient) ; Procedure: Search by subject - a patient ; RiskAssessment: Who/what does assessment apply to? ; ServiceRequest: Search by subject - a patient ; SupplyDelivery: Patient for whom the item is supplied ; VisionPrescription: The identity of a patient to list dispenses for |
performer | reference | The practitioner or organization who played a role in the vaccination |
reaction | reference | Additional information on reaction |
reaction-date | date | When reaction started |
reason-code | token | Reason why the vaccine was administered |
reason-reference | reference | Why immunization occurred |
series | string | The series being followed by the provider |
status | token | Immunization event status |
status-reason | token | Reason why the vaccine was not administered |
target-disease | token | The target disease the dose is being administered against |
vaccine-code | token | Vaccine Product Administered |
Reference
Official FHIR R4 spec: Immunization.
Maturity: Trial Use 3 (FMM 3).