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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Kenya ePrescription Server CapabilityStatement

Declares the FHIR R4 capabilities of the Kenya national ePrescription server. Implementers must support all SHALL interactions and SHOULD support all SHOULD interactions to claim conformance with this IG.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

SearchParameter – AllergyIntolerance Substance Code

Search AllergyIntolerance resources by the allergen substance code from ActiveComponentsVS, supporting clinical decision support alerts.

SearchParameter – Encounter ServiceProvider

Search Encounter resources by the managing organisation (health facility) using the MFL facility code.

SearchParameter – MedicationDispense Prescription

Search MedicationDispense resources by the authorizing MedicationRequest (prescription) reference.

SearchParameter – MedicationDispense WhenHandedOver

Search MedicationDispense resources by the date the medication was handed to the patient.

SearchParameter – MedicationRequest AuthoredOn

Search MedicationRequest resources by the date the prescription was authored, supporting date range queries.

SearchParameter – MedicationRequest Identifier

Search MedicationRequest resources by their Kenya prescription identifier (NamingSystem: prescription-identifier).

SearchParameter – MedicationRequest Medication Code

Search MedicationRequest resources by the PPB generic product code in medicationCodeableConcept.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Kenya Morphology / Histology Observation

Profile on Observation for recording tumour morphology (histology/ICD-O-3) results in the Kenya oncology IG.

Kenya Oncology CarePlan

Profile on CarePlan representing an oncology treatment plan in the Kenya eRx / oncology IG.

Kenya Oncology Diagnosis Condition

Profile on Condition representing an oncology diagnosis in the Kenya eRx / oncology IG.

Kenya eRx AllergyIntolerance

Profile on AllergyIntolerance for the Kenya eRx Implementation Guide.

Kenya eRx Encounter

Profile on Encounter for the Kenya eRx Implementation Guide.

Kenya eRx EpisodeOfCare

Profile on EpisodeOfCare for the Kenya eRx Implementation Guide.

Kenya eRx Medication

Profile on Medication for the Kenya eRx Implementation Guide. Represents a drug product from the Kenya MOH PPB product catalogue.

Kenya eRx MedicationAdministration

Profile on MedicationAdministration for the Kenya eRx Implementation Guide.

Kenya eRx MedicationDispense

Profile on MedicationDispense for the Kenya Electronic Prescription (eRx) Implementation Guide.

Kenya eRx MedicationRequest

Profile on MedicationRequest for the Kenya Electronic Prescription (eRx) Implementation Guide.

Kenya eRx MedicationStatement

Profile on MedicationStatement for the Kenya eRx Implementation Guide. Records medication use history and current medications for a patient.

Kenya eRx ServiceRequest (Base)

Abstract base profile on ServiceRequest. Use KEServiceRequestLab or KEServiceRequestImaging in practice.

Kenya eRx ServiceRequest — Imaging

Profile on ServiceRequest for imaging/radiology investigations in the Kenya eRx Implementation Guide.

Kenya eRx ServiceRequest — Laboratory

Profile on ServiceRequest for laboratory investigations in the Kenya eRx Implementation Guide.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Controlled Substance Schedule

Indicates that the medication is a controlled substance under the Kenya Pharmacy and Poisons Act, and specifies its regulatory schedule (I through IV). Required for narcotic, psychotropic, and other scheduled medicines.

Dispense Notification

Indicates whether a notification was sent to the prescriber and/or patient following a dispensing event, and the communication channel used.

Insurance Pre-Authorization

Captures an insurance pre-authorization number issued by NHIF, SHIF, or a private insurer for a specific medication or treatment, enabling claim adjudication downstream.

Prescription Digital Signature

A reference to a digital signature or electronic authorization applied to a prescription by the prescribing practitioner, as required under Kenya e-Health regulations.

Refill Authorization

Records the number of refills authorized and remaining, together with the earliest eligible refill date, supporting chronic medication management workflows.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Active Components ValueSet

Active pharmaceutical ingredient codes drawn from the MOH PPB active components code system.

Additional Instruction Codes ValueSet

Supplementary instructions for dispensed or administered medication.

Approach Site Codes ValueSet

Body site codes for medication administration site.

Care Plan Category ValueSet

Category codes for care plan types.

Condition Category ValueSet

Category codes for Condition resources.

Condition Clinical Status ValueSet

Clinical status codes for Condition resources.

Condition Codes ValueSet

Codes for clinical conditions and diagnoses. References ICD-10 pending population of the MOH-KENYA CONDITION-CODES OCL collection.

Condition Severity ValueSet

Severity codes for Condition resources.

Condition Stage ValueSet

Staging codes for oncology and staged conditions.

Condition Verification Status ValueSet

Verification status codes for Condition resources.

Controlled Substance Schedule ValueSet

Regulatory schedules for controlled substances as defined under the Kenya Pharmacy and Poisons Act, Cap 244.

