kenya-eprescription-server-capability
type: CapabilityStatement
node role: treeRoot
id:
  v: kenya-eprescription-server-capability
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: CapabilityStatement kenya-eprescription-server-capability 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 Type Profile R S U C Searches _include _revinclude Operations Patient http://hl7.org/fhir/StructureDefinition/Patient Y Y identifier, name, birthdate Practitioner http://hl7.org/fhir/StructureDefinition/Practitioner Y Y identifier Organization http://hl7.org/fhir/StructureDefinition/Organization Y Y identifier Encounter https://nshr-uat.sha.go.ke/StructureDefinition/ke-encounter Y Y Y Y patient, status, date MedicationRequest https://nshr-uat.sh…
url:
  v: https://nshr-uat.sha.go.ke/CapabilityStatement/kenya-eprescription-server
  l: kenya-eprescription-server
version:
  v: 0.1.0
name:
  v: KenyaEPrescriptionServerCapabilityStatement
title:
  v: Kenya ePrescription Server CapabilityStatement
status:
  v: draft
experimental:
  v: true
date:
  v: 2025-06-01
publisher:
  v: DHA, Kenya
contact:
  name:
    v: DHA, Kenya
  telecom:
    system:
      v: url
    value:
      v: https://dha.go.ke/
  telecom:
    system:
      v: email
contact:
  name:
    v: Digital Health Agency, Kenya
  telecom:
    system:
      v: email
    use:
      v: work
  telecom:
    system:
      v: url
    value:
      v: https://www.dha.go.ke/
description:
  v: 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.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: KE
    display:
      v: Kenya
copyright:
  v: 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.
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: json
format:
  v: xml
rest:
  mode:
    v: server
  documentation:
    v: 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:
    cors:
      v: true
    description:
      v: OAuth 2.0 with SMART on FHIR scopes. All clients must present a valid access token issued by the national HIE identity provider.
  resource:
    type:
      v: Patient
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Patient
      l: Patient
    documentation:
      v: Patient resources are read-only on this server; patient registration is managed by the MPI.
    interaction:
      extension:
        value: Code
      code:
        v: read
    interaction:
      extension:
        value: Code
      code:
        v: search-type
    search param:
      name:
        v: identifier
      type:
        v: token
      documentation:
        v: Search by national ID or other patient identifier
    search param:
      name:
        v: name
      type:
        v: string
    search param:
      name:
        v: birthdate
      type:
        v: date
  resource:
    type:
      v: Practitioner
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Practitioner
      l: Practitioner
    interaction:
      extension:
        value: Code
      code:
        v: read
    interaction:
      extension:
        value: Code
      code:
        v: search-type
    search param:
      name:
        v: identifier
      type:
        v: token
      documentation:
        v: Search by KMPDC medical licence number
  resource:
    type:
      v: Organization
    profile:
      v: http://hl7.org/fhir/StructureDefinition/Organization
      l: Organization
    interaction:
      extension:
        value: Code
      code:
        v: read
    interaction:
      extension:
        value: Code
      code:
        v: search-type
    search param:
      name:
        v: identifier
      type:
        v: token
      documentation:
        v: Search by MFL facility code
  resource:
    type:
      v: Encounter
    profile:
      v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-encounter
      l: ke-encounter
    interaction:
      extension:
        value: Code
      code:
        v: read
    interaction:
      extension:
        value: Code
      code:
        v: create
    interaction:
      extension:
        value: Code
      code:
        v: update
    interaction:
      extension:
        value: Code
      code:
        v: search-type
    search param:
      name:
        v: patient
      type:
        v: reference
    search param:
      name:
        v: status
      type:
        v: token
    search param:
      name:
        v: date
      type:
        v: date

v: SMART-on-FHIR

v: SMART-on-FHIR

Code
v: SHALL

Code
v: SHALL

Code
v: SHALL

Code
v: SHALL

Code
v: SHALL

Code
v: SHOULD

Code
v: SHALL

Code
v: SHALL

Code
v: SHALL

Code
v: SHALL

type:
  v: MedicationRequest
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-request
  l: ke-medication-request
documentation:
  v: Core ePrescription resource. Servers SHALL support create, read, update, and search by patient, requester, status, and authored date.
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search prescriptions by patient
search param:
  name:
    v: requester
  type:
    v: reference
search param:
  name:
    v: status
  type:
    v: token
search param:
  name:
    v: authoredon
  type:
    v: date
search param:
  name:
    v: medication
  type:
    v: token
search param:
  name:
    v: identifier
  type:
    v: token

type:
  v: Medication
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication
  l: ke-medication
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHOULD
  code:
    v: search-type
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Search by PPB generic product code

type:
  v: MedicationDispense
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-dispense
  l: ke-medication-dispense
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: prescription
  type:
    v: reference
  documentation:
    v: Filter dispenses by originating prescription
search param:
  name:
    v: status
  type:
    v: token
search param:
  name:
    v: whenhandedover
  type:
    v: date

type:
  v: MedicationAdministration
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-administration
  l: ke-medication-administration
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHOULD
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: request
  type:
    v: reference
search param:
  name:
    v: effective-time
  type:
    v: date

type:
  v: MedicationStatement
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-medication-statement
  l: ke-medication-statement
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHOULD
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: status
  type:
    v: token

type:
  v: AllergyIntolerance
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-allergy-intolerance
  l: ke-allergy-intolerance
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: update
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: clinical-status
  type:
    v: token
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Search by allergen substance code (ActiveComponentsVS)

type:
  v: Condition
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-oncology-diagnosis
  l: ke-oncology-diagnosis
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: code
  type:
    v: token
search param:
  name:
    v: clinical-status
  type:
    v: token

type:
  v: EpisodeOfCare
profile:
  v: https://nshr-uat.sha.go.ke/StructureDefinition/ke-episode-of-care
  l: ke-episode-of-care
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  code:
    v: read
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHOULD
  code:
    v: create
interaction:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHOULD
  code:
    v: search-type
search param:
  name:
    v: patient
  type:
    v: reference
search param:
  name:
    v: status
  type:
    v: token