Short answer: Immunization is the FHIR resource for one vaccine dose: which vaccine, when, to whom, the lot number, the dose number in a series and who gave it. A vaccination history is the list of a person's Immunization resources; a dose that was planned but not given is recorded with status not-done and a reason.
Key elements
- status: completed, entered-in-error, not-done.
- vaccineCode: the vaccine, coded by country (for example CVX in the US, SNOMED CT or national codes in Europe).
- occurrenceDateTime: when the dose was given.
- lotNumber, expirationDate, site, route.
- performer: who vaccinated.
- protocolApplied.doseNumberPositiveInt and targetDisease: the dose in the series and the disease it protects against.
ImmunizationRecommendation is a separate resource for what is due; the record itself only says what was given.
Records across borders
The International Patient Summary includes an immunizations section, which is one way a vaccination history travels to another country. Paper certificates and national registers remain the official proof where an authority requires it.
In Anpheros
In Anpheros each dose noted in a family member's profile is an Immunization resource and appears in their patient summary. See the patient guide on the family vaccination record and, for developers, the International Patient Summary in FHIR.
Related pages
Sources
Frequently asked questions
How is a vaccine dose stored in FHIR?
As an Immunization resource with status, vaccineCode, occurrence date, lot number and the dose number in its series.
How do I record a vaccine that was not given?
Use status not-done with a statusReason.
Which codes identify the vaccine?
It depends on the country: CVX in the US, SNOMED CT or national codes elsewhere. The IPS uses SNOMED CT.
Is a FHIR Immunization an official certificate?
No. It is a record; official certificates come from the health authority or the vaccinating doctor.
Try it free in the sandbox
Your first FHIR call in 5 minutes. An HL7 FHIR R4 API with the patient's consent built in: try it in the sandbox, then connect your own app or clinic system.
Free · 30 synthetic patients · no card
Anpheros builds a medical record that the patient controls and can share with any clinic, on an HL7 FHIR R4 platform, based in the EU. These guides help you understand and organise your health; they do not replace your doctor.
About Anpheros →
AnpherosThe more you log, the clearer your record
Your health history in one place, under your control.
Free · Works in your browser · No card
