Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Immunisations Section

Gives information about the Immunisations section

Immunisations Section Content

The Immunisations section carries information about the immunisation administered. PRSB Elements should be formatted as subheadings in any HTML sent.

Section Description Card. MRO* FHIR Target and Guidance
Immunisations section This acts as a container that holds all of the elements for each instance of an vaccination entry. 1 only M Carried in the CodeableConcept of Composition.section.code FHIR element.
PRSB Element Description Card. MRO* FHIR Target and Guidance
Vaccine product Vaccine product administered. 1 only M Text and if coding is available carried in the CodeableConcept of the Immunization.vaccineCode FHIR element.
Vaccine procedure The vaccination that was given e.g. seasonal influenza vaccination. 1 only M Text and if coding is available carried in the CodeableConcept of the Immunization.extension(vaccinationProcedure) FHIR element.
Manufacturer Name of vaccine manufacturer 0 to 1 R Not required for Pharmacy to GP communication.
Batch number The batch number of the vaccine product. 0 to 1 R Not required for Pharmacy to GP communication.
Expiry date The date on which the vaccine will expire. Not required for Pharmacy to GP communication.
Serialisation code A code that separately identifies two identical vaccines (i.e. same product, same batch). 0 to 1 O Derived from FMD code or free text.
Site Body site vaccine was administered into. 0 to 1 R Text and if coding is available carried in the CodeableConcept of the Immunization.site FHIR element.
Route How vaccine entered the body. 0 to 1 R Text and if coding is available carried in the CodeableConcept of the Immunization.route FHIR element.
Indication The clinical indication or reason for administering the vaccine. 0 to 1 O Text and if coding is available carried in the CodeableConcept of the Immunization.explanation.reason FHIR element.
Dose amount Amount of vaccine administered. 0 to 1 R This will be free text. Coded units of measure (from DM+D)
Guidance on how to use the dose amount field will follow.
Dose sequence Nominal position in a series of vaccines. 0 to 1 R Not required for Pharmacy to GP communication.
Administered by The name of the person who administered the vaccine, preferably in a structured format. 1 only M Send as structured name, the receiver can form free text if needed. This will be carried in the FHIR element Immunization.practitioner.actor.
Role The role of the person who administered the vaccine. 0 to 1 R The role may be held on the source system, be from an authoritative source such as SDS, or use an existing vocabulary such as the job role title (from the national workforce dataset). This will be carried in the FHIR element Immunization.practitioner.role.
Professional identifier Professional identifier & regulatory body of the person who administered the vaccine 0 to 1 R GPhC number of the pharmacist(default in from the log in, in the system). This will be carried in the FHIR element Immunization.practitioner.actor.
DateTime The date/time on which the vaccine was administered. 0 to 1 R The date/time as recorded by the pharmacy system. This will be carried in the FHIR element Immunization.date.
* M=Mandatory R=Required O=Optional

Example Immunisations Section

Coded Resources

This text section should be linked to the following FHIR Resources to provide the textual information in a coded format.

  • Immunization
Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated