Getting Started
1.Overview
The AfyaConnect Developer Portal helps you integrate your health information systems with Kenya's national health exchange. This guide explains how to register, set up your integration, obtain sandbox credentials, test against AfyaConnect APIs, and go live on the production environment.
2.Sign Up
To use the Developer Portal, you must first create an account.
- Go to the Sign Up page.
- Enter your personal or organisation details.
- Read and accept the Terms and Conditions.
- Submit the registration form.
Once registered, you can Sign in to access APIs, Simulations, and Tutorials.
4.System Integration
AfyaConnect exposes FHIR-based APIs for health data exchange across Kenya's healthcare ecosystem.
For each API, you can view:
- Supported FHIR resources (Patient, Encounter, Claim, Coverage)
- Available endpoints and operations
- Request and response formats aligned to the Kenya FHIR Implementation Guide
- Authentication requirements (OAuth 2.0 client credentials)
Use this section to understand which APIs are relevant to your HMIS integration before starting development.
5.Technical Onboarding
During Technical Onboarding, you set up your sandbox environment on AfyaConnect.
You will:
- Create an app in the onboarding portal to obtain your Consumer Key and Consumer Secret
- Configure your sandbox tenants and select the API products your system needs
- Review the AfyaConnect Implementation Guide for FHIR resource conformance requirements
This step prepares your development environment for sandbox API testing.
6.Sandbox API Testing
The AfyaConnect sandbox lets you test your integration against simulated API endpoints.
You can use the sandbox to:
- Submit FHIR bundles (Patient, Encounter, Claim) and validate responses
- Test OAuth 2.0 authentication with your sandbox credentials
- Verify error handling for common scenarios (validation failures, rate limits, timeouts)
- Review Operation Outcome responses to debug conformance issues
This ensures your system works correctly before connecting to production.
7.Sandbox Integration for HMIS
Connect your Hospital Management Information System (HMIS) to the AfyaConnect sandbox environment.
During this phase:
- Configure your HMIS to send FHIR-compliant data to the sandbox endpoints
- Map your local clinical codes to the AfyaConnect terminology (ICD-10, LOINC, KenyaEMR codes)
- Verify end-to-end data flows - from patient registration through claims submission
- Validate that Shared Health Records (SHR) queries return expected results
This step confirms your HMIS integration is ready for production data exchange.
8.Workflow Validations
Validate your clinical and administrative workflows after sandbox integration with AfyaConnect.
Key validations include:
- Patient registration and identity matching via the Client Registry
- Encounter documentation and SHR submission
- SHA pre-authorisation requests and claim submissions
- Claims adjudication response handling and reconciliation
- Facility-level reporting and data quality checks
All workflows must pass validation before your system is approved for go-live.
9.Go-Live Approval
Submit your integration for review by the AfyaConnect team to receive go-live approval.
The review process includes:
- Verification that all sandbox test cases pass successfully
- Confirmation of FHIR conformance against the Kenya Implementation Guide
- Security and data protection compliance review
- End-to-end workflow validation sign-off
Once approved, you will receive production credentials and your system will be cleared for live data exchange.
10.Go-Live
Your system is now live on the AfyaConnect production environment.
Production credentials have been issued for your app. Your HMIS is now exchanging real health data through AfyaConnect's national health exchange.
Key reminders:
- Monitor your API usage and error rates through the developer dashboard
- Follow AfyaConnect's data protection policies for all patient data
- Contact the AfyaConnect support team for production issues
- Keep your integration updated when new API versions are released
11.Terms and Conditions
The AfyaConnect Terms and Conditions govern your use of the developer portal and APIs.
They cover:
- Acceptable use of the AfyaConnect platform and health data exchange services
- Security and data protection requirements under Kenya's Data Protection Act
- Compliance with the Kenya Health Information Exchange (HIE) policies
- Legal obligations for handling protected health information (PHI)
You must agree to these terms during registration and comply with them throughout your integration.
Last modified on 10 July 2026