DHIN 2025Connectathon FHIR IG
0.1.0 - draft
DHIN 2025Connectathon FHIR IG, published by DHIN. 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/Nigeria-FHIR-Community/2025Connectathon/ 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.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| 1-NG HMO-Hospital Transaction Bundle |
Transaction bundle that MUST contains a Coverage and a Claim entry for HMO submissions. |
| 2-NG MNCH Referral Initiation Bundle |
Bundle profile for a simple referral initiation from a PHC to a secondary hospital. Constrains a collection Bundle to include exactly one Patient, one requesting Organization (PHC), one receiving Organization (Secondary Hospital), and one ServiceRequest. Designed to align with 'bundle-referral-initiation' example. |
| 3-NG Immunization Client Registration Bundle |
A simple collection Bundle for registering an immunization client. Requires exactly one NgPatient and optionally includes the registering NgOrganization. Designed for low-QA use in DHIN 2025 Connectathon. |
| 4-NG Device Task Execution Bundle (Chemistry Analyzer) |
Collection bundle for chemistry analyzer task execution. Includes Patient, performing Organization, Device, optional DeviceMetric/DeviceRequest, one Task, and ≥1 Observation (lab results). Kept lightweight to reduce QA. |
| 5-NG ePharmacy Prescription Bundle |
Transaction bundle carrying a prescription from prescriber to pharmacy. Must include 1 Patient, 1 Practitioner, 1 Organization (prescriber org), ≥1 Medication, and ≥1 MedicationRequest. Designed to keep QA noise low for DHIN 2025 Connectathon. |
| NG CarePlan |
A simple CarePlan profile for the 2025 Connectathon. |
| NG Claim |
A profile representing submitted claims from providers to payers. |
| NG Claim Coverage |
A profile capturing a patient's insurance coverage details. |
| NG ClaimResponse |
A profile representing responses from insurers regarding submitted claims. |
| NG Condition |
Minimal Condition profile for the 2025 Connectathon. |
| NG Device |
Minimal Device profile for the 2025 Connectathon (medical devices communications). |
| NG DeviceMetric |
Minimal DeviceMetric profile for the 2025 Connectathon (medical device observations). |
| NG DeviceRequest |
Minimal DeviceRequest profile for the 2025 Connectathon. |
| NG Encounter |
A profile for encounters in the Nigerian used to health visits and related healthcare interactions. |
| NG ExplanationOfBenefit |
A profile detailing adjudicated claim results. |
| NG Goal |
Minimal Goal profile for the 2025 Connectathon. |
| NG HealthcareService |
Minimal HealthcareService profile for the 2025 Connectathon (service directory/referrals). |
| NG Immunization |
Nigerian Profile for Immunization resource. |
| NG Lightweight Provenance |
Minimal provenance profile for DHIN 2025 Connectathon. Captures who created/updated a resource, when, and (optionally) which activity was performed. |
| NG Location |
A profile for immunization service locations, including health facilities, outreach sites, and mobile vaccination units. |
| NG Measure |
A profile on the Measure resource used to define indicators within prescription program. |
| NG MeasureReport |
Nigeria Measure Report Profile |
| NG Medication |
A Medication profile with some core elements for demonstration purposes. |
| NG MedicationDispense |
Minimal MedicationDispense profile for the 2025 Connectathon (ePharmacy). |
| NG MedicationRequest |
A MedicationRequest profile with some of core elements for demonstration purposes. |
| NG Observations |
A composite Observation profile capturing state of health, underlying conditions, HIV status, ages in weeks/months/years during client registration. |
| NG Organization |
An organization profile representing healthcare facilities responsible for health services or other types of organizations. |
| NG Patient |
Nigeria 2025 Connectathon Patient Profile |
| NG Practitioner |
Profile for a Nigerian Practitioner |
| NG PractitionerRole |
Defines the role(s) of a Nigerian healthcare practitioner context. Links a Practitioner to an Organization, specifies their role. |
| NG Procedure |
Minimal Procedure profile for the 2025 Connectathon. |
| NG RelatedPerson |
Sibling or parent of the sick person. |
| NG ServiceRequest |
Minimal ServiceRequest profile for the 2025 Connectathon (referrals and orders). |
| NG Task |
Minimal Task profile for the 2025 Connectathon (referrals, claims, pharmacy, devices). |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| NG Administrative Wards |
Captures the administrative ward within a geographic address |
| NG Immunization Contraindicated |
Indicates whether the immunization was contraindicated |
| NG Next Dose Date |
The recommended due date for the next vaccine dose in the schedule. |
| NG Owner of Facility |
An extension to define the owner of the health institution |
| NG 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 Weight at birth |
Weight of the Immunization Client at birth |
These define sets of codes used by systems conforming to this implementation guide.
| NG CarePlan Activity VS |
ValueSet for CarePlan.activity.detail.code (demo). |
| NG CarePlan Category VS |
ValueSet for CarePlan.category (demo). |
| NG Client HIV Status VS |
Client HIV Status |
| NG Client Identifier VS |
This ValueSet defines list of options for uniquely Identifting a Client |
| NG Clinical Status VS |
The outcome of the reaction |
| NG Clinical Status VS |
The outcome of the reaction |
| NG Clinical Status VS |
The outcome of the reaction |
| NG DeviceMetric Category VS |
ValueSet for DeviceMetric.category. |
| NG Gender or Sex VS |
A subset of the administrative gender codes including only 'male' and 'female' |
| NG HealthFacility Type VS |
Classification of Nigerian health facilities |
| NG LGAs VS |
The administrative Local Government Areas where a person or a facility is. |
| NG Location Owner |
The owner of an Health Facility location |
| NG Relationships VS |
list of persons related to a patient, but who is not a direct target of care. |
| NG Session Type VS |
Type of session for immunization. Could be in a fixed facility, outreach or mobile. |
| NG Sibling Health Status VS |
This CodeSystem defines the health of the client's sibling |
| NG Sibling Relationships VS |
A sub list from relationship list with only two options brother and sister. |
| NG States VS |
The state where a person or a facility is. |
| NG 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 Vaccine ICD ValueSet |
All ICD11 vaccine codes (DE1–DE29). |
| NG Vaccine Local ValueSet |
All local vaccine codes (DE1–DE29). |
| NG Vaccine SNOMED ValueSet |
All SNOMED vaccine codes (DE1–DE29). |
| NG 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 Administrative Wards CS |
This CodeSystem defines ward codes and names mapped to their respective Local Government Areas (LGAs) in Nigeria. |
| NG Adverse Event 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 CarePlan Activity Codes |
Activities for CarePlan.activity.detail.code aligned to DHIN 2025 Connectathon tracks. |
| NG CarePlan Category Codes |
Categories for CarePlan.category aligned to DHIN 2025 Connectathon tracks. |
| NG Client HIV status CS |
This CodeSystem IMMZ.C.DE31 defines list of options for HIV status of a Client |
| NG Client Identifier CS |
This CodeSystem defines list of options for uniquely Identifting a Client |
| NG Client Pregnancy Status CS |
This CodeSystem defines list of options for Pregnancy status of a Client |
| NG DeviceMetric Category Codes |
Local mirror of DeviceMetric.category. Consider using 'http://terminology.hl7.org/CodeSystem/metric-category' in production. |
| NG Facility Identifier CS |
This CodeSystem IMMZ.A.DE1 defines placeholder codes to manage Facility identifiers in Nigeria. |
| NG 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 Health Status CS |
This CodeSystem IMMZ.C.DE30 defines the health of the client's sibling |
| 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. |
| NG Immunization Session types CS |
Type of session for immunization Could be in a fixed facility, outreach or mobile. |
| NG LGAs in Nigeria CS |
This CodeSystem defines LGA codes and names mapped to their respective States in Nigeria. |
| NG Languages in Nigeria CS |
This CodeSystem defines codes for major languages spoken across Nigeria. |
| NG Location Owner CS |
This CodeSystem defines Immunization Location Owner. |
| NG Practitioner Identifier CS |
This CodeSystem IMMZ.C.DE14 defines placeholder codes to manage physician identifiers in Nigeria. |
| NG Relationships CS |
This CodeSystem defines list of persons related to a patient, but who is not a direct target of care |
| NG States in Nigeria CS |
This CodeSystem defines ward codes and names mapped to their respective States in Nigeria. |
| NG 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. |
These define transformations to convert between codes by systems conforming with this implementation guide.
| NG Local Vaccine Codes → ICD-11 |
Maps local dose-labelled DE codes to ICD-11 vaccine concepts (antigen/product level). |
| NG 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.
| Client Registration Bundle (Immunization) |
Simple collection bundle registering a child for immunization at a PHC. |
| Example Asokoro District Hospital |
Public secondary hospital in FCT (AMAC). |
| Example Asokoro OPD |
Outpatient department at Asokoro District Hospital. |
| Example Gurdi Outreach Site |
Periodic immunization outreach post in Abaji Area Council, FCT. |
| Example Gwagwalada Immunization Room |
RI room at Gwagwalada Model PHC. |
| Example Gwagwalada Model PHC |
Public PHC facility in FCT Gwagwalada Area Council. |
| Example Kano Central Hospital Pharmacy |
Pharmacy department serving outpatient dispensing; Kano Municipal. |
| Example Kano Central Pharmacy Counter |
Dispensing counter at Kano Central Hospital Pharmacy. |
| Example MedicationRequest (Insulin 100 IU/mL) |
Order for Insulin 100 IU/mL vial, ongoing therapy. |
| Example NG CarePlan |
Minimal example of a CarePlan using NgCarePlan. |
| Example NG Claim (ePharmacy) |
Pharmacy claim submitted by Kano Central Hospital Pharmacy for NgPatient-002. |
| Example NG ClaimResponse (Partial with Copay) |
Partial approval; copay applied per plan rules. |
| Example NG Condition |
Essential hypertension on problem list. |
| Example NG Device |
A minimal example Device. |
| Example NG DeviceMetric |
A minimal DeviceMetric example. |
| Example NG DeviceRequest |
A minimal DeviceRequest for a pulse oximeter for home monitoring. |
| Example NG Goal |
Patient goal to control systolic BP within 6 weeks. |
| Example NG HealthcareService |
Minimal healthcare service (ANC clinic). |
| Example NG Procedure |
Cesarean section for obstructed labor. |
| Example NG Task |
Minimal Task to coordinate a referral based on a ServiceRequest. |
| Example Ng ClaimResponse (Approved) |
Full approval of pharmacy claim for NgPatient-002. |
| Example Ng Coverage (NHIA Dependent Coverage) |
Active NHIA dependent coverage for NgPatient-003; subscriber is NgPatient-002. |
| Example Ng Coverage (NHIA Self Coverage) |
Active NHIA coverage for NgPatient-002. |
| Example Ng EOB (Approved) |
EOB for fully approved pharmacy claim. |
| Example Ng EOB (Partial with Copay) |
EOB documenting partial approval and member copay. |
| Example Ng Encounter (Immunization Visit) |
RI session at Gwagwalada Model PHC. |
| Example Ng Encounter (MNCH ANC) |
Antenatal care visit at Asokoro District Hospital. |
| Example Ng Encounter (ePharmacy Dispense) |
Outpatient pharmacy encounter at Kano Central Hospital Pharmacy. |
| Example Ng Immunization (Pentavalent 1) |
Pentavalent 1 administered to NgPatient-003 at Gwagwalada PHC. |
| Example Ng Immunization (Rotavirus 1) |
Rotavirus 1 administered orally to NgPatient-003. |
| Example Ng Immunization (Tetanus Diphtheria) |
Td dose administered to NgPatient-001 at Asokoro District Hospital. |
| Example Ng Measure (Claim Approval Rate) |
Proportion of submitted claims that are approved. |
| Example Ng Measure (Counseling Documented) |
Proportion of dispensations with counseling documented. |
| Example Ng Measure (Dispense within 48h) |
Proportion of ePrescriptions dispensed within 48 hours of prescription. |
| Example Ng MeasureReport (ClaimApprovalRate) |
Summary report of approved claims over all submitted claims. |
| Example Ng MeasureReport (CounselingDocumented) |
Summary report of dispensing events with counseling documented. |
| Example Ng MeasureReport (DispenseWithin48h) |
Summary report of ePrescriptions dispensed within 48 hours. |
| Example Ng Medication (Amoxicillin 500 mg Capsule) |
Amoxicillin hard gelatin capsule, 500 mg. |
| Example Ng Medication (Insulin 100 IU/mL Injection) |
Short-acting insulin solution for injection. |
| Example Ng Medication (Paracetamol Oral Suspension 250 mg/5 mL) |
Paracetamol (Acetaminophen) oral suspension, pediatric. |
| Example Ng MedicationDispense (Amoxicillin 500 mg CAPS x30) |
Completed outpatient dispensing. |
| Example Ng MedicationDispense (Insulin 100 IU/mL, 10 mL) |
Completed insulin dispensing. |
| Example Ng MedicationDispense (Paracetamol 250 mg/5 mL, 100 mL) |
Completed pediatric dispensing. |
| Example Ng MedicationRequest (Amoxicillin) |
Order for Amoxicillin 500 mg capsule x30. |
| Example Ng MedicationRequest (Paracetamol Suspension) |
Order for Paracetamol 250 mg/5 mL, 100 mL. |
| Example Ng Observation (Childhood Immunization) |
Age in months and birth weight for NgPatient-003. |
| Example Ng Observation (ePharmacy & Claims) |
HIV status with age in years for NgPatient-002. |
| Example Ng Patient (Immunization) |
Male child presenting for routine vaccination; FCT AMAC. |
| Example Ng Patient (MNCH Referral) |
Adult female referred for ANC; Lagos State, Ikeja LGA. |
| Example Ng Patient (ePharmacy & Claims) |
Adult male on chronic meds; insured with NHIA; Kano Municipal LGA. |
| Example Ng Practitioner (MNCH) |
Obstetrician supporting ANC referrals. |
| Example Ng Practitioner (Medical Devices) |
CHEW operating connected vitals devices. |
| Example Ng Practitioner (ePharmacy & Claims) |
Pharmacist dispensing and submitting claims. |
| Example Ng PractitionerRole (MNCH Referral) |
Obstetrician role for ANC referrals. |
| Example Ng PractitionerRole (Medical Devices) |
CHEW operating connected vitals devices. |
| Example Ng PractitionerRole (ePharmacy & Claims) |
Pharmacist dispensing medications and processing claims. |
| Example Ng RelatedPerson (Brother) |
Older brother of NgPatient-003. |
| Example Ng RelatedPerson (Brother) |
Brother of NgPatient-001. |
| Example Ng RelatedPerson (Sister) |
Younger sister of NgPatient-003. |
| Example Ng ServiceRequest (Fasting Blood Glucose) |
Lab order for diabetes follow-up. |
| Example Ng ServiceRequest (Obstetric Ultrasound) |
Ultrasound order for pregnant client. |
| Example Observation (MNCH Referral) |
Pregnancy & HIV status with age in years for NgPatient-001. |
| Provenance for MNCH Referral Creation |
Provenance indicating that a practitioner authored the MNCH referral request. |
| Referral Initiation from PHC to Secondary Hospital |
PHC raises a ServiceRequest to refer a maternal health patient to a secondary hospital. |