DHIN 2025Connectathon FHIR IG
0.2.0 - ci-build
DHIN 2025Connectathon FHIR IG
0.2.0 - ci-build
DHIN 2025Connectathon FHIR IG, published by DHIN. This guide is not an authorized publication; it is the continuous build for version 0.2.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
| Official URL: https://sandbox.dhin-hie.org/ig/CapabilityStatement/dhin-sandbox-capability-statement | Version: 0.2.0 | |||
| Active as of 2025-11-12 | Computable Name: DHINSandboxCapabilityStatement | |||
Capability statement for the DHIN (Digital Health Interoperability Network) Sandbox FHIR Server. This server supports the Nigeria FHIR Implementation Guide profiles and is used for Connectathon testing and development purposes.
Base URL: https://sandbox.dhin-hie.org
FHIR Version: R4 (4.0.1)
Supported Formats: JSON, XML
This capability statement describes the resources, operations, and search parameters supported by the DHIN Sandbox Server for the 2025 Connectathon tracks:
Raw OpenAPI-Swagger Definition file | Download
json, xmlapplication/json-patch+json, application/xml-patch+xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverDHIN Sandbox Server supporting Nigeria FHIR IG profiles for Connectathon 2025
OAuth, SMART-on-FHIROAuth 2.0 and SMART-on-FHIR authentication may be required for protected endpoints. Sandbox environment can use relaxed authentication for testing purposes. All data transmission uses HTTPS/TLS 1.2+.
transactioninteraction described as follows:Support for transaction bundles (batch create/update)
batchinteraction described as follows:Support for batch bundles (independent operations)
search-systeminteraction described as follows:Support for system-wide searches
history-systeminteraction described as follows:Support for system-wide history
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $validate | Validate a resource against its profile |
| SHALL | $meta | Access resource metadata |
| SHALL | $patient-everything | Retrieve all resources for a patient |
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincluderead, create, update, delete, search-type.Patient resource conforming to NgPatient profile. Supports all Connectathon tracks requiring patient demographics.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Search by patient identifier (phone, NIN, etc.) |
| SHALL | name | string | Search by patient name (family or given) |
| SHALL | birthdate | date | Search by date of birth |
| SHALL | gender | token | Search by gender |
| SHALL | address-state | string | Search by state code |
read, create, update, search-type.Practitioner resource conforming to NgPractitioner profile. Supports MDCN registry verification (Track 6).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Search by MDCN number or other identifier |
| SHALL | name | string | Search by practitioner name |
| SHALL | active | token | Search by active status |
NG Provider Organization
NG Insurer Organization
NG Pharmacy Organization
read, create, update, search-type.Organization resource with specialized profiles for providers, insurers, and pharmacies. Supports Claims (Track 1), ePharmacy (Track 2), and PCN Registry (Track 7).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Search by facility registry ID, PCN number, etc. |
| SHALL | name | string | Search by organization name |
| SHALL | type | token | Search by organization type (prov, pay, pharm) |
| SHALL | address-state | string | Search by state code |
| SHALL | active | token | Search by active status |
read, create, update, search-type.Coverage resource for insurance/HMO policies. Supports Claims & Insurance track (Track 1).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | beneficiary | reference | Search by patient reference |
| SHALL | payor | reference | Search by insurance organization |
| SHALL | status | token | Search by coverage status |
read, create, search-type.Eligibility check request resource. Supports Claims & Insurance track (Track 1 - Eligibility).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | status | token | Search by request status |
read, create, search-type.Eligibility check response resource. Supports Claims & Insurance track (Track 1 - Eligibility).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | request | reference | Search by eligibility request reference |
read, create, update, search-type.Claim resource for pre-authorization and claims submission. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | use | token | Search by claim use (preauthorization, claim) |
| SHALL | status | token | Search by claim status |
| SHALL | provider | reference | Search by provider organization |
read, create, search-type.Claim response resource for adjudication decisions. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | request | reference | Search by claim reference |
read, create, update, search-type.Invoice resource for billing and payment tracking. Supports Claims & Insurance and ePharmacy tracks (Track 1 & 2).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | subject | reference | Search by patient reference |
| SHALL | status | token | Search by invoice status |
| SHALL | date | date | Search by invoice date |
read, create, search-type.Explanation of Benefit resource for detailed claim adjudication. Supports Claims & Insurance track (Track 1 - Billing).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | claim | reference | Search by claim reference |
read, create, update, search-type.Medication resource for drug definitions. Supports ePharmacy track (Track 2).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Search by medication code (ATC, RxNorm) |
| SHALL | status | token | Search by medication status |
read, create, update, search-type.MedicationRequest resource for prescriptions. Supports ePharmacy track (Track 2 - Prescription).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | medication | reference | Search by medication reference |
| SHALL | status | token | Search by prescription status |
| SHALL | authoredon | date | Search by prescription date |
read, create, update, search-type.MedicationDispense resource for pharmacy dispensing records. Supports ePharmacy track (Track 2 - Dispense).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | prescription | reference | Search by prescription reference |
| SHALL | status | token | Search by dispense status |
| SHALL | whenhandedover | date | Search by handover date |
read, create, update, search-type.ServiceRequest resource for referrals and service orders. Supports MNCH Referral track (Track 3).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | status | token | Search by request status |
| SHALL | intent | token | Search by request intent |
read, create, update, search-type.Task resource for workflow management (referrals, lab orders). Supports MNCH Referral and Medical Devices tracks (Track 3 & 5).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference (Task.for) |
| SHALL | status | token | Search by task status |
| SHALL | owner | reference | Search by task owner |
| SHALL | focus | reference | Search by task focus (ServiceRequest, etc.) |
read, create, search-type.Communication resource for clinical messages and follow-ups. Supports MNCH Referral track (Track 3).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | subject | reference | Search by communication subject (usually patient) |
| SHALL | sent | date | Search by send date |
read, create, update, search-type.Immunization resource for vaccine administration records. Supports Immunization track (Track 4).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | date | date | Search by vaccination date |
| SHALL | vaccine-code | token | Search by vaccine type |
| SHALL | lot-number | string | Search by vaccine lot number |
| SHALL | status | token | Search by immunization status |
read, create, update, search-type.ImmunizationRecommendation resource for vaccine scheduling. Supports Immunization track (Track 4 - Scheduler).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | date | date | Search by recommendation date |
| SHALL | vaccine-type | token | Search by vaccine type |
read, create, update, search-type.Appointment resource for scheduling immunizations and clinic visits. Supports Immunization track (Track 4 - Scheduler).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | date | date | Search by appointment date |
| SHALL | status | token | Search by appointment status |
| SHALL | service-type | token | Search by service type (e.g., immunization) |
read, create, update, search-type.Location resource for health facilities and service delivery points. Supports multiple tracks including Immunization and MNCH Referral (Track 3 & 4).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | name | string | Search by location name |
| SHALL | address-state | string | Search by state |
| SHALL | type | token | Search by location type |
| SHALL | status | token | Search by location status |
read, create, update, search-type.Observation resource for clinical findings, vital signs, lab results, and AEFI. Supports Immunization (AEFI) and Medical Devices tracks (Track 4 & 5).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | code | token | Search by observation code (LOINC, SNOMED) |
| SHALL | category | token | Search by observation category |
| SHALL | date | date | Search by observation date |
| SHALL | device | reference | Search by device reference |
| SHALL | status | token | Search by observation status |
read, create, update, search-type.Device resource for medical devices (wearables, lab equipment). Supports Medical Devices track (Track 5).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference (device owner) |
| SHALL | type | token | Search by device type |
| SHALL | manufacturer | string | Search by manufacturer |
| SHALL | model | string | Search by model number |
| SHALL | status | token | Search by device status |
read, create, update, search-type.Consent resource for data sharing and research consent (ISO/TR 17975). Supports Standards Adoption and Privacy tracks (Track 8 & 9).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | status | token | Search by consent status |
| SHALL | scope | token | Search by consent scope |
| SHALL | date | date | Search by consent date |
read, create, update, search-type.RelatedPerson resource for family members and caregivers. Supports Privacy use case (Track 9) with pseudonymization.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | name | string | Search by related person name |
| SHALL | relationship | token | Search by relationship type |
read, create, update, search-type.Encounter resource for clinical visits and episodes of care. Supports multiple tracks requiring visit context.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search by patient reference |
| SHALL | date | date | Search by encounter date |
| SHALL | type | token | Search by encounter type |
| SHALL | status | token | Search by encounter status |
read, create, search-type.Provenance resource for audit trails and data origin tracking. Supports Privacy and device data tracks (Track 5, 8, 9).
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | target | reference | Search by target resource |
| SHALL | recorded | date | Search by recorded timestamp |
| SHALL | agent | reference | Search by agent (who/what performed the activity) |
1-NGClaim 1 Eligibility Check Bundle (Request/Response)
1-NGClaim 2 Pre-Authorization Bundle (Request or Response)
1-NGClaim 3 Submission and Billing Bundle (Request/Response)
2-NGePharmacy 1 Prescription Bundle (Request/Response)
2-NGePharmacy 2 Medication Dispense Bundle
3-NGReferral MNCH Transaction Bundle
4-NG AEFI Report Bundle
4-NG Immunization SMART Scheduler Bundle
5-NG Device Data Bundle (Chemistry Analyzer / Wearable)
Bundle resource for transaction and collection bundles across all tracks. Supports batch operations and structured data exchange.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | type | token | Search by bundle type (transaction, collection) |
| SHALL | timestamp | date | Search by bundle timestamp |