Generated Narrative: CapabilityStatement dhin-sandbox-capability-statement DHIN Sandbox Server Capability Statement Implementation Guide Version: 0.2.0 FHIR Version: 4.0.1 Supported Formats: json, xml Supported Patch Formats: application/json-patch+json, application/xml-patch+xml Published on: 2025-11-12 Published by: DHIN Note 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. SHALL Support the Following Implementation Guides https://sandbox.dhin-hie.org/ig FHIR RESTful Capabilities Mode: server DHIN Sandbox Server supporting Nigeria FHIR IG profiles for Connectathon 2025 Security Enable CORS: yes Security services supported: OAuth, SMART-on-FHIR OAuth 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+. Summary of System-wide Interactions Supports the transactioninteraction described as follows: Support for transaction bundles (batch create/update) Supports the batchinteraction described as follows: Support for batch bundles (independent operations) Supports the search-systeminteraction described as follows: Support for system-wide searches Supports the history-systeminteraction described as follows: Support for system-wide history Summary of System-wide Operations 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 Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R S U C D Searches _include _revinclude Operations Patient https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-patient y y y y y identifier, name, birthdate, gender, address-state Practitioner https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-practitioner y y y y identifier, name, active Organization https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-organization Additional supported profiles: NG Provider Organization NG Insurer Organization NG Pharmacy Organization y y y y identifier, name, type, address-state, active Coverage https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-coverage y y y y beneficiary, payor, status CoverageEligibilityRequest https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-coverage-eligibility-request y y y patient, status CoverageEligibilityResponse https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-coverage-eligibility-response y y y patient, request Claim https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-claim y y y y patient, use, status, provider ClaimResponse https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-claim-response y y y patient, request Invoice https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-invoice y y y y subject, status, date ExplanationOfBenefit https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-explanation-of-benefit y y y patient, claim Medication https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-medication y y y y code, status MedicationRequest https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-medication-request y y y y patient, medication, status, authoredon MedicationDispense https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-medication-dispense y y y y patient, prescription, status, whenhandedover ServiceRequest https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-service-request y y y y patient, status, intent Task https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-task y y y y patient, status, owner, focus Communication https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-communication y y y subject, sent Immunization https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-immunization y y y y patient, date, vaccine-code, lot-number, status ImmunizationRecommendation https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-immunization-recommendation y y y y patient, date, vaccine-type Appointment https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-appointment y y y y patient, date, status, service-type Location https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-location y y y y name, address-state, type, status Observation https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-observation y y y y patient, code, category, date, device, status Device https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-device y y y y patient, type, manufacturer, model, status Consent https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-consent y y y y patient, status, scope, date RelatedPerson https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-related-person y y y y patient, name, relationship Encounter https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-encounter y y y y patient, date, type, status Provenance https://sandbox.dhin-hie.org/ig/StructureDefinition/ng-provenance y y y target, recorded, agent Bundle Supported Profiles 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) y y y type, timestamp Resource Conformance: supported Patient Base System Profile NG Patient Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, delete, search-type. Documentation Patient resource conforming to NgPatient profile. Supports all Connectathon tracks requiring patient demographics. Search Parameters 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 Resource Conformance: supported Practitioner Base System Profile NG Practitioner Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Practitioner resource conforming to NgPractitioner profile. Supports MDCN registry verification (Track 6). Search Parameters 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 Resource Conformance: supported Organization Base System Profile NG Organization Profile Conformance SHALL Reference Policy Supported Profiles NG Provider Organization NG Insurer Organization NG Pharmacy Organization Interaction summary Supports read, create, update, search-type. Documentation Organization resource with specialized profiles for providers, insurers, and pharmacies. Supports Claims (Track 1), ePharmacy (Track 2), and PCN Registry (Track 7). Search Parameters 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 Resource Conformance: supported Coverage Base System Profile NG Claim Coverage Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Coverage resource for insurance/HMO policies. Supports Claims & Insurance track (Track 1). Search Parameters 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 Resource Conformance: supported CoverageEligibilityRequest Base System Profile NG Claim Coverage Eligibility Request Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Eligibility check request resource. Supports Claims & Insurance track (Track 1 - Eligibility). Search Parameters Conformance Parameter Type Documentation SHALL patient reference Search by patient reference SHALL status token Search by request status Resource Conformance: supported CoverageEligibilityResponse Base System Profile NG Claim Coverage Eligibility Response Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Eligibility check response resource. Supports Claims & Insurance track (Track 1 - Eligibility). Search Parameters Conformance Parameter Type Documentation SHALL patient reference Search by patient reference SHALL request reference Search by eligibility request reference Resource Conformance: supported Claim Base System Profile NG Claim Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Claim resource for pre-authorization and claims submission. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing). Search Parameters 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 Resource Conformance: supported ClaimResponse Base System Profile NG ClaimResponse Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Claim response resource for adjudication decisions. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing). Search Parameters Conformance Parameter Type Documentation SHALL patient reference Search by patient reference SHALL request reference Search by claim reference Resource Conformance: supported Invoice Base System Profile NG Invoice Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Invoice resource for billing and payment tracking. Supports Claims & Insurance and ePharmacy tracks (Track 1 & 2). Search Parameters 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 Resource Conformance: supported ExplanationOfBenefit Base System Profile NG ExplanationOfBenefit Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Explanation of Benefit resource for detailed claim adjudication. Supports Claims & Insurance track (Track 1 - Billing). Search Parameters Conformance Parameter Type Documentation SHALL patient reference Search by patient reference SHALL claim reference Search by claim reference Resource Conformance: supported Medication Base System Profile NG Medication Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Medication resource for drug definitions. Supports ePharmacy track (Track 2). Search Parameters Conformance Parameter Type Documentation SHALL code token Search by medication code (ATC, RxNorm) SHALL status token Search by medication status Resource Conformance: supported MedicationRequest Base System Profile NG MedicationRequest Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation MedicationRequest resource for prescriptions. Supports ePharmacy track (Track 2 - Prescription). Search Parameters 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 Resource Conformance: supported MedicationDispense Base System Profile NG MedicationDispense Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation MedicationDispense resource for pharmacy dispensing records. Supports ePharmacy track (Track 2 - Dispense). Search Parameters 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 Resource Conformance: supported ServiceRequest Base System Profile NG ServiceRequest Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation ServiceRequest resource for referrals and service orders. Supports MNCH Referral track (Track 3). Search Parameters 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 Resource Conformance: supported Task Base System Profile NG Task Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Task resource for workflow management (referrals, lab orders). Supports MNCH Referral and Medical Devices tracks (Track 3 & 5). Search Parameters 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.) Resource Conformance: supported Communication Base System Profile NG Communication Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Communication resource for clinical messages and follow-ups. Supports MNCH Referral track (Track 3). Search Parameters Conformance Parameter Type Documentation SHALL subject reference Search by communication subject (usually patient) SHALL sent date Search by send date Resource Conformance: supported Immunization Base System Profile NG Immunization Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Immunization resource for vaccine administration records. Supports Immunization track (Track 4). Search Parameters 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 Resource Conformance: supported ImmunizationRecommendation Base System Profile NG ImmunizationRecommendation Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation ImmunizationRecommendation resource for vaccine scheduling. Supports Immunization track (Track 4 - Scheduler). Search Parameters 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 Resource Conformance: supported Appointment Base System Profile NG Appointment Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Appointment resource for scheduling immunizations and clinic visits. Supports Immunization track (Track 4 - Scheduler). Search Parameters 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) Resource Conformance: supported Location Base System Profile NG Location Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Location resource for health facilities and service delivery points. Supports multiple tracks including Immunization and MNCH Referral (Track 3 & 4). Search Parameters 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 Resource Conformance: supported Observation Base System Profile NG Observations Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Observation resource for clinical findings, vital signs, lab results, and AEFI. Supports Immunization (AEFI) and Medical Devices tracks (Track 4 & 5). Search Parameters 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 Resource Conformance: supported Device Base System Profile NG Device Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Device resource for medical devices (wearables, lab equipment). Supports Medical Devices track (Track 5). Search Parameters 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 Resource Conformance: supported Consent Base System Profile NG Consent Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Consent resource for data sharing and research consent (ISO/TR 17975). Supports Standards Adoption and Privacy tracks (Track 8 & 9). Search Parameters 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 Resource Conformance: supported RelatedPerson Base System Profile NG RelatedPerson Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation RelatedPerson resource for family members and caregivers. Supports Privacy use case (Track 9) with pseudonymization. Search Parameters 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 Resource Conformance: supported Encounter Base System Profile NG Encounter Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, update, search-type. Documentation Encounter resource for clinical visits and episodes of care. Supports multiple tracks requiring visit context. Search Parameters 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 Resource Conformance: supported Provenance Base System Profile NG Lightweight Provenance Profile Conformance SHALL Reference Policy Interaction summary Supports read, create, search-type. Documentation Provenance resource for audit trails and data origin tracking. Supports Privacy and device data tracks (Track 5, 8, 9). Search Parameters 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) Resource Conformance: supported Bundle Core FHIR Resource Bundle Reference Policy Interaction summary Supports read, create, search-type. Supported Profiles 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) Documentation Bundle resource for transaction and collection bundles across all tracks. Supports batch operations and structured data exchange. Search Parameters Conformance Parameter Type Documentation SHALL type token Search by bundle type (transaction, collection) SHALL timestamp date Search by bundle timestamp
DHIN Sandbox Server Capability Statement
Digital Health Interoperability Network.
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: 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
DHIN Sandbox FHIR Server for Connectathon 2025
DHIN Sandbox Server supporting Nigeria FHIR IG profiles for Connectathon 2025
OAuth 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+.
Patient resource conforming to NgPatient profile. Supports all Connectathon tracks requiring patient demographics.
Search by patient identifier (phone, NIN, etc.)
Search by patient name (family or given)
Practitioner resource conforming to NgPractitioner profile. Supports MDCN registry verification (Track 6).
Search by MDCN number or other identifier
Organization resource with specialized profiles for providers, insurers, and pharmacies. Supports Claims (Track 1), ePharmacy (Track 2), and PCN Registry (Track 7).
Search by facility registry ID, PCN number, etc.
Search by organization type (prov, pay, pharm)
Coverage resource for insurance/HMO policies. Supports Claims & Insurance track (Track 1).
Eligibility check request resource. Supports Claims & Insurance track (Track 1 - Eligibility).
Eligibility check response resource. Supports Claims & Insurance track (Track 1 - Eligibility).
Claim resource for pre-authorization and claims submission. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing).
Search by claim use (preauthorization, claim)
Claim response resource for adjudication decisions. Supports Claims & Insurance track (Track 1 - Pre-Auth & Billing).
Invoice resource for billing and payment tracking. Supports Claims & Insurance and ePharmacy tracks (Track 1 & 2).
Explanation of Benefit resource for detailed claim adjudication. Supports Claims & Insurance track (Track 1 - Billing).
Medication resource for drug definitions. Supports ePharmacy track (Track 2).
MedicationRequest resource for prescriptions. Supports ePharmacy track (Track 2 - Prescription).
MedicationDispense resource for pharmacy dispensing records. Supports ePharmacy track (Track 2 - Dispense).
ServiceRequest resource for referrals and service orders. Supports MNCH Referral track (Track 3).
Task resource for workflow management (referrals, lab orders). Supports MNCH Referral and Medical Devices tracks (Track 3 & 5).
Search by task focus (ServiceRequest, etc.)
Communication resource for clinical messages and follow-ups. Supports MNCH Referral track (Track 3).
Search by communication subject (usually patient)
Immunization resource for vaccine administration records. Supports Immunization track (Track 4).
ImmunizationRecommendation resource for vaccine scheduling. Supports Immunization track (Track 4 - Scheduler).
Appointment resource for scheduling immunizations and clinic visits. Supports Immunization track (Track 4 - Scheduler).
Search by service type (e.g., immunization)
Location resource for health facilities and service delivery points. Supports multiple tracks including Immunization and MNCH Referral (Track 3 & 4).
Observation resource for clinical findings, vital signs, lab results, and AEFI. Supports Immunization (AEFI) and Medical Devices tracks (Track 4 & 5).
Search by observation code (LOINC, SNOMED)
Device resource for medical devices (wearables, lab equipment). Supports Medical Devices track (Track 5).
Search by patient reference (device owner)
Consent resource for data sharing and research consent (ISO/TR 17975). Supports Standards Adoption and Privacy tracks (Track 8 & 9).
RelatedPerson resource for family members and caregivers. Supports Privacy use case (Track 9) with pseudonymization.
Encounter resource for clinical visits and episodes of care. Supports multiple tracks requiring visit context.
Provenance resource for audit trails and data origin tracking. Supports Privacy and device data tracks (Track 5, 8, 9).
Search by agent (who/what performed the activity)
Bundle resource for transaction and collection bundles across all tracks. Supports batch operations and structured data exchange.
Search by bundle type (transaction, collection)
Support for transaction bundles (batch create/update)
Support for batch bundles (independent operations)