eClaims and Preauth APIs
string · requiredstringstringintegerstringstringstringstringbooleanbooleanstringintegerstringstringbooleanstringnumberstringintegerstringbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanintegerstringbooleanbooleanstringstringstringbooleanintegerstringstringstringstringstringbooleanstringstringstringstringstringstringstringstringstringstringstringstringintegerstringstringstringnumbernumberstring
Properties for Normal Preauth:
string · requiredstring · requiredstring · requiredstringstringintegerstringstringstringstringbooleanbooleanstringintegerstringstringbooleanstringnumberstringintegerstringbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanintegerstringbooleanbooleanstringstringstringbooleanintegerstringstringstringstringstringbooleanstringstringstringstringstringstringstringstringstringstringstringstringintegerstringstringstringnumbernumberstring
string · requiredstring · requiredstring · required
Endpoints for preauthorization processes.
Cancel Preauth
POST
https://ilm-dev.dha.go.ke/uat-middleware
/api/v1/preauth/cancel
Cancel an existing preauthorization using the consent token and intervention code.
Cancel Preauth › Request Body
Request payload for canceling a preauthorization. Requires consent token and intervention code.
consent_tokenintervention_codeCancel Preauth › Responses
Preauthorization canceled successfully
accessPointanaesthesiaTypeauthorizationobject
object
carcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeobject
isElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNameobject[]
object[]
object[]
array
object[]
object[]
preauthTypeproviderConsentproviderCurrencyobject
providerNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherreplicatedobject
responseExtraDataserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameFetches a preauthorization
GET
https://ilm-dev.dha.go.ke/uat-middleware
/api/v1/preauths
Fetches an existing preauthorization linked to the consent token provided
query Parameters
consent_tokenconsent token linked to the preauth
Fetches a preauthorization › Responses
Preauthorization retrieved successfully
accessPointanaesthesiaTypeauthorizationobject
object
carcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeobject
isElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNameobject[]
object[]
object[]
array
object[]
object[]
preauthTypeproviderConsentproviderCurrencyobject
providerNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherreplicatedobject
responseExtraDataserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameCreate a preauthorization
POST
https://ilm-dev.dha.go.ke/uat-middleware
/api/v1/preauths
Creates a new preauthorization using multipart form data with file uploads
Create a preauthorization › Request Body
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: consent_token, intervention_code, service_start +6 more | |
| type = object · requires: consent_token, intervention_code, service_start +13 more | |
| type = object · requires: consent_token, intervention_code, service_start +10 more | |
| type = object · requires: consent_token, intervention_code, service_start +11 more | |
| type = object · requires: consent_token, intervention_code, service_start +12 more | |
| type = object · requires: consent_token, intervention_code, service_start +7 more |
Normal preauthorization request. Contains only the base fields for any normal preauthorisations.
consent_tokenConsent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.
Example: J6LAFNBPZN
intervention_codeIntervention code for the service offered
Example: SHA-11-001
service_startISO timestamp for when the service started
Example: 2025-08-18T15:30:00+03:00
service_endISO timestamp for when the service ended
Example: 2025-08-19T15:30:00+03:00
object[] · required
List of billed items
Example: [{"unit_price":"1500.00"}]
object[] · required
List of diagnoses
Example: [{"consent_token":"J6LAFNBPZN","icd_code":"ca07.0"}]
object[] · required
List of doctors
Example: [{"identification_number":"A8691","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001"}]
object[] · required
List of attachments
Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]
provider_notification_emailEmail to notify the provider of any updates on the preauthorization request
Example: clifford.ouma@savannahinformatics.com
Create a preauthorization › Responses
Preauthorization created successfully
accessPointanaesthesiaTypeauthorizationobject
object
carcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeobject
isElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNameobject[]
object[]
object[]
array
object[]
object[]
preauthTypeproviderConsentproviderCurrencyobject
providerNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherreplicatedobject
responseExtraDataserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameRemove diagnosis from a preauth
DELETE
https://ilm-dev.dha.go.ke/uat-middleware
/api/v1/preauths/diagnoses/{icd_code}
Remove a diagnosis from an existing preauthorization.
Remove diagnosis from a preauth › Request Body
consent_tokenicd_codeintervention_codeRemove diagnosis from a preauth › Responses
Preauthorization canceled successfully
accessPointanaesthesiaTypeauthorizationobject
object
carcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeobject
isElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNameobject[]
object[]
object[]
array
object[]
object[]
preauthTypeproviderConsentproviderCurrencyobject
providerNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherreplicatedobject
responseExtraDataserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameRemove Preauth Doctor
DELETE
https://ilm-dev.dha.go.ke/uat-middleware
/api/v1/preauths/doctors
Remove a doctor associated with an existing preauthorization. Can only be done before the preauthorization is submitted.
Remove Preauth Doctor › Request Body
consent_tokenintervention_codepractitioner_registration_numberRemove Preauth Doctor › Responses
Preauth Doctor removed successfully
string