NPHCDA Immunization FHIR IG
1.0.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/ImmunizationIG/ and changes regularly. See the Directory of published versions

Example Bundle: NGImm Example Immunization Bundle

Last updated: 2025-07-04 08:30:00+0100

Profile: Nigeria Immunization Bundle

Bundle NgImmExampleBundle of type collection


Entry 1 - fullUrl = urn:uuid:patient-001

Search:Mode = match

Resource Patient:

Last updated: 2025-07-04 08:30:00+0100

Profile: NG-Imm Patient

Zainab Abdulraheem Female, DoB: 2024-02-20 ( https://nimc.gov.ng#NIN98765432100)


Active:true
Contact DetailNo. 10, Igalamela Compound, Ankpa Ankpa KO
Language:Igbo
:
NG-Imm Client Age in Years0
NG-Imm Client Age in Weeks20
NG-Imm Client Age in Months5
NG-Imm Client's Pregnancy statusNot Pregnant
NG-Imm Weight at birth3.1

Request:

POST Patient

Response:

201 Created

Entry 2 - fullUrl = urn:uuid:imm-001

Search:Mode = include

Resource Immunization:

NG-Imm Digital Signature: Digitally signed by Nurse Joy (ID: PRAC001)

NG-Imm Session Type: Outreach

NG-Imm Vaccine Contraindications: Previous adverse reaction to similar vaccine

NG-Imm Immunization Contraindicated: false

identifier: https://nphcda.gov.ng/vaccine/ids/IMMUN123456

status: Completed

statusReason: Immunity

vaccineCode: BCG Vaccine

manufacturer: No display for Immunization.manufacturer (reference: ->Bundle: type = collection)

lotNumber: BCG2025A

expirationDate: 2025-12-31

patient: Bundle: type = collection

occurrence: 2025-06-20 09:30:00+0100

site: Left Arm

route: Intramuscular injection

doseQuantity: 0.05 mL

Performers

-FunctionActor
*Administering Providerurn:uuid:prac-001

Reactions

-DateReported
*2025-06-21true

ProtocolApplieds

-SeriesTargetDisease
*Childhood Routine ImmunizationTuberculosis

Request:

POST Immunization

Response:

201 Created

Entry 3 - fullUrl = urn:uuid:allergy-001

Search:Mode = include

Resource AllergyIntolerance:

NG-Imm Allergy Dose Number: 1

NG-Imm Dose Series: Childhood Routine Series

clinicalStatus: Active

verificationStatus: confirmed

type: Allergy

category: Medication

criticality: High Risk

code: Allergy to penicillin

patient: Bundle: type = collection

encounter: urn:uuid:encounter-001

onset: 2024-10-05

recordedDate: 2024-10-06

lastOccurrence: 2024-10-07

Reactions

-SubstanceManifestationDescriptionOnsetSeverity
*PenicillinNo display for AllergyIntolerance.reaction.manifestation (concept: Rash)Patient developed widespread rash within 12 hours of vaccination2024-10-05 22:00:00+0100Moderate

Request:

POST AllergyIntolerance

Response:

201 Created

Entry 4 - fullUrl = urn:uuid:sibling-001

Search:Mode = include

Resource RelatedPerson:

NG-Imm Sibling's health status: Healthy

patient: Bundle: type = collection

relationship: brother

name: Suleiman Ayodele Abdulraheem

gender: Male

birthDate: 2020-03-10

Request:

POST RelatedPerson

Response:

201 Created

Entry 5 - fullUrl = urn:uuid:org-001

Search:Mode = include

Resource Organization:

NG-Imm owner of health institution: Kogi State Primary Health Care Board

identifier: https://herfama.kogistate.gov.ng/KOHF-00123

active: true

type: General Hospital

name: Ankpa General Hospital

Contacts

-TelecomAddress
*+2348031122334Old Otukpo Road, Opp. Ankpa Market Ankpa KO

Request:

POST Organization

Response:

201 Created