Kenya ePrescription FHIR Implementation Guide
0.1.0 - ci-build Kenya flag

Kenya ePrescription FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Kenya ePrescription Server CapabilityStatement (Experimental)

Official URL: https://nshr-uat.sha.go.ke/CapabilityStatement/kenya-eprescription-server Version: 0.1.0
Draft as of 2025-06-01 Computable Name: KenyaEPrescriptionServerCapabilityStatement

Copyright/Legal: Copyright 2025+ Digital Health Agency, Kenya. This content is licensed under Creative Commons Attribution 4.0 International (CC-BY-4.0). Terminology content from the Kenya Pharmacy and Poisons Board (PPB) via Open Concept Lab (OCL) is subject to separate terms.

This CapabilityStatement defines the conformance requirements for any system claiming to be a Kenya ePrescription server. It covers the core prescription-to-dispense workflow as well as oncology care plan and allergy management capabilities.

Raw OpenAPI-Swagger Definition file | Download

Kenya ePrescription Server CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2025-06-01
  • Published by: DHA, Kenya

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.

FHIR RESTful Capabilities

Mode: server

The Kenya ePrescription server supports resource-level CRUD operations and the search interactions listed below. All transactions must be authenticated via OAuth 2.0 / SMART on FHIR.

Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

OAuth 2.0 with SMART on FHIR scopes. All clients must present a valid access token issued by the national HIE identity provider.

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 TypeProfileRSUCSearches_include_revincludeOperations
Patienthttp://hl7.org/fhir/StructureDefinition/PatientYYidentifier, name, birthdate
Practitionerhttp://hl7.org/fhir/StructureDefinition/PractitionerYYidentifier
Organizationhttp://hl7.org/fhir/StructureDefinition/OrganizationYYidentifier
Encounterhttps://nshr-uat.sha.go.ke/StructureDefinition/ke-encounterYYYYpatient, status, date
MedicationRequesthttps://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-requestYYYYpatient, requester, status, authoredon, medication, identifier
Medicationhttps://nshr-uat.sha.go.ke/StructureDefinition/ke-medicationYYcode
MedicationDispensehttps://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-dispenseYYYYpatient, prescription, status, whenhandedover
MedicationAdministrationhttps://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-administrationYYYpatient, request, effective-time
MedicationStatementhttps://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-statementYYYpatient, status
AllergyIntolerancehttps://nshr-uat.sha.go.ke/StructureDefinition/ke-allergy-intoleranceYYYYpatient, clinical-status, code
Conditionhttps://nshr-uat.sha.go.ke/StructureDefinition/ke-oncology-diagnosisYYYpatient, code, clinical-status
EpisodeOfCarehttps://nshr-uat.sha.go.ke/StructureDefinition/ke-episode-of-careYYYpatient, status
Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Documentation

Patient resources are read-only on this server; patient registration is managed by the MPI.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Search by national ID or other patient identifier

SHALLnamestring
SHALLbirthdatedate
 
Base System Profile
Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Search by KMPDC medical licence number

 
Base System Profile
Organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.
  • SHOULD support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Search by MFL facility code

 
Base System Profile
Kenya eRx Encounter
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
SHALLdatedate
 
Base System Profile
Kenya eRx MedicationRequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create, update, search-type.

Documentation

Core ePrescription resource. Servers SHALL support create, read, update, and search by patient, requester, status, and authored date.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search prescriptions by patient

SHALLrequesterreference
SHALLstatustoken
SHALLauthoredondate
SHALLmedicationtoken
SHALLidentifiertoken
 
Base System Profile
Kenya eRx Medication
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.
  • SHOULD support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken

Search by PPB generic product code

 
Base System Profile
Kenya eRx MedicationDispense
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLprescriptionreference

Filter dispenses by originating prescription

SHALLstatustoken
SHALLwhenhandedoverdate
 
Base System Profile
Kenya eRx MedicationAdministration
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create.
  • SHOULD support search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLrequestreference
SHALLeffective-timedate
 
Base System Profile
Kenya eRx MedicationStatement
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken
 
Base System Profile
Kenya eRx AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create, update, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLclinical-statustoken
SHALLcodetoken

Search by allergen substance code (ActiveComponentsVS)

 
Base System Profile
https://nshr-uat.sha.go.ke/StructureDefinition/ke-oncology-diagnosis
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, create, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLcodetoken
SHALLclinical-statustoken
 
Base System Profile
Kenya eRx EpisodeOfCare
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.
  • SHOULD support create, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLstatustoken