Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

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.

NEIR FHIR IG Capability Statement

This CapabilityStatement outlines the conformance requirements for systems implementing the Nigerian Electronic Immunization Registry (NEIR) FHIR Implementation Guide. It specifies the supported FHIR resources, profiles, interactions, and system behaviors required to enable standardized capture, exchange, and retrieval of immunization-related data. The statement supports interoperability between health facilities, mobile vaccination units, outreach programs, and national systems to improve immunization tracking and service delivery across Nigeria’s digital health ecosystem.

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

IMMZ.C Register Client

A logical model representing a client being registered in the immunization system.

IMMZ.C1 Update Client History

A logical model for tracking client immunization history updates.

IMMZ.D Administer Vaccine

A logical model for capturing vaccine administration details

IMMZ.E Manage AEFI

A logical model for recording and managing AEFI treatment.

IMMZ.F Defaulter Tracing

A logical model for tracking immunization defaulters.

IMMZ.G Generate Report

Data elements for the IMMZ.G Report Generation Data Dictionary.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AllergyIntolerance Profile - NEIR

Defines constraints on the AllergyIntolerance resource for use in the FHIR Implementation Guide.

Bundle - Add Patient Creation

A transaction bundle containing patient registration data, including related person details and registration observations collected at the point of care.

Bundle - Administer Vaccine

Profile for a transaction Bundle used to capture vaccine administration details based on the AdministerVaccine logical model.

Bundle - Stock Management

Transaction bundle used to capture stock level details based on the Stock Management logical model.

Bundle - Update Client History

Transaction bundle containing clinical resources representing an update to a client's immunization and health status.

DetectedIssue Profile - NEIR

This profile constrains the DetectedIssue resource to represent immunization-related issues within the National Electronic Immunization Registry (NEIR), such as contraindications, missed doses, duplicate records, or adverse events, supporting safe and effective vaccination delivery.

Device/Material Usage Observation

Tracks usage and stock of devices and materials used in immunization delivery over a reporting period.

Encounter Profile - NEIR

Profiles the Encounter resource to capture immunization-related visits in NEIR, including outreach sessions, facility visits, and mobile unit interactions linked to service delivery.

IMMZ.C1 Update Client History

FHIR Profile representing a completed client immunization update form.

IMMZ.D Administer Vaccine Transaction

Profile for a transaction Bundle used to capture vaccine administration details based on the AdministerVaccine logical model.

Immunization Profile - NEIR

Nigerian Registry Profile for Immunization.

ImmunizationRecommendation Profile - NEIR

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

MeasureReport Profile - NEIR

This profile constrains the MeasureReport resource to support reporting immunization coverage and performance indicators within the National Electronic Immunization Registry (NEIR), specifically aligned to the IMMZ.H.Generate report use case.

NEIRLocation Profile

Defines constraints on the FHIR Location resource to represent immunization service delivery points in the Nigerian Electronic Immunization Registry (NEIR), including health facilities, outreach sites, and mobile vaccination units. Captures key attributes like type, address, coordinates, and managing organization to support accurate tracking and reporting.

NEIRPractitioner Profile

Constrains the Practitioner resource to represent healthcare workers and vaccinators involved in delivering immunization services recorded in NEIR.

Observations - NEIR Registration

A composite Observation profile capturing state of health, underlying conditions, and HIV status during NEIR client registration.

Observations - NEIR Update Client History

A composite Observation profile capturing primary series, state, comments, HIV Status, reporting officer name,designation and signature

Organization Profile - NEIR

Defines the Organization resource for representing entities within NEIR such as health facilities, administrative bodies, and implementing partners involved in immunization service delivery.

Patient Profile - NEIR

Constrains the Patient resource to represent individuals enrolled in NEIR for immunization, capturing identifiers, demographics, birth and parental information relevant to vaccination services.

Provenance Profile - NEIR Provenance Profile

Constrains the Provenance resource to capture metadata about the origin, authorship, and context of immunization-related data within the NEIR system.

Related Person Profile - NEIR

Defines the RelatedPerson resource to represent parents, guardians, or caregivers associated with a child or dependent receiving immunization services in NEIR.

ServiceRequest Profile - NEIR DefaulterTracingRequest

Profiles the ServiceRequest resource to represent planned or requested immunization services within NEIR, supporting scheduling, referral, and outreach planning.

Vaccine Stock Observation

Tracks vaccine or diluent stock balances, receipts, and usage over a reporting period.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Device Material ValueSet

ValueSet for Device Material for the stock management workflow

IMMZ.C Value Set for Registering Clients

Value Set for Registering clients for IMMZ.C

IMMZ.C.DE31 ValueSet for State of Health of Mother's Other Children

ValueSet for state of health of mother's other children for IMMZ.C.DE31

IMMZ.C.DE37 ValueSet for HIV Status

ValueSet for HIV Status for IMMZ.C.DE37

IMMZ.C.DE41 ValueSet for Pregnancy Status

ValueSet for Pregnancy Status for IMMZ.C.DE41

IMMZ.C.DE5 ValueSet for Gender

ValueSet for gender for IMMZ.C.DE5

IMMZ.D.DE10 ValueSet for Vaccine Type

ValueSet for Vaccince Type for IMMZ.D.DE10

IMMZ.D.DE11 ValueSet for Contraindications

ValueSet for Contradictions for IMMZ.D.DE11

IMMZ.D.DE2 ValueSet for Facility Type

ValueSet for Facility type for IMMZ.D.DE2

IMMZ.D.DE21 ValueSet for Site Administered

ValueSet for Site Administered for IMMZ.D.DE21

IMMZ.D.DE27 ValueSet for Route of Administration

ValueSet for Route of Administration for IMMZ.D.DE27

IMMZ.D.DE6 ValueSet for Session Type

ValueSet for Session Type for IMMZ.D.DE6

IMMZ.E.DE.5 ValueSet for AEFI Treatment

ValueSet containing severity levels for IMMZ.E.DE.5

IMMZ.F.DE2 ValueSet for Client Relationship

ValueSet for client relationship for IMMZ.F.DE2

IMMZ.G.DE2 ValueSet for Client Sex

ValueSet for Client Sex for IMMZ.G.DE2

IMMZ.G.DE6 ValueSet for missed immunization

ValueSet for Missed Immunization for IMMZ.G.DE6

IMMZ.H.DE10 ValueSet for Report Indicator Code

ValueSet for Report Indicator Code

IMMZ.H.DE10 ValueSet for Report Indicator Code

ValueSet for Report Type

IMMZ.H.DE2 ValueSet for Report Status

ValueSet for Report Status

IMMZ.H.DE22 ValueSet for Report Discarded types

ValueSet for Report Discared types

IMMZ.H.DE34 ValueSet for Report Improvement Indicator

ValueSet for Report Improvement Indicator

IMMZ.H.DE42 ValueSet for Disaggregation Group

ValueSet for Disaggregation Group options used in immunization report disaggregation (e.g., by sex, region, age group, etc.)

IMMZ.I ValueSet for Stock Management

ValueSet for Stock Management IMMZ.I

IMMZI - ValueSet for Vacine Stock Levels

ValueSet displaying the vaccines and diluents in the stock management workflow

NEIR ValueSet for Allowed Allergy-related Substances

ValueSet for Allowed Allergy-related Substances from NEIR

NEIR ValueSet for Clinical Status

ValueSet for Clinical Status from NEIR

NEIR ValueSet for Facility Types

ValueSet for facility types from NEIR

NEIR ValueSet for Immunization Encounter

ValueSet for immunization Encounter from NEIR

NEIR ValueSet for Immunization Not Done

ValueSet for Immunization Not Done from NEIR

NEIR ValueSet for Service Request

ValueSet for Service Request from NEIR

NEIR ValueSet for Session Types

ValueSet for session types from NEIR

NEIR ValueSet for Verification Status

ValueSet for Verification status from NEIR

NEIR ValueSet for vaccine codes

ValueSet for vaccine codes from NEIR

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Device and Material Codes
IMMZ.C CodeSystem for Register Client

CodeSystem for IMMZ.C Client Register Data Elements

IMMZ.C.DE31 CodeSystem for State of Health of Mothers' Other Children

CodeSystem for IMMZ.C.DE31 State of Health of Mothers' Other Children

IMMZ.C.DE37 CodeSystem for HIV Status

CodeSystems for IMMZ.C.DE37 HIV Status

IMMZ.C1 CodeSystem for Update Client History

CodeSystem for IMMZ.C1 Update Client History Data Elements

IMMZ.D CodeSystem for Administer Vaccine

CodeSystem for IMMZ.D Administer Vaccine Data Elements

IMMZ.E CodeSystem for Manage and Report AEFI

CodeSystem for IMMZ.E Manage and Report AEFI Data Elements

IMMZ.F.DE2 CodeSystem for Client Relationship

CodeSystem for IMMZ.F.DE2 Client Relationship

IMMZ.G CodeSystem for Defaulter Tracking

CodeSystem for IMMZ.G Defaulter Tracking Data Elements

IMMZ.G CodeSystem for Generate Report

CodeSystem for IMMZ.G Generate Report Data Elements

IMMZ.G.DE2 CodeSystem for Client Sex

CodeSytsem for IMMZ.G.DE2 Client Sex

IMMZ.G.DE6 CodeSystem for Missed Vaccines

CodeSystem for IMMZ.G.DE6 Missed Vaccine

IMMZ.I CodeSystem for Stock Management

CodeSystem for IMMZ.I Stock Management Data Elements

IMMZ.I Vaccine Stock Codes

