NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG
0.7.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.7.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| NG-Imm Client CapabilityStatement |
This CapabilityStatement describes the expected behavior of an offline-first client (e.g., mobile Immunization POC health facility system), FHIR-capable systems implementing Nigeria’s Immunization Implementation Guide. |
| NG-Imm Server CapabilityStatement |
This CapabilityStatement describes the expected behaviour of an Immunization server managed by NPHCDA that other Immunization clients or server connect to or share information for care fulfillment. |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
| NG-Imm-A RegisterFacility |
IMMZ.A - A logical model representing a health facility being registered in the immunization system. |
| NG-Imm-C5 RegisterClient |
IMMZ.C5 - A logical model representing a client being registered in the immunization system. |
| NG-Imm-C6 UpdateClientHistory |
IMMZ.C6 - A logical model for tracking client immunization history updates. |
| NG-Imm-D AdministerVaccine |
IMMZ.D - A logical model for capturing vaccine administration details |
| NG-Imm-E Manage & ReportAEFI |
IMMZ.E - A logical model for recording and managing AEFI treatment. |
| NG-Imm-G DefaulterTracking |
IMMZ.G - A logical model for tracking immunization defaulters. |
| NG-Imm-H GenerateReport |
IMMZ.H - Data elements for the IMMZ.G Report Generation Data Dictionary. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| IMMZ.A Bundle Register Facility |
Transaction Bundle used to register a facility and its core context: Organization (owner), Location (service point), Practitioner (staff), and PractitionerRole (linking staff to org/location and services). |
| IMMZ.C.5 Bundle Client Registration |
Transaction Bundle to register an immunization client and related context. |
| IMMZ.C6 Bundle Update Client |
Transaction Bundle used to submit client update content such as an Encounter, registration/update Observation, and one or more Immunizations — along with the acting Practitioner and the managing Organization. The Patient is assumed to already exist on the server and is referenced directly. |
| IMMZ.E Bundle ManageReportAEFI |
Transaction Bundle for reporting and managing an Adverse Event Following Immunization (AEFI). Includes the encounter where the event was assessed, the clinical observation(s) describing the event, and an AllergyIntolerance record capturing the reaction and severity. |
| IMMZ.H Bundle GenerateReport |
Transaction Bundle for generating and submitting immunization-related reports. Carries the Measure definition (indicator), the MeasureReport (calculated results), and contextual information about the reporting Organization and Practitioner. |
| NG-Imm AllergyIntolerance |
Nigeria Immunization Allergy Intolerance Profile |
| NG-Imm ClientRegistUpdate-Observations |
A composite Observation profile capturing state of health, underlying conditions, HIV status, ages in weeks/months/years during client registration. |
| NG-Imm Encounter |
A profile for encounters in the Nigerian Immunization guide, used to document immunization visits and related healthcare interactions. |
| NG-Imm Immunization |
Nigerian Profile for Immunization resource. |
| NG-Imm Location |
A profile for immunization service locations, including health facilities, outreach sites, and mobile vaccination units. |
| NG-Imm Measure |
A profile on the Measure resource used to define immunization indicators within Nigeria’s routine immunization program. |
| NG-Imm MeasureReport |
Nigeria Immunization Measure Report Profile |
| NG-Imm Organization |
An organization profile representing healthcare facilities responsible for immunization services or other types of organizations. |
| NG-Imm Patient |
Nigeria Immunization Patient Profile |
| NG-Imm Practitioner |
Profile for a Nigerian Practitioner |
| NG-Imm PractitionerRole |
Defines the role(s) of a Nigerian healthcare practitioner in the immunization context. Links a Practitioner to an Organization, specifies their role, contact details, and periods of service, with constraints to support the Nigeria Immunization IG. |
| NG-Imm Provenance |
A Provenance profile tailored for Nigeria’s Immunization workflows (using FHIR R4.0.1). Captures the origin, responsible party, and context for the creation, modification, or exchange of immunization-related records, including Immunization, AEFI, Defaulter Tracing, and related patient data. |
| NG-Imm RelatedPerson |
Sibling that represents the mother’s other children as RelatedPersons. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| NG-Imm Administrative Wards |
Captures the administrative ward within a geographic address |
| NG-Imm Allergy Dose Number |
Reference immunization dose number for this AllergyIntolerance. |
| NG-Imm Client's HIV status |
The HIV status (positive, negative, or unknown) of the Immunization Client |
| NG-Imm Client's Pregnancy status |
The Pregnancy status (pregnant or not-pregnant) of the Immunization Client, including the period during which the status was asserted. |
| NG-Imm Dose Series |
Dose series number from the referenced Immunization.protocolApplied.doseNumber. |
| NG-Imm Encounter Signature |
A digital or electronic signature capturing who signed, when, type, and signature data. Extension to capture the practitioner’s digital signature on an Encounter resource. |
| NG-Imm Immunization Contraindicated |
Indicates whether the immunization was contraindicated |
| NG-Imm Next Dose Date |
The recommended due date for the next vaccine dose in the schedule. |
| NG-Imm Sibling's health status |
The health status of the Client’s sibling |
| NG-Imm Vaccine Contraindications |
Indicates specific situations in which it is not recommended to administer certain vaccines (e.g severe AEFI, History of Anaphylactic reactions, Symptomatic HIV infection) |
| NG-Imm owner of health institution |
An extension to define the owner of the health institution |
These define sets of codes used by systems conforming to this implementation guide.
| NG Gender or Sex VS |
A subset of the administrative gender codes including only ‘male’ and ‘female’ |
| NG IMMZ.D.DE4 Vaccine ICD ValueSet |
All ICD11 vaccine codes (DE1–DE29). |
| NG IMMZ.D.DE4 Vaccine Local ValueSet |
All local vaccine codes (DE1–DE29). |
| NG IMMZ.D.DE4 Vaccine SNOMED ValueSet |
All SNOMED vaccine codes (DE1–DE29). |
| NG-Imm Client HIV Status VS |
Client HIV Status |
| NG-Imm Clinical Status VS |
The outcome of the reaction |
| NG-Imm Clinical Status VS |
The outcome of the reaction |
| NG-Imm Clinical Status VS |
The outcome of the reaction |
| NG-Imm HealthFacility Type VS |
Classification of Nigerian health facilities |
| NG-Imm LGAs VS |
The administrative Local Government Areas where a person or a facility is. |
| NG-Imm Location Owner |
The owner of an Immunization location |
| NG-Imm MMZ.C.DE1 Client Identifier VS |
This ValueSet defines list of options for uniquely Identifting a Client |
| NG-Imm Relationships VS |
list of persons related to a patient, but who is not a direct target of care. |
| NG-Imm Session Type VS |
Type of session for immunization. Could be in a fixed facility, outreach or mobile. |
| NG-Imm Sibling Health Status VS |
This CodeSystem defines the health of the client’s sibling |
| NG-Imm Sibling Relationships VS |
A sub list from relationship list with only two options brother and sister. |
| NG-Imm States VS |
The state where a person or a facility is. |
| NG-Imm Vaccine Contraindication VS |
A set of standardized codes used to represent clinical conditions, diagnoses, or circumstances that serve as contraindications to the administration of one or more vaccines. |
| NG-Imm Wards VS |
The administrative Ward (within an LGA) where a person or a facility is. |
These define new code systems used by systems conforming to this implementation guide.
| IMMZ.A.DE1 Facility Identifier CS |
This CodeSystem IMMZ.A.DE1 defines placeholder codes to manage Facility identifiers in Nigeria. |
| IMMZ.C.DE1 Client Identifier CS |
This CodeSystem defines list of options for uniquely Identifting a Client |
| IMMZ.C.DE14 Administrative Wards CS |
This CodeSystem IMMZ.C.DE14 defines ward codes and names mapped to their respective Local Government Areas (LGAs) in Nigeria. |
| IMMZ.C.DE20 - Relationships CS |
This CodeSystem IMMZ.C.DE20 defines list of persons related to a patient, but who is not a direct target of care |
| IMMZ.C.DE24 LGAs in Nigeria CS |
This CodeSystem defines LGA codes and names mapped to their respective States in Nigeria. |
| IMMZ.C.DE25 States in Nigeria CS |
This CodeSystem defines ward codes and names mapped to their respective States in Nigeria. |
| IMMZ.C.DE30 Sibling Health Status CS |
This CodeSystem IMMZ.C.DE30 defines the health of the client’s sibling |
| IMMZ.C.DE31 - Client HIV status CS |
This CodeSystem IMMZ.C.DE31 defines list of options for HIV status of a Client |
| IMMZ.C.DE32 Client Pregnancy status CS |
This CodeSystem defines list of options for Pregnancy status of a Client |
| IMMZ.D.DE14 Practitioner Identifier CS |
This CodeSystem IMMZ.C.DE14 defines placeholder codes to manage physician identifiers in Nigeria. |
| IMMZ.D.DE3 Facility Type CS |
A standardized classification system IMMZ.D.DE3 used to describe the type or level of health facility within a healthcare delivery system, based on the scope of services provided, staffing, infrastructure, and administrative role. |
| IMMZ.D.DE3 Immunization Session types CS |
Type of session for immunization IMMZ.D.DE3. Could be in a fixed facility, outreach or mobile. |
| IMMZ.D.DE3-2 Location Owner CS |
This CodeSystem defines Immunization Location Owner. |
| IMMZ.D.DE6 Vaccine contraindications CS |
A set of standardized codes used to represent clinical conditions, diagnoses, or circumstances that serve as contraindications to the administration of one or more vaccines. |
| IMMZ.E.DE6 Adverse Event Clinical Status CS |
A classification system that represents the current clinical status of an individual who experienced an Adverse Event Following Immunization (AEFI), based on medical observation, investigation, or follow-up assessment. |
| NG Age Component Codes |
This CodeSystem defines list of age options for a Client |
| NG IMMZ.D.DE4 Vaccine Local Codes (Dose-labelled) |
Locally defined vaccine codes used for data capture and UI labels. Doses are local; external systems map at antigen/product level. |
These define transformations to convert between data structures used by systems conforming to this implementation guide.
| StructureMap: AdministerVaccine to FHIR Resources |
Map logical AdministerVaccine to NgImmImmunization, NgImmLocation, NgImmPractitioner, and NgImmEncounter profiles |
| StructureMap: DefaulterTracking to Immunization and related profiles |
Map logical DefaulterTracking model to NgImmImmunization, NgImmPatient, NgImmEncounter, and NgImmPractitioner profiles |
| StructureMap: ManageAEFI to AllergyIntolerance, Encounter, Practitioner, and Patient |
Maps ManageAEFI logical model to NgImmAllergyIntolerance, NgImmEncounter, NgImmPractitioner, and NgImmPatient profiles |
| StructureMap: RegisterClientModel to NgImmPatient |
Map logical RegisterClientModel to NgImmPatient profile |
| StructureMap: RegisterFacilityModel to NgImmOrganization and NgImmLocation |
Map logical RegisterFacilityModel to NgImmOrganization and NgImmLocation profiles |
| StructureMap: ReportGeneration to MeasureReport and Related Profiles |
Map ReportGeneration logical model to NgImmMeasureReport, NgImmMeasure, and NgImmPractitioner |
These define transformations to convert between codes by systems conforming with this implementation guide.
| Local Vaccine Codes → ICD-11 |
Maps local dose-labelled DE codes to ICD-11 vaccine concepts (antigen/product level). |
| Local Vaccine Codes → SNOMED CT |
Maps local dose-labelled DE codes to SNOMED CT vaccine concepts (antigen/product level). |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Example NG-Imm Allergy Intolerance (Yellow Fever Vaccine, Severe) |
An example of a severe allergic reaction (anaphylaxis) following Yellow Fever vaccination. |
| Example NG-Imm Allergy Intolerance -001 |
An example of allergy or intolerance to a vaccine per the NG-Imm AllergyIntolerance profile. |
| Example NG-Imm Allergy Intolerance 001 |
An example of allergy/adverse reaction following measles vaccine administration. |
| Example NG-Imm Encounter |
An immunization visit encounter per the NG-Imm Encounter profile. |
| Example NG-Imm Encounter (Mobile) |
A mobile team immunization encounter per the NG-Imm Encounter profile. |
| Example NG-Imm Encounter (Outreach) |
An outreach immunization encounter per the NG-Imm Encounter profile. |
| Example NG-Imm Immunization (Complete) |
A complete example of an immunization record per the NgImmImmunization profile. |
| Example NG-Imm Immunization (Simple) |
A simple immunization record example with minimal fields populated. |
| Example NG-Imm Immunization -001 |
An example Immunization resource per the NG-Imm Immunization profile. |
| Example NG-Imm Location |
An immunization service location (Primary Health Centre) in Lagos, Nigeria. |
| Example NG-Imm Location (Mobile Team) |
A mobile immunization team location operating in Benue State, Nigeria. |
| Example NG-Imm Location (Outreach Site) |
An outreach immunization service location (temporary site in a school) in Kano, Nigeria. |
| Example NG-Imm Organization (Lagos PHC) |
A healthcare facility providing routine immunization services in Lagos State. |
| Example NG-Imm Organization (NGO Outreach Post) |
A temporary outreach post supported by an international NGO providing immunization services. |
| Example NG-Imm Organization (Private Hospital) |
A private hospital in Abuja offering immunization services. |
| Example NG-Imm Patient -002 |
A partially populated patient per NgImmPatient, with only MRN and phone identifiers. |
| Example NG-Imm Patient 001 |
An example patient resource fully populated according to the NG-Imm Patient profile. |
| Example NG-Imm Patient-003 |
A sample immunization patient from Lagos State. |
| Example NG-Imm Practitioner |
A Nigerian healthcare practitioner serving as a Routine Immunization Officer. |
| Example NG-Imm Practitioner (CHEW, Kano) |
A Community Health Extension Worker providing RI services in Kano State. |
| Example NG-Imm Practitioner (Midwife, Enugu) |
A licensed midwife responsible for maternal and child health services, including immunization, at a public hospital in Enugu. |
| Example NG-Imm PractitionerRole |
A Routine Immunization Officer role linking a practitioner to a primary health centre in Lagos. |
| Example NG-Imm PractitionerRole (AEFI Surveillance Officer) |
An AEFI Surveillance Officer role linking a CHEW to a public health facility in Kano State. |
| Example NG-Imm PractitionerRole (Midwife, Enugu) |
A Midwife role linking a licensed midwife to a public teaching hospital in Enugu State, providing maternal and child health immunization services. |
| Example NG-Imm Provenance |
Provenance for creation of an Immunization record during an encounter at a Lagos PHC. |
| Example NG-Imm Provenance Update |
Provenance for updating a Patient and AllergyIntolerance record following an adverse reaction to Measles vaccine at Kano General Hospital. |
| Example NG-Imm Registration Observation |
An example observation recorded when a client is registered, capturing health and status data. |
| Example NG-Imm Registration Update Observation (Subsequent Visit) |
Observation recorded during a later visit to update client status and age-related details. |
| Example RegisterClient (Average) |
Representative example of a client registered in the immunization system. |
| Example RegisterFacility (Minimal) |
Minimal required fields for NG-Imm-A RegisterFacility logical model. |
| Example UpdateClientHistory (Average) |
Tracks an individual’s immunization history updates for routine antigens and supplements. |
| Minimal NG-Imm Provenance Example |
Minimal provenance capturing creation of an immunization record. |
| NG-Imm Example AEFI case report |
An example case of Adverse Event Following Immunization Report |
| NG-Imm Example Stock report |
An example Stock management report |
| NG-Imm Routine Immunization Report - Facility A |
A routine monthly immunization report summarizing vaccine stock and usage for Facility A. |
| Sibling RelatedPerson Example |
Example of a RelatedPerson resource representing a sibling (brother) of the immunization client. |
| Sibling RelatedPerson Example - Infant Brother with Malnutrition |
Example of a RelatedPerson resource representing a younger infant sibling (brother) of the immunization client, showing malnutrition status. |
| Sibling RelatedPerson Example - Sister with Asthma |
Example of a RelatedPerson resource representing a sibling (sister) of the immunization client with a chronic condition (asthma). |