NPHCDA Immunization FHIR IG
1.0.0 - ci-build
NPHCDA Immunization FHIR IG
1.0.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 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
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 defines the expected behavior of client systems that interact with NG-IMM FHIR servers in Nigeria’s immunization ecosystem. Clients must support standard RESTful interactions with NG-IMM-compliant FHIR APIs and use appropriate operations to submit, export, and validate structured data.
They are also expected to initiate transformation of logical models (e.g. RegisterClientModel, AdministerVaccine) into formal FHIR resources using Use of HTTP Methods:
|
| NG-Imm Server CapabilityStatement |
This CapabilityStatement describes the expected behavior of FHIR servers implementing Nigeria’s Immunization Implementation Guide (NG-IMM). It includes full RESTful support for key profiles ( Use of HTTP Methods:
Provenance:Clients MUST include a |
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.
| NG-Imm AllergyIntolerance |
Nigeria Immunization Allergy Intolerance Profile |
| 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 RelatedPerson |
Sibling that represents the mother’s other children as RelatedPersons. |
| Nigeria Immunization Bundle |
FHIR Bundle profile for grouping Nigeria Immunization resources including Patient, Immunization, AllergyIntolerance, RelatedPerson, and Organization. Supports request/response/search metadata for interoperability. |
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 Age in Months |
Age of the Immunization Client recorded in months |
| NG-Imm Client Age in Weeks |
Age of the Immunization Client recorded in weeks |
| NG-Imm Client Age in Years |
Age of the Immunization Client recorded in years |
| 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 |
| NG-Imm Digital Signature |
A digital or electronic signature capturing who signed, when, type, and signature data. |
| NG-Imm Dose Series |
Dose series number from the referenced Immunization.protocolApplied.doseNumber. |
| 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 Session Type |
Type of session for immunization (e.g., fixed-site clinic, outreach session, campaign site). |
| 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 Weight at birth |
Weight of the Immunization Client at birth |
| 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-Imm Client HIV Status VS |
Client HIV Status |
| NG-Imm Client Preganancy Status VS |
Client Pregnancy Status |
| NG-Imm Clinical Status VS |
The outcome of the reaction |
| NG-Imm Gender or Sex VS |
Subset of HL7 administrative-gender limited to ‘male’ and ‘female’. |
| 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 Languages VS |
The Patient’s preferred language for communication. |
| NG-Imm Location Owner |
The owner of an Immunization location |
| 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 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 VaccineLibrary VS |
A curated list of vaccines recognized under Nigeria’s national immunization program |
| 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.
| NG-Imm Administrative Wards CS |
This CodeSystem defines ward codes and names mapped to their respective Local Government Areas (LGAs) in Nigeria. |
| NG-Imm 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-Imm Client HIV status CS |
This CodeSystem defines list of options for HIV status of a Client |
| NG-Imm Client Pregnancy status CS |
This CodeSystem defines list of options for Pregnancy status of a Client |
| NG-Imm Facility Type CS |
A standardized classification system 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. |
| NG-Imm Gender CS |
The administrative gender of a person. |
| NG-Imm Immunization Session types CS |
Type of session for immunization. Could be in a fixed facility, outreach or mobile. |
| NG-Imm LGAs in Nigeria CS |
This CodeSystem defines LGA codes and names mapped to their respective States in Nigeria. |
| NG-Imm Location Owner CS |
This CodeSystem defines Immunization Location Owner. |
| NG-Imm Relationships CS |
This CodeSystem defines list of persons related to a patient, but who is not a direct target of care |
| NG-Imm Sibling Health Status CS |
This CodeSystem defines the health of the client’s sibling |
| NG-Imm States in Nigeria CS |
This CodeSystem defines ward codes and names mapped to their respective States in Nigeria. |
| NG-Imm Stock Management Data Elements CS |
CodeSystem for Stock Management Data Elements |
| NG-Imm Vaccine Library with SNOMED CT codes |
CodeSystem for IMMZ.Z Vaccine Library Data Elements supported by this IG using SNOMED CT codes |
| NG-Imm 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. |
| NG‑Imm Languages in Nigeria CS |
This CodeSystem defines codes for major languages spoken across Nigeria. |
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 are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| NG-Imm Example AEFI case report |
An example case of Adverse Event Following Immunization Report |
| NG-Imm Example AllergyIntolerance |
A fictional example of a an allergy resulting from Immunization. |
| NG-Imm Example BCG Immunization |
An example of a completed BCG immunization event |
| NG-Imm Example Full Immunization Patient |
A Nigeria Immunization Patient instance with all required and optional fields populated |
| NG-Imm Example MeasureReport Monthly Immunization Coverage |
An example of a summary MeasureReport generated for BCG coverage at a facility |
| NG-Imm Example Organization |
Represents a health facility in Kogi State providing immunization services for use in Bundle |
| NG-Imm Example Organization |
A fictional example of a typical organization. |
| NG-Imm Example Patient |
A sample patient conforming to the Nigeria Immunization Patient profile |
| NG-Imm Example Patient with Ward data |
A fictional example of a patient with information on administrative ward |
| NG-Imm Example Practitioner |
An example of a Nigerian Routine Immunization Officer |
| NG-Imm Example Sibling |
An example of a mother’s other child as a RelatedPerson resource. |
| NG-Imm Example Sibling - Mother's Other Child |
An example of a mother’s other child as a RelatedPerson resource. |
| 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. |
| NG-Imm Scheduled Pentavalent Immunization Not Done Due to Fever |
An example where immunization was not done due to contraindication (fever) |
| NGImm Example AllergyIntolerance |
Example allergy or intolerance record using use in Bundle example AllergyIntolerance profile |
| NGImm Example Immunization Bundle |
Example bundle containing Patient, Immunization, AllergyIntolerance, RelatedPerson, and Organization with request, response, and search metadata. |
| NGImm Example Immunization Record |
Example Immunization record using NG-Imm Immunization profile with 90% data populated |
| NGImm Example Location |
An example immunization service location. |
| NGImm Example Patient used in Bundle |
Sample patient for use with Bunlde and resident in Kogi State |
| NGImm Example Sibling used in bundle |
Represents a sibling (mother’s other child) related to the immunization client for use in Bundle |