Vaccine Stock Codes

IMMZ.Z CodeSystem for Vaccine Library

CodeSystem for IMMZ.Z Vaccine Library Data Elements

NEIR CodeSystem for Allergy-related Substance

CodeSystem for Allery-related Substance from NEIR

NEIR CodeSystem for Clinical Status

CodeSystem for NEIR clinical status

NEIR CodeSystem for Facility Type

CodeSystem for NEIR Facility Type

NEIR CodeSystem for Immunization Not Done

CodeSystem for NEIR Immunization Not Done

NEIR CodeSystem for Service Requests

CodeSystem for Service Requests

NEIR CodeSystem for Session Type

CodeSystem for NEIR Session Type

NEIR CodeSystem for Verification Status

CodeSystem for NEIR Verification Status

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example - 2ml Syringes Stock

Example record of 2ml Syringes stock tracking.

Example - AD Syringes Stock

Example record of Auto-Disable Syringes stock tracking.

Example - BCG Diluent Stock

Example record of BCG diluent stock tracking.

Example - BCG Syringes Stock

Example record of BCG Syringes stock tracking.

Example - BCG Vaccine Stock

Example record of BCG vaccine stock tracking.

Example - Cold Boxes Stock

Example record of Cold Boxes stock tracking.

Example - HPV Vaccine Stock

Example record of HPV vaccine stock tracking.

Example - Hep B Vaccine Stock

Example record of Hepatitis B vaccine stock tracking.

Example - IPV Vaccine Stock

Example record of IPV vaccine stock tracking.

Example - Ice Packs Stock

Example record of Ice Packs stock tracking.

Example - MUAC Stripes Stock

Example record of MUAC Stripes stock tracking.

Example - Measles Diluent Stock

Example record of Measles diluent stock tracking.

Example - Measles Vaccine Stock

Example record of Measles vaccine stock tracking.

Example - Men A Diluent Stock

Example record of Men A diluent stock tracking.

Example - Men A Vaccine Stock

Example record of Men A vaccine stock tracking.

Example - OPV Vaccine Stock

Example record of OPV vaccine stock tracking.

Example - PCV Vaccine Stock

Example record of PCV vaccine stock tracking.

Example - PENTA Vaccine Stock

Example record of PENTA vaccine stock tracking.

Example - Rotavirus Vaccine Stock

Example record of Rotavirus vaccine stock tracking.

Example - Stock Management Bundle

An example transaction bundle capturing immunization and vaccine stock levels.

Example - Td Vaccine Stock

Example record of Td vaccine stock tracking.

Example - Vaccine Carrier Stock

Example record of Vaccine Carriers stock tracking.

Example - Vaccine Fridges Stock

Example record of Vaccine Fridges stock tracking.

Example - Yellow Fever Diluent Stock

Example record of Yellow Fever diluent stock tracking.

Example - Yellow Fever Vaccine Stock

Example record of Yellow Fever vaccine stock tracking.

Example Immunization Reccomendation

Example of an Immunization Reccomendation

Example Response for Defaulter Tracking Form

Example of a questionnaireResponse for IMMZ.G Defaulter Tracking

Example Response for a Client Registration Form

Example of a Response for IMMZ.C Register Client

Example Response of an AEFI Treatment Form

Example Response for IMMZ.E Manage and Report AEFI

Example Response of an Update Client History Form

Example of a Response for IMMZ.C1 Update Client History

Example Routine Immunization Report

Example of a routine Immunization Report at a Facility

Example Vaccine Administration Record

Example of a vaccine administration record in a facility

Example of a Defaulter Tracing Record

Example of a defaulter tracking record.

Example of a DetectedIssue

Example of a contraindication issue recorded in the NEIR system

Example of a Patient Creation Bundle

Example of a patient creation transaction bundle

Example of a Service Request

Example of a service request

Example of a Vaccine Administration Bundle

Example of a Vaccine Administration transaction bundle

Example of a Vaccine Stock Report

Example of a Vaccine Stock Report of a Facility

Example of an AEFI Case Report

Example of an AEFI Case Report of a Facility

Example of an Alllergy Intolerance

Example of an allergy intolerance: Allergy to penicillin

Example of an Update Client History Bundle

Example of updating client history transaction bundle

Example of an update client history observation

Example of an update client history observation

Example of client Registration observation

Example of a client registration observation

Jane Doe

Example of a Practitioner: Jane Doe

John Doe

Example of a Patient: John Doe.

John Rocker Doe

Example of Mother's other child: John Rocker Doe

Kofar Dukayuwa PHC

Example of an immunization service location: Kofar Dukayuwa PHC

Lagos Clinic

Example of a Clinic: Lagos Clinic

Measles Vaccine

Example of an Immunization: Measles Vaccine

Outreach Immunization Visit

Example of an Encounter: Outreach Immunization Visit