Kenya eClaims FHIR Implementation Guide
0.1.0 - ci-build
KE
Kenya eClaims FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
All FHIR API endpoints exchanging data under this IG SHALL enforce the following transport-layer controls:
| Requirement | Specification |
|---|---|
| Protocol | HTTPS only (HTTP is prohibited) |
| TLS Version | TLS 1.2 minimum; TLS 1.3 recommended |
| Certificate Authority | Certificates issued by a recognized CA; self-signed certificates prohibited in production |
| HSTS | HTTP Strict Transport Security header required (max-age ≥ 31536000) |
| Cipher Suites | Forward-secrecy ciphers only (e.g., ECDHE-RSA-AES256-GCM-SHA384) |
| Certificate Pinning | Recommended for mobile and embedded EMR clients |
All actors transmitting or receiving FHIR resources under this IG SHALL authenticate using one of the following mechanisms:
The preferred authentication framework for EMR-to-HIE and HIE-to-SHA interactions. Implementations SHALL support:
system/Claim.write, system/ClaimResponse.read, system/Coverage.readFor system-to-system integrations between the HIE and SHA where OAuth infrastructure is not feasible, mutual TLS client certificate authentication MAY be used as an alternative. Client certificates must be issued by DHA's certificate authority.
API keys SHALL NOT be used as the sole authentication mechanism for any endpoint transmitting PHI. They MAY be used as a secondary factor alongside OAuth tokens for rate-limiting purposes.
Implementations SHALL enforce role-based access controls that restrict which actors can perform which FHIR operations:
| Role | Permitted Operations |
|---|---|
| Provider EMR | POST Claim, GET ClaimResponse, GET Coverage, POST Bundle |
| SHA Adjudication Engine | GET Claim, POST ClaimResponse, POST PaymentNotice |
| HIE Gateway | POST Bundle, GET/POST all claim-related resources |
| Analytics System | GET on de-identified aggregated resources only |
| Audit System | GET AuditEvent (read-only) |
ClaimResponse resources to the provider that submitted the corresponding Claim.AuditEvent.All FHIR resources defined in this IG contain PHI as defined by the Kenya Data Protection Act 2019 (personal identifiers, health conditions, financial data). The following obligations apply:
All FHIR operations performed under this IG SHALL generate audit log entries conforming to the IHE ATNA (Audit Trail and Node Authentication) profile. At minimum, each audit record SHALL capture:
| Field | Description |
|---|---|
AuditEvent.recorded |
Timestamp of the event (UTC) |
AuditEvent.agent |
The system or user that initiated the request |
AuditEvent.entity |
The FHIR resource(s) accessed or modified |
AuditEvent.action |
C (create), R (read), U (update), D (delete), E (execute) |
AuditEvent.outcome |
Success, minor failure, serious failure |
AuditEvent.source |
The system generating the audit event |
Audit logs SHALL be:
Bundle.meta.lastUpdated timestamp.Signature datatype with a provider's registered digital certificate.Claim.identifier) SHALL be globally unique within the submitting system's namespace (system + value pair).Claim with an identifier that matches a previously accepted claim within the same fiscal year from the same provider.In the event of a suspected data breach involving PHI transmitted under this IG:
Contact: security@dha.go.ke
Implementations claiming conformance to this IG are expected to comply with: