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.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/Immunization| 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(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | Business identifier |
status | code | 1..1 | completed | entered-in-error | not-done modifier |
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 modifier |
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
Reference
- Official FHIR R4 spec:
Immunization - Maturity: Trial Use 3 (FMM 3).