FHIR IG analytics| Package | ng.gov.digitalhealth.fhir-ig |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-dhin-sandbox-capability-statement.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/digitalhealth-gov-ng/Nigeria-Core/CapabilityStatement-dhin-sandbox-capability-statement.html |
| URL | https://fhir-ig.digitalhealth.gov.ng/CapabilityStatement/dhin-sandbox-capability-statement |
| Version | 0.0.0 |
| Status | active |
| Date | 2025-11-12 |
| Name | DHINSandboxCapabilityStatement |
| Title | NDHI Sandbox Server Capability Statement |
| Description | Capability statement for the NDHI Sandbox FHIR Server. This server supports the Nigeria FHIR Implementation Guide profiles and is used for Connectathon testing and development purposes. **Base URL**: https://fhir-ig.digitalhealth.gov.ng **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: 1. Claims & Insurance (Eligibility, Pre-Authorization, Billing) 2. ePharmacy (Prescription & Dispense) 3. MNCH Referral 4. Immunization (AEFI & Scheduling) 5. Medical Devices (Wearable & Lab Data) 6. MDCN Registry (Practitioner Verification) 7. PCN Registry (Pharmacy Verification) 8. Standards Adoption (Consent & Pseudonymization) 9. Privacy Use Case |
| Kind | instance |
No resources found
| OperationDefinition | ||
| hl7.fhir.uv.api-incubator#current | Resource-meta | Access a list of profiles, tags, and security labels |
| StructureDefinition | ||
| ng.gov.digitalhealth.fhir-ig#current | ng-aefi-report-bundle | 4-NG AEFI Report Bundle |
| ng.gov.digitalhealth.fhir-ig#current | ng-appointment | NG Appointment |
| ng.gov.digitalhealth.fhir-ig#current | ng-claim | NG Claim |
| ng.gov.digitalhealth.fhir-ig#current | ng-claim-response | NG ClaimResponse |
| ng.gov.digitalhealth.fhir-ig#current | ng-claim-submission-bundle | 1-NGClaim 3 Submission and Billing Bundle (Request/Response) |
| ng.gov.digitalhealth.fhir-ig#current | ng-communication | NG Communication |
| ng.gov.digitalhealth.fhir-ig#current | ng-consent | NG Consent |
| ng.gov.digitalhealth.fhir-ig#current | ng-coverage | NG Claim Coverage |
| ng.gov.digitalhealth.fhir-ig#current | ng-coverage-eligibility-request | NG Claim Coverage Eligibility Request |
| ng.gov.digitalhealth.fhir-ig#current | ng-coverage-eligibility-response | NG Claim Coverage Eligibility Response |
| ng.gov.digitalhealth.fhir-ig#current | ng-device | NG Device |
| ng.gov.digitalhealth.fhir-ig#current | ng-device-data-bundle | 5-NG Device Data Bundle (Chemistry Analyzer / Wearable) |
| ng.gov.digitalhealth.fhir-ig#current | ng-eligibility-check-bundle | 1-NGClaim 1 Eligibility Check Bundle (Request/Response) |
| ng.gov.digitalhealth.fhir-ig#current | ng-encounter | NG Encounter |
| ng.gov.digitalhealth.fhir-ig#current | ng-explanation-of-benefit | NG ExplanationOfBenefit |
| ng.gov.digitalhealth.fhir-ig#current | ng-imm-smart-scheduler-bundle | 4-NG Immunization SMART Scheduler Bundle |
| ng.gov.digitalhealth.fhir-ig#current | ng-immunization | NG Immunization |
| ng.gov.digitalhealth.fhir-ig#current | ng-immunization-recommendation | NG ImmunizationRecommendation |
| ng.gov.digitalhealth.fhir-ig#current | ng-insurer-organization | NG Insurer Organization |
| ng.gov.digitalhealth.fhir-ig#current | ng-invoice | NG Invoice |
| ng.gov.digitalhealth.fhir-ig#current | ng-location | NG Location |
| ng.gov.digitalhealth.fhir-ig#current | ng-medication | NG Medication |
| ng.gov.digitalhealth.fhir-ig#current | ng-medication-dispense | NG MedicationDispense |
| ng.gov.digitalhealth.fhir-ig#current | ng-medication-dispense-bundle | 2-NGePharmacy 2 Medication Dispense Bundle |
| ng.gov.digitalhealth.fhir-ig#current | ng-medication-request | NG MedicationRequest |
| ng.gov.digitalhealth.fhir-ig#current | ng-mnch-referral-bundle | 3-NGReferral MNCH Transaction Bundle |
| ng.gov.digitalhealth.fhir-ig#current | ng-observation | NG Observations |
| ng.gov.digitalhealth.fhir-ig#current | ng-organization | NG Organization |
| ng.gov.digitalhealth.fhir-ig#current | ng-patient | NG Patient |
| ng.gov.digitalhealth.fhir-ig#current | ng-pharmacy-organization | NG Pharmacy Organization |
| ng.gov.digitalhealth.fhir-ig#current | ng-practitioner | NG Practitioner |
| ng.gov.digitalhealth.fhir-ig#current | ng-preauthorization-bundle | 1-NGClaim 2 Pre-Authorization Bundle (Request or Response) |
| ng.gov.digitalhealth.fhir-ig#current | ng-prescription-bundle | 2-NGePharmacy 1 Prescription Bundle (Request/Response) |
| ng.gov.digitalhealth.fhir-ig#current | ng-provenance | NG Lightweight Provenance |
| ng.gov.digitalhealth.fhir-ig#current | ng-provider-organization | NG Provider Organization |
| ng.gov.digitalhealth.fhir-ig#current | ng-related-person | NG RelatedPerson |
| ng.gov.digitalhealth.fhir-ig#current | ng-service-request | NG ServiceRequest |
| ng.gov.digitalhealth.fhir-ig#current | ng-task | NG Task |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement dhin-sandbox-capability-statement
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.
serverNDHI Sandbox Server supporting Nigeria FHIR IG profiles
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 |
{
"resourceType": "CapabilityStatement",
"id": "dhin-sandbox-capability-statement",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://fhir-ig.digitalhealth.gov.ng/CapabilityStatement/dhin-sandbox-capability-statement",
"version": "0.0.0",
"name": "DHINSandboxCapabilityStatement",
"title": "NDHI Sandbox Server Capability Statement",
"status": "active",
"experimental": false,
"date": "2025-11-12",
"publisher": "NDHI",
"contact": [
{
"name": "NDHI",
"telecom": [
{
"system": "url",
"value": "https://digitalhealth.gov.ng"
},
{
"system": "email",
"value": "emeka2015@gmail.com"
}
]
},
{
"name": "Nigeria Digital in Health Initiative.",
"telecom": [
{
"system": "email",
"value": "lekeojewale@gmail.com",
"use": "work"
}
]
},
{
"name": "Nigeria Digital in Health Initiative.",
"telecom": [
{
"system": "email",
"value": "emeka2015@gmail.com",
"use": "work"
}
]
}
],
"description": "Capability statement for the NDHI Sandbox FHIR Server.\nThis server supports the Nigeria FHIR Implementation Guide profiles and is used for \nConnectathon testing and development purposes.\n\n**Base URL**: https://fhir-ig.digitalhealth.gov.ng\n\n**FHIR Version**: R4 (4.0.1)\n\n**Supported Formats**: JSON, XML\n\nThis capability statement describes the resources, operations, and search parameters \nsupported by the DHIN Sandbox Server for the 2025 Connectathon tracks:\n1. Claims & Insurance (Eligibility, Pre-Authorization, Billing)\n2. ePharmacy (Prescription & Dispense)\n3. MNCH Referral\n4. Immunization (AEFI & Scheduling)\n5. Medical Devices (Wearable & Lab Data)\n6. MDCN Registry (Practitioner Verification)\n7. PCN Registry (Pharmacy Verification)\n8. Standards Adoption (Consent & Pseudonymization)\n9. Privacy Use Case",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "NG",
"display": "Nigeria"
}
]
}
],
"kind": "instance",
"implementation": {
"description": "NDHI Sandbox FHIR Server",
"url": "https://fhir-ig.digitalhealth.gov.ng"
},
"fhirVersion": "4.0.1",
"format": [
"json",
"xml"
],
"patchFormat": [
"application/json-patch+json",
"application/xml-patch+xml"
],
"implementationGuide": [
"https://fhir-ig.digitalhealth.gov.ng"
],
"rest": [
{
"mode": "server",
"documentation": "NDHI Sandbox Server supporting Nigeria FHIR IG profiles",
"security": {
"cors": true,
"service": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "OAuth",
"display": "OAuth"
}
]
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "SMART-on-FHIR",
"display": "SMART-on-FHIR"
}
]
}
],
"description": "OAuth 2.0 and SMART-on-FHIR authentication may be required for protected endpoints.\nSandbox environment can use relaxed authentication for testing purposes.\nAll data transmission uses HTTPS/TLS 1.2+."
},
"resource": [
{
"type": "Patient",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-patient",
"documentation": "Patient resource conforming to NgPatient profile.\nSupports all Connectathon tracks requiring patient demographics.",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"readHistory": true,
"updateCreate": true,
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"searchParam": [
{
"name": "identifier",
"type": "token",
"documentation": "Search by patient identifier (phone, NIN, etc.)"
},
{
"name": "name",
"type": "string",
"documentation": "Search by patient name (family or given)"
},
{
"name": "birthdate",
"type": "date",
"documentation": "Search by date of birth"
},
{
"name": "gender",
"type": "token",
"documentation": "Search by gender"
},
{
"name": "address-state",
"type": "string",
"documentation": "Search by state code"
}
]
},
{
"type": "Practitioner",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-practitioner",
"documentation": "Practitioner resource conforming to NgPractitioner profile.\nSupports MDCN registry verification (Track 6).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"readHistory": true,
"updateCreate": true,
"conditionalCreate": true,
"conditionalUpdate": true,
"searchParam": [
{
"name": "identifier",
"type": "token",
"documentation": "Search by MDCN number or other identifier"
},
{
"name": "name",
"type": "string",
"documentation": "Search by practitioner name"
},
{
"name": "active",
"type": "token",
"documentation": "Search by active status"
}
]
},
{
"type": "Organization",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-organization",
"supportedProfile": [
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-provider-organization",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-insurer-organization",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-pharmacy-organization"
],
"documentation": "Organization resource with specialized profiles for providers, insurers, and pharmacies.\nSupports Claims (Track 1), ePharmacy (Track 2), and PCN Registry (Track 7).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"readHistory": true,
"updateCreate": true,
"conditionalCreate": true,
"conditionalUpdate": true,
"searchParam": [
{
"name": "identifier",
"type": "token",
"documentation": "Search by facility registry ID, PCN number, etc."
},
{
"name": "name",
"type": "string",
"documentation": "Search by organization name"
},
{
"name": "type",
"type": "token",
"documentation": "Search by organization type (prov, pay, pharm)"
},
{
"name": "address-state",
"type": "string",
"documentation": "Search by state code"
},
{
"name": "active",
"type": "token",
"documentation": "Search by active status"
}
]
},
{
"type": "Coverage",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-coverage",
"documentation": "Coverage resource for insurance/HMO policies.\nSupports Claims & Insurance track (Track 1).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "beneficiary",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "payor",
"type": "reference",
"documentation": "Search by insurance organization"
},
{
"name": "status",
"type": "token",
"documentation": "Search by coverage status"
}
]
},
{
"type": "CoverageEligibilityRequest",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-coverage-eligibility-request",
"documentation": "Eligibility check request resource.\nSupports Claims & Insurance track (Track 1 - Eligibility).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by request status"
}
]
},
{
"type": "CoverageEligibilityResponse",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-coverage-eligibility-response",
"documentation": "Eligibility check response resource.\nSupports Claims & Insurance track (Track 1 - Eligibility).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "request",
"type": "reference",
"documentation": "Search by eligibility request reference"
}
]
},
{
"type": "Claim",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-claim",
"documentation": "Claim resource for pre-authorization and claims submission.\nSupports Claims & Insurance track (Track 1 - Pre-Auth & Billing).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "use",
"type": "token",
"documentation": "Search by claim use (preauthorization, claim)"
},
{
"name": "status",
"type": "token",
"documentation": "Search by claim status"
},
{
"name": "provider",
"type": "reference",
"documentation": "Search by provider organization"
}
]
},
{
"type": "ClaimResponse",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-claim-response",
"documentation": "Claim response resource for adjudication decisions.\nSupports Claims & Insurance track (Track 1 - Pre-Auth & Billing).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "request",
"type": "reference",
"documentation": "Search by claim reference"
}
]
},
{
"type": "Invoice",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-invoice",
"documentation": "Invoice resource for billing and payment tracking.\nSupports Claims & Insurance and ePharmacy tracks (Track 1 & 2).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "subject",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by invoice status"
},
{
"name": "date",
"type": "date",
"documentation": "Search by invoice date"
}
]
},
{
"type": "ExplanationOfBenefit",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-explanation-of-benefit",
"documentation": "Explanation of Benefit resource for detailed claim adjudication.\nSupports Claims & Insurance track (Track 1 - Billing).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "claim",
"type": "reference",
"documentation": "Search by claim reference"
}
]
},
{
"type": "Medication",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-medication",
"documentation": "Medication resource for drug definitions.\nSupports ePharmacy track (Track 2).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "code",
"type": "token",
"documentation": "Search by medication code (ATC, RxNorm)"
},
{
"name": "status",
"type": "token",
"documentation": "Search by medication status"
}
]
},
{
"type": "MedicationRequest",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-medication-request",
"documentation": "MedicationRequest resource for prescriptions.\nSupports ePharmacy track (Track 2 - Prescription).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "medication",
"type": "reference",
"documentation": "Search by medication reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by prescription status"
},
{
"name": "authoredon",
"type": "date",
"documentation": "Search by prescription date"
}
]
},
{
"type": "MedicationDispense",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-medication-dispense",
"documentation": "MedicationDispense resource for pharmacy dispensing records.\nSupports ePharmacy track (Track 2 - Dispense).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "prescription",
"type": "reference",
"documentation": "Search by prescription reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by dispense status"
},
{
"name": "whenhandedover",
"type": "date",
"documentation": "Search by handover date"
}
]
},
{
"type": "ServiceRequest",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-service-request",
"documentation": "ServiceRequest resource for referrals and service orders.\nSupports MNCH Referral track (Track 3).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by request status"
},
{
"name": "intent",
"type": "token",
"documentation": "Search by request intent"
}
]
},
{
"type": "Task",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-task",
"documentation": "Task resource for workflow management (referrals, lab orders).\nSupports MNCH Referral and Medical Devices tracks (Track 3 & 5).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference (Task.for)"
},
{
"name": "status",
"type": "token",
"documentation": "Search by task status"
},
{
"name": "owner",
"type": "reference",
"documentation": "Search by task owner"
},
{
"name": "focus",
"type": "reference",
"documentation": "Search by task focus (ServiceRequest, etc.)"
}
]
},
{
"type": "Communication",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-communication",
"documentation": "Communication resource for clinical messages and follow-ups.\nSupports MNCH Referral track (Track 3).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "subject",
"type": "reference",
"documentation": "Search by communication subject (usually patient)"
},
{
"name": "sent",
"type": "date",
"documentation": "Search by send date"
}
]
},
{
"type": "Immunization",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-immunization",
"documentation": "Immunization resource for vaccine administration records.\nSupports Immunization track (Track 4).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "date",
"type": "date",
"documentation": "Search by vaccination date"
},
{
"name": "vaccine-code",
"type": "token",
"documentation": "Search by vaccine type"
},
{
"name": "lot-number",
"type": "string",
"documentation": "Search by vaccine lot number"
},
{
"name": "status",
"type": "token",
"documentation": "Search by immunization status"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-immunization-recommendation",
"documentation": "ImmunizationRecommendation resource for vaccine scheduling.\nSupports Immunization track (Track 4 - Scheduler).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "date",
"type": "date",
"documentation": "Search by recommendation date"
},
{
"name": "vaccine-type",
"type": "token",
"documentation": "Search by vaccine type"
}
]
},
{
"type": "Appointment",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-appointment",
"documentation": "Appointment resource for scheduling immunizations and clinic visits.\nSupports Immunization track (Track 4 - Scheduler).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"conditionalUpdate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "date",
"type": "date",
"documentation": "Search by appointment date"
},
{
"name": "status",
"type": "token",
"documentation": "Search by appointment status"
},
{
"name": "service-type",
"type": "token",
"documentation": "Search by service type (e.g., immunization)"
}
]
},
{
"type": "Location",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-location",
"documentation": "Location resource for health facilities and service delivery points.\nSupports multiple tracks including Immunization and MNCH Referral (Track 3 & 4).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "name",
"type": "string",
"documentation": "Search by location name"
},
{
"name": "address-state",
"type": "string",
"documentation": "Search by state"
},
{
"name": "type",
"type": "token",
"documentation": "Search by location type"
},
{
"name": "status",
"type": "token",
"documentation": "Search by location status"
}
]
},
{
"type": "Observation",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-observation",
"documentation": "Observation resource for clinical findings, vital signs, lab results, and AEFI.\nSupports Immunization (AEFI) and Medical Devices tracks (Track 4 & 5).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "code",
"type": "token",
"documentation": "Search by observation code (LOINC, SNOMED)"
},
{
"name": "category",
"type": "token",
"documentation": "Search by observation category"
},
{
"name": "date",
"type": "date",
"documentation": "Search by observation date"
},
{
"name": "device",
"type": "reference",
"documentation": "Search by device reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by observation status"
}
]
},
{
"type": "Device",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-device",
"documentation": "Device resource for medical devices (wearables, lab equipment).\nSupports Medical Devices track (Track 5).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference (device owner)"
},
{
"name": "type",
"type": "token",
"documentation": "Search by device type"
},
{
"name": "manufacturer",
"type": "string",
"documentation": "Search by manufacturer"
},
{
"name": "model",
"type": "string",
"documentation": "Search by model number"
},
{
"name": "status",
"type": "token",
"documentation": "Search by device status"
}
]
},
{
"type": "Consent",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-consent",
"documentation": "Consent resource for data sharing and research consent (ISO/TR 17975).\nSupports Standards Adoption and Privacy tracks (Track 8 & 9).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "status",
"type": "token",
"documentation": "Search by consent status"
},
{
"name": "scope",
"type": "token",
"documentation": "Search by consent scope"
},
{
"name": "date",
"type": "date",
"documentation": "Search by consent date"
}
]
},
{
"type": "RelatedPerson",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-related-person",
"documentation": "RelatedPerson resource for family members and caregivers.\nSupports Privacy use case (Track 9) with pseudonymization.",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "name",
"type": "string",
"documentation": "Search by related person name"
},
{
"name": "relationship",
"type": "token",
"documentation": "Search by relationship type"
}
]
},
{
"type": "Encounter",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-encounter",
"documentation": "Encounter resource for clinical visits and episodes of care.\nSupports multiple tracks requiring visit context.",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "update"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"updateCreate": true,
"searchParam": [
{
"name": "patient",
"type": "reference",
"documentation": "Search by patient reference"
},
{
"name": "date",
"type": "date",
"documentation": "Search by encounter date"
},
{
"name": "type",
"type": "token",
"documentation": "Search by encounter type"
},
{
"name": "status",
"type": "token",
"documentation": "Search by encounter status"
}
]
},
{
"type": "Provenance",
"profile": "https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-provenance",
"documentation": "Provenance resource for audit trails and data origin tracking.\nSupports Privacy and device data tracks (Track 5, 8, 9).",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "target",
"type": "reference",
"documentation": "Search by target resource"
},
{
"name": "recorded",
"type": "date",
"documentation": "Search by recorded timestamp"
},
{
"name": "agent",
"type": "reference",
"documentation": "Search by agent (who/what performed the activity)"
}
]
},
{
"type": "Bundle",
"supportedProfile": [
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-eligibility-check-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-preauthorization-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-claim-submission-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-prescription-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-medication-dispense-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-mnch-referral-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-aefi-report-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-imm-smart-scheduler-bundle",
"https://fhir-ig.digitalhealth.gov.ng/StructureDefinition/ng-device-data-bundle"
],
"documentation": "Bundle resource for transaction and collection bundles across all tracks.\nSupports batch operations and structured data exchange.",
"interaction": [
{
"code": "read"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"versioning": "versioned",
"searchParam": [
{
"name": "type",
"type": "token",
"documentation": "Search by bundle type (transaction, collection)"
},
{
"name": "timestamp",
"type": "date",
"documentation": "Search by bundle timestamp"
}
]
}
],
"interaction": [
{
"code": "transaction",
"documentation": "Support for transaction bundles (batch create/update)"
},
{
"code": "batch",
"documentation": "Support for batch bundles (independent operations)"
},
{
"code": "search-system",
"documentation": "Support for system-wide searches"
},
{
"code": "history-system",
"documentation": "Support for system-wide history"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "Search by resource ID"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Search by last updated timestamp"
},
{
"name": "_profile",
"type": "uri",
"documentation": "Search by profile conformance"
},
{
"name": "_tag",
"type": "token",
"documentation": "Search by resource tags"
},
{
"name": "_security",
"type": "token",
"documentation": "Search by security labels"
}
],
"operation": [
{
"name": "validate",
"definition": "http://hl7.org/fhir/OperationDefinition/Resource-validate",
"documentation": "Validate a resource against its profile"
},
{
"name": "meta",
"definition": "http://hl7.org/fhir/OperationDefinition/Resource-meta",
"documentation": "Access resource metadata"
},
{
"name": "patient-everything",
"definition": "http://hl7.org/fhir/OperationDefinition/Patient-everything",
"documentation": "Retrieve all resources for a patient"
}
]
}
]
}