Formulation (Dosage Form) ValueSet

Pharmaceutical formulation/dosage form codes drawn from the MOH PPB formulation code system.

Generic Products ValueSet

Generic medicinal product codes drawn from the MOH PPB generic products code system.

Manifestation or Symptom ValueSet

Clinical manifestations and symptoms.

Medication Administration Route ValueSet

Route of administration codes for MedicationAdministration.

Medication Request Priority ValueSet

ValueSet for priority levels in the MedicationRequest workflow.

MedicationAdministration Status Reason ValueSet

Reasons for a MedicationAdministration status.

MedicationDispense Status Reason ValueSet

Reasons for a MedicationDispense status.

MedicationRequest Status Reason ValueSet

Reasons for a MedicationRequest status change.

MedicationRequest Status ValueSet

ValueSet containing status codes for MedicationRequest.

Observation Methods ValueSet

Methods used to perform clinical observations.

Procedure Code ValueSet

Clinical procedure codes for care plan activities and service requests.

Reason Medication Status ValueSet

Reasons for a MedicationStatement status.

Route of Administration ValueSet

Codes for route of administration of medications, drawn from the MOH PPB route of administration code system.

Unit of Measure ValueSet

Codes for units of measure used in medication dosing, drawn from the MOH PPB unit of measure code system.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Active Components CodeSystem

Active pharmaceutical ingredient codes from MOH PPB OCL.

Additional Instruction Codes CodeSystem

Supplementary instructions for dispensed or administered medication. Source: MOH-KENYA OCL ADDITIONAL-INSTRUCTION-CODES.

Approach Site Codes CodeSystem

Body site codes for site of medication administration. Source: MOH-KENYA OCL APPROACH-SITE-CODES.

Care Plan Category CodeSystem

Category codes for care plan types. Source: MOH-KENYA OCL CARE-PLAN-CATEGORY.

Condition Category CodeSystem

Category codes for Condition resources. Based on FHIR standard condition-category codes (OCL collection was empty).

Condition Clinical Status CodeSystem

Clinical status codes for Condition resources. Source: MOH-KENYA OCL CONDITION-CLINICAL-STATUS (supplemented with standard FHIR codes).

Condition Severity CodeSystem

Severity codes for Condition resources. Source: MOH-KENYA OCL CONDITION-SEVERITY.

Condition Stage CodeSystem

Staging codes for oncology and other staged conditions. Source: MOH-KENYA OCL CONDITION-STAGE.

Condition Verification Status CodeSystem

Verification status codes for Condition resources. Source: MOH-KENYA OCL CONDITION-VERIFICATION-STATUS.

Controlled Substance Schedule CodeSystem

Schedules for controlled substances under the Kenya Pharmacy and Poisons Act.

Formulation CodeSystem

Pharmaceutical formulation/dosage form codes from MOH PPB OCL.

Generic Products CodeSystem

Generic medicinal product codes from MOH PPB OCL.

Manifestation or Symptom CodeSystem

Clinical manifestations and symptoms used in allergy reactions, conditions, and observations. Source: MOH-KENYA OCL MANIFESTATION-OR-SYMPTOM.

Medication Administration Route CodeSystem

Route of administration codes used in MedicationAdministration. Source: MOH-KENYA OCL MEDICATION-ADMINISTRATION-ROUTE.

Medication Request Priority CodeSystem

Codes representing priority levels for MedicationRequest.

MedicationAdministration Status Reason CodeSystem

Reasons for a MedicationAdministration status (e.g. patient refused, not available). Source: MOH-KENYA OCL MEDICATION-ADMIN-STATUS-REASON.

MedicationDispense Status Reason CodeSystem

Reasons for a MedicationDispense status (e.g. out-of-stock, patient refused). Source: MOH-KENYA OCL MEDICATIONDISPENSE-STATUS-REASON.

MedicationRequest Status CodeSystem

Status codes used for MedicationRequest resources.

MedicationRequest Status Reason CodeSystem

Reasons for a MedicationRequest status change (e.g. cancelled, on-hold). Source: MOH-KENYA OCL MEDICATIONREQUEST-STATUS-REASON.

Observation Methods CodeSystem

Methods used to perform clinical observations. Source: MOH-KENYA OCL OBSERVATION-METHODS.

Procedure Code CodeSystem

Clinical procedure codes used in care plan activities and service requests. Source: MOH-KENYA OCL PROCEDURE-CODE.

Reason Medication Status CodeSystem

Reasons for a MedicationStatement status (e.g. stopped, completed). Source: MOH-KENYA OCL REASON-MEDICATION-STATUS-CODES.

Route of Administration CodeSystem

Route of administration codes from MOH PPB OCL.

Unit of Measure CodeSystem

Unit of measure codes from MOH PPB OCL.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

NamingSystem – Kenya Administration Identifier

Unique identifier for each medication administration event recorded in the inpatient or emergency setting.

NamingSystem – Kenya Allergy Identifier

Unique identifier for allergy and intolerance records documented in the patient's clinical record.

NamingSystem – Kenya CarePlan Identifier

Unique identifier for oncology and chronic-disease care plan records.

NamingSystem – Kenya Condition Identifier

Unique identifier for problem-list and encounter-diagnosis Condition records.

NamingSystem – Kenya Dispense Identifier

Unique identifier assigned to each medication dispensing event recorded by a Kenya pharmacy.

NamingSystem – Kenya Encounter Identifier

Unique identifier assigned to each patient encounter (visit, admission, or consultation) within the Kenya health information system.

NamingSystem – Kenya Episode of Care Identifier

Unique identifier for episodes of care grouping multiple encounters under a single management period.

NamingSystem – Kenya Health Facility Code

Master Facility List (MFL) code assigned by the Ministry of Health to every registered health facility in Kenya.

NamingSystem – Kenya Location Code

Sub-location identifier used to distinguish specific departments, wings, or service areas within a health facility.

NamingSystem – Kenya Medical Licence

Licence number issued by the Kenya Medical Practitioners and Dentists Council (KMPDC) to registered practitioners.

NamingSystem – Kenya Medication Identifier

Product-level identifier for medications registered in the Kenya Pharmacy and Poisons Board (PPB) drug register.

NamingSystem – Kenya MedicationStatement Identifier

Unique identifier for medication statement records capturing a patient's current or historical medication use.

NamingSystem – Kenya National ID

Unique national identification number issued by the Kenya National Registration Bureau to Kenyan citizens and residents.

NamingSystem – Kenya Observation Identifier

Unique identifier for clinical observation records, including morphology and diagnostic findings.

NamingSystem – Kenya Prescription Identifier

Unique identifier assigned to every electronic prescription generated within the Kenya ePrescription system.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

AllergyIntolerance – Amina Hassan Penicillin Allergy

Documented high-criticality penicillin allergy for Amina Hassan, confirmed after urticarial reaction following oral exposure.

Encounter – Amina Hassan Outpatient Consultation

Outpatient consultation at KNH for Amina Hassan, during which a prescription for Azithromycin was issued.

Encounter – James Otieno Oncology Inpatient Admission

Inpatient oncology admission for James Otieno at KNH for cancer evaluation and chemotherapy initiation.

EpisodeOfCare – James Otieno Oncology Management

Active episode of care for James Otieno covering ongoing oncology management at KNH, from initial diagnosis through planned chemotherapy.

Location – KNH Outpatient Pharmacy

Outpatient pharmacy at Kenyatta National Hospital.

Medication – Azithromycin 500 mg Film-Coated Tablet

Example Medication resource for Azithromycin 500 mg Film-Coated Tablet as used in the Kenya ePrescription workflow.

MedicationAdministration – James Otieno IV Azithromycin

Intravenous administration of Azithromycin 500 mg to James Otieno during his oncology inpatient admission, as empirical antibiotic coverage prior to chemotherapy initiation.

MedicationDispense – Amina Hassan Azithromycin First Fill

First-fill dispense of Azithromycin 500 mg (3 tablets) at KNH Outpatient Pharmacy against Amina Hassan's prescription.

MedicationRequest – Amina Hassan Azithromycin Prescription

Outpatient prescription for Azithromycin 500 mg once daily for 3 days, issued by Dr. Njoroge at KNH during Amina Hassan's consultation.

MedicationStatement – Amina Hassan Completed Azithromycin Course

Medication statement recording that Amina Hassan completed a 3-day course of Azithromycin 500 mg following her outpatient consultation at KNH.

MorphologyObservation – James Otieno Lung Biopsy Histopathology

Final histopathology result for James Otieno's CT-guided lung biopsy confirming pulmonary adenocarcinoma, performed at KNH pathology department.

OncologyCarePlan – James Otieno Chemotherapy Plan

Active oncology care plan for James Otieno covering chemotherapy initiation and supportive care activities, managed by the KNH oncology MDT.

OncologyDiagnosis – James Otieno Lung Cancer

Confirmed diagnosis of malignant neoplasm of the right lower lobe of the lung (Stage II) for James Otieno, recorded at KNH during inpatient admission.

Organization – Kenyatta National Hospital

Kenyatta National Hospital, Nairobi – used as service provider, dispenser and performer.

Patient – Amina Hassan

Fictional Kenyan patient used across ePrescription, dispensing and allergy examples.

Patient – James Otieno

Fictional Kenyan oncology patient used in morphology, diagnosis, care plan and administration examples.

Practitioner – Dr. Sarah Njoroge

Fictional Kenyan general-practitioner / oncologist referenced by prescriptions, encounters and observations.