eClaims and Preauth APIs

Schemas

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.SetEffectiveCoverageRequest

Selects which POMSF cover a visit is billed against, for a household with more than one POMSF cover available.

consent_token

string · required

Consent token for the visit whose coverage is being set. Example value is dummy data.

Example: MJD3MYN5R7

policy_number

string · required

The POMSF policy number of the cover to bill this visit against. Read it from the eligibility response: pick the scheme in schemes[] whose schemeName is the POMSF cover to use, then take policy.number from that scheme object.

Example: POL-POMSF-0098231

principal_cr_id

string · required

Client Registry (CR) number of the POMSF principal whose cover is being applied. This is the principal member, not necessarily the patient. Example value is dummy data.

Example: CR2594484249725-2

internal_domain_authorizations.EffectiveCoverageResponse

Echo of the coverage selection that was applied to the visit. Use it to confirm the visit is now billing against the cover you intended.

consent_token

string

Consent token of the visit the coverage was applied to.

Example: MJD3MYN5R7

policy_number

string

POMSF policy number the visit will now be billed against.

Example: POL-POMSF-0098231

principal_cr_id

string

Client Registry (CR) number of the POMSF principal whose cover was applied.

Example: CR2594484249725-2

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ErrorResponse

Standard error response format for all error conditions.

error

string

@Description HTTP status text from the standard HTTP status codes @Example "Bad Request"

message

string

@Description Detailed error message explaining what went wrong @Example "token missing required tenant_id claim"

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFTariffsResolveInput

fr_code

string · required

Facility registry code of the facility the tariffs are requested for.

Example: FID-42-110176-7

intervention_codes

string[] · minItems: 1 · required

SHA intervention codes to resolve tariffs for.

Example: ["PMF-12-001"]

as_of

string

Effective date used to resolve tariffs.

Example: 2026-06-08

hcw_identifier

string

Identifier of the health care worker, matching the identifier type. Example is dummy data.

Example: A00000

hcw_identifier_type

string · enum

Type of identifier supplied for the health care worker.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

hcw_puid

hwc_puid

Example: registration_number

hcw_regulator

string · enum

Regulatory body that registered the health care worker.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

keph_level

string

KEPH level of the facility used to resolve tariffs.

Example: LEVEL 4

scheme

string

Benefit scheme the tariffs are resolved under.

Example: UHC

speciality

string · enum

Practitioner speciality the tariffs apply to.

Enum values:

SPECIALIST

Example: GP

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFPooledLimit

pool

string

resolved_here

boolean

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFBundleEntry

amount

string

object

currency

string

date_uploaded

string

level_resolution

string · enum

Enum values:

RESOLVED

UNKNOWN

UNMATCHED

Example: RESOLVED

member_codes

string[]

mode

string · enum

Enum values:

CAPPED_BUNDLE

FFS

Example: CAPPED_BUNDLE

name

string

package

string

object

source

string · enum

Enum values:

NEGOTIATED

DEFAULT

Example: NEGOTIATED

speciality

string · enum

Enum values:

SPECIALIST

Example: GP

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.TariffCell

amount

string

currency

string

date_uploaded

string

mode

string · enum

Enum values:

FIXED

FFS

Example: FIXED

source

string · enum

Enum values:

NEGOTIATED

DEFAULT

Example: NEGOTIATED

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFInterventionEntry

bundle_ref

string

package

string

reimbursement_basis

string · enum

Enum values:

PER_ENCOUNTER_BUNDLE

PER_LINE_ITEM

Example: PER_LINE_ITEM

object

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFTariffsResolveOutput

object

date_uploaded

string

eligible_to_bill

boolean

facility_level

integer

facility_name

string

fr_code

string

has_negotiated_tariff

boolean

object

is_contracted

boolean

speciality

string · enum

Enum values:

SPECIALIST

Example: GP

unmatched_codes

string[]

without_negotiated_rate

string[]

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.ErrorResponse

code

integer

details

string[]

error

string

message

string

source

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFRatesInput

fr_code

string · required

Facility registry code of the facility the rates are requested for.

Example: FID-42-110176-7

intervention_codes

string[] · minItems: 1 · required

SHA intervention codes to resolve rates for.

Example: ["PMF-12-001"]

hcw_identifier

string

Identifier of the health care worker, matching the identifier type. Example is dummy data.

Example: A00000

hcw_identifier_type

string · enum

Type of identifier supplied for the health care worker.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

hcw_puid

hwc_puid

Example: registration_number

hcw_regulator

string · enum

Regulatory body that registered the health care worker.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.POMSFRate

facilityName

string

frCode

string

hasNegotiatedPomsfTariff

boolean

interventionCode

string

interventionName

string

pomsfDefaultTariff

string

pomsfTariff

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PMFRatesOutput

fr_code

string

has_negotiated_rates

boolean

intervention_codes

string[]

is_contracted

boolean

object[]

speciality

string · enum

Enum values:

SPECIALIST

Example: GP

internal_domain_claims.ClaimAttachment

attachment

string

attachment_type

string

claim

string

data

string

debug_data

string

description

string

id

string

intervention_code

string

last_retry

string

retry_count

integer

title

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemoveClaimAttachmentRequest

Request payload for removing an attachment from a virtual claim.

attachment_id

string · required

Identifier of the attachment to remove from the claim.

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

consent_token

string · required

Patient consent token authorising the change.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the attachment is linked to.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.SuccessResponse

Standard success response format for all successful operations.

object

@Description Response data payload containing operation details @Example {"status": "success"}

message

string

@Description Success message describing the operation result @Example "Visit has been successfully started"

OTPAuthorizationRequest

Authorization request using a one-time password (OTP) sent to the patient's registered phone number. Use this strategy for outpatient or inpatient consent where OTP verification is available.

patient_id

string · required

The patient's Client Registry identifier. Dummy example — obtain a real value from the Patient Search API.

Example: CR2594484249725-2

service_type

string · enum · required

Type of service being authorized.

Enum values:

OUTPATIENT

INPATIENT

Example: OUTPATIENT

otp

string · required

One-time password delivered to the patient's registered phone number.

Example: 123456

interventions

string[] · required

List of intervention codes for the services being requested in this visit.

Example: ["SHA-18-005"]

BiometricsAuthorizationRequest

Authorization request using biometric verification via a registered hardware agent. Supports eKYC (SHA flow) and fingerprint (Under-18 patient flow). All fields are required for biometric consent.

agent_id

string · required

ID number of the registered biometrics agent. Obtained from the user logged into the hardware server application. Example is dummy data.

Example: 12345678

authorizing_device_os

string · enum · required

Operating system of the device making the biometrics request.

Enum values:

windows

android

Example: windows

ekyc_provider_id

string · required

Name of the healthcare facility initiating the eKYC verification.

Example: Nairobi West

factors

string[] · required

Biometric verification flow(s) to use. SHA triggers the eKYC flow; fingerprint is used for Under-18 patient consent. The fingerprint option (Under-18 patient flow) is still work in progress.

Enum values:

SHA

fingerprint

Example: ["SHA"]

interventions

string[] · required

List of intervention codes for the services being requested in this visit.

Example: ["SHA-18-005"]

is_biometrics_discharge_authorization

boolean · required

Set to true only when this authorization is for a patient's discharge. false for all other consent scenarios.

Example: false

is_emergency

boolean · required

Set to true if this authorization is for an emergency claim.

Example: false

is_integration

boolean · required

Indicates an integration with external systems. Always true for system-to-system integrations.

Example: true

patient_id

string · required

The patient's Client Registry identifier. Dummy example — obtain a real value from the Patient Search API.

Example: CR2594484249725-2

provider

string · required

The healthcare facility's Facility Registry (FR) code.

Example: FID-47-108521-3

service_type

string · enum · required

Type of service being authorized.

Enum values:

OUTPATIENT

INPATIENT

Example: INPATIENT

work_station_id

string · required

Workstation identifier obtained from the hardware server application running in the background on the authorizing device.

Example: 790bf760-08e6-4fbe-b892-7b877dd52f2b-F406692C85F3

MatchAuthorizationRequest

Authorization request for a minor whose consent was attested by a fingerprint match captured through the minors biometrics endpoints. The `match_id` of the completed match replaces the OTP and the eKYC credential fields: the gateway validates the match against its own record and fills the workstation, agent and match-log references from it, so a caller cannot claim a capture happened on hardware it does not own, or for a subject it did not capture.

interventions

string[] · required

List of intervention codes for the services being requested in this visit.

Example: ["SHA-18-005"]

is_biometrics_discharge_authorization

boolean · required

Set to true only when this authorization is for a patient's discharge. false for all other consent scenarios.

Example: false

is_emergency

boolean · required

Set to true if this authorization is for an emergency claim.

Example: false

is_integration

boolean · required

Indicates an integration with external systems. Always true for system-to-system integrations.

Example: true

match_id

string · required

Identifier of the completed fingerprint match, returned by POST /api/v1/biometrics/matches and read back from GET /api/v1/biometrics/matches/{match_id}. It is the gateway's own record of a completed fingerprint match, so no biometric credential is sent here. The match must have reached the matched state, must still be inside its 600 second freshness window, and is single-use: once an authorization has been minted from it, reuse is refused. The patient_id sent here must equal the health_id the match was captured against.

Example: 9f2c1d4e-6b8a-4c37-9f10-2a5b7c3d8e41

patient_id

string · required

The minor's Client Registry identifier, including the dependant suffix. It must be the same value sent as health_id when the match was requested; the gateway compares the two and refuses a mismatch. Example is dummy data.

Example: CR2594484249725-2

provider

string · required

The healthcare facility's Facility Registry (FR) code.

Example: FID-47-108521-3

service_type

string · enum · required

Type of service being authorized.

Enum values:

OUTPATIENT

INPATIENT

Example: OUTPATIENT

internal_domain_claims.EKYCResponse

embedExpiry

integer

embededToken

string

requestId

string

requestUrl

string

internal_domain_claims.Authorization

authCode

string

authorizationReason

string

authorizationType

string[]

authorizingDeviceOs

string

beneficiary

integer

beneficiaryCode

string

beneficiaryJoinDate

string

beneficiaryName

string

beneficiaryNumber

string

beneficiaryScheme

string

benefitType

string

biometricMatchLogId

string

created_by

string

dateAuthorized

string

ekycToken

string

endDate

string

expiry

string

guardian

integer

guid

string

id

integer

isBiometricsDischargeAuthorization

boolean

isComplete

boolean

isElective

boolean

isEmergency

boolean

isOpen

boolean

label

string

needsPreauth

boolean

notes

string

overallPreauthFinalised

boolean

parentAuthorization

integer

parentType

string

provider

integer

providerFid

string

providerName

string

requestedBy

string

sessionType

string

shaGuid

string

object

shaVerificationRequestId

string

status

string

token

string

updated_by

string

workStationId

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.ClaimCancelReason

string · enum

Enum values:

WRONG_PATIENT

NO_SERVICE_GIVEN

WRONG_BENEFIT

EXPIRED_VISIT

EXHAUSTED_BENEFIT

TIME_BARRED

OTHER_REASONS

WRONG_PATIENT

Example: WRONG_PATIENT

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CloseClaimRequest

cancel_reason_text

string · required

Free-text explanation for closing/cancelling the claim.

Example: Service not rendered; patient did not attend.

cancel_reason_type

string · enum · required

Enum values:

WRONG_PATIENT

NO_SERVICE_GIVEN

WRONG_BENEFIT

EXPIRED_VISIT

EXHAUSTED_BENEFIT

TIME_BARRED

OTHER_REASONS

WRONG_PATIENT

Example: WRONG_PATIENT

consent_token

string · required

Patient consent token authorising the claim closure.

Example: K5HLPJVDNV

internal_domain_claims.ClaimDiagnosis

claim

string

claim_diagnosis_id

integer

diagnosis

string

diagnosis_code

string

diagnosis_name

string

edi_claim_diagnosis_guid

string

edi_claim_diagnosis_replicated

string

intervention_code

string

is_flagged_diagnosis

boolean

is_inpatient

boolean

original_visit_date

string

patient_number

string

recorded_on

string

site_code

string

site_code_type

string

visit_number

string

internal_domain_claims.ClaimIntervention

accrued_per_diem_amount

number

accrued_per_diem_days

integer

active_for_uhc

boolean

applicable_document_types

string[]

bill_from

string

bill_to

string

id

intervention_code

string

intervention_fund

string

intervention_name

string

intervention_overall_tariff

number

intervention_payment_mechanism

string

is_switched_intervention

boolean

keph_level_tarrif

number

needs_preauth

boolean

optional_document_type

string[]

optional_preauth_document_types

string[]

preauth_exist

boolean

required_preauth_document_types

string[]

requires_oncology_preauth

boolean

requires_optical_preauth

boolean

requires_radiology_preauth

boolean

requires_renal_preauth

boolean

requires_surgical_preauth

boolean

sub_benefit_code

string

supported_scheme

string

switched_intervention_id

integer

switched_lines_retained

boolean

workflow_state

string

internal_domain_claims.doctorReviewStatus

string · enum

Enum values:

PENDING

APPROVED

REJECTED

PENDING_DOCTOR_REVIEW

internal_domain_claims.ClaimDoctor

doctor_request_status

string · enum

Enum values:

PENDING

APPROVED

REJECTED

PENDING_DOCTOR_REVIEW

slade_code

string

internal_domain_claims.InvoiceFlag

code

string

description

string

edi_flag_guid

string

edi_flag_id

integer

existing

string

flag_type

string

invoice

string

is_resolved

boolean

message

string

payload

string

response

string

timestamp

string

traceback

string

internal_domain_claims.InvoiceLine

attributes

string

bill_from

string

bill_to

string

charge_date

string

discount

number

discount_reason

string

doctor_code

string

doctor_name

string

id

string

intervention_code

string

invoice

string

is_active

boolean

is_cancellation

boolean

is_return

boolean

item_code

string

item_name

string

line_copay

number

line_net_amount

number

line_number

string

line_total_amount

number

linked_invoice_line

string

map_request

string

map_request_description

string

mapped_slade_code

string

nhif_rebate_amount

number

patient_discount_amount

number

patient_net_price

number

pmf_line_status

string

quantity

number

scheme_code

string

scheme_name

string

sponsor_net_price

number

uhc_exceeded

boolean

unit

string

unit_price

number

internal_domain_claims.Invoice

created_by_name

string

department

string

discount_amount

number

dispatch_batch_number

string

dispatch_status

string

object[]

edi_invoice_guid

string

edi_invoice_id

integer

id

string

invoice_date

string

object[]

invoice_number

string

invoice_type

string

object[]

linked_invoice

string

linked_invoice_line

string

member_name

string

patient_name

string

patient_number

string

provider_invoice_ref

string

provider_name

string

scheme_code

string

scheme_name

string

scu_branch_id

string

scu_dispatch_timestamp

string

scu_receipt_signature

string

service_type

string

total_inv_amount

number

total_inv_copay

number

total_inv_discount

number

total_inv_net_amount

number

visit_end

string

visit_start

string

workflow_state

string

internal_domain_claims.ClaimAuthorization

admitted_on

string

appointment_number

string

attributes

string

authorization_code

string

authorization_guid

string

beneficiary_guid

string

beneficiary_id

integer

beneficiary_is_fuzzy_matched

boolean

cancel_reason_text

string

cancel_reason_type

string

claim_attachments_count

integer

claim_auth_status

string

object[]

claim_id

integer

created_by_name

string

currency

string

diagnoses_count

integer

discharge_cancel_date

string

discharge_cancel_remarks

string

discharge_reason

string

discharged_on

string

edi_claim_guid

string

emergency_visit_expiry

string

estimate_ip_days

integer

expected_discharge_date

string

has_reviewed_claim

boolean

id

initial_intervention

string

object[]

invoice_attachments_count

integer

invoice_id

string

invoice_number

string

object[]

is_charge_master_mapped

boolean

is_negative

boolean

is_resubmitted

boolean

is_zero

boolean

last_retry

string

location_code

string

location_name

string

member_name

string

member_number

string

member_number_has_token

boolean

mode_of_arrival

string

nhif_number

string

notes

string

number_of_invoices

integer

patient_name

string

patient_number

string

payer_code

string

payer_name

string

payer_slade_code

policy_number

string

policy_valid_from

string

policy_valid_to

string

provider_name

string

provider_slade_code

string

reason_for_unknown_patient

string

reference_number

string

resubmission_workflow_state

string

retry_count

integer

scheme_code

string

scheme_name

string

service_type

string

total_claim_amount

number

total_claim_copay

number

total_claim_discount

number

total_claim_net_amount

number

total_claim_splits

number

updated_by_name

string

visit_end

string

visit_number

string

visit_start

string

workflow_state

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.RegulationBody

string · enum

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.AddDiagnosisRequest

consent_token

string · required

Beneficiary consent token authorizing the diagnosis to be added.

Example: K5HLPJVDNV

icd_code

string · required

ICD-11 diagnosis code being added to the claim.

Example: ca07.0

intervention_code

string · required

SHA intervention (benefit package) code the diagnosis is associated with.

Example: SHA-18-005

practitioner_identification_number

string

Optional. Identification number of the attending practitioner (doctor). Provide the identification number, identification type and regulation body together to attach the doctor to the claim if they were not added before. The same doctor details can be supplied through any of the three endpoints — Create Virtual Claim, Add Diagnosis, or Add Billable Line Item. Example is dummy data.

Example: A00000

practitioner_identification_type

string · enum

Optional. Type of identifier used for the attending practitioner (doctor).

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_regulation_body

string · enum

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemoveClaimDiagnosisRequest

Request payload for removing a diagnosis from a virtual claim.

consent_token

string · required

Patient consent token authorising the change.

Example: K5HLPJVDNV

icd_code

string · required

ICD-11 code of the diagnosis to remove from the claim.

Example: ca07.0

intervention_code

string · required

SHA intervention code the diagnosis is linked to.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PatientDischargeReason

string · enum

Enum values:

RECOVERED

REFERRED

DECEASED

ABSCONDED

OTHER

Example: RECOVERED

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PatientDischargeRequest

consent_token

string · required

Patient consent token authorising the discharge.

Example: K5HLPJVDNV

discharge_auth_guid

string

Identifier of the discharge authorisation associated with the request.

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

discharge_date

string

Date and time the patient was discharged.

Example: 2026-06-08T20:30:00+03:00

discharge_reason

string · enum

Enum values:

RECOVERED

REFERRED

DECEASED

ABSCONDED

OTHER

Example: RECOVERED

invoice_number

string

Facility invoice number for the inpatient episode.

Example: IP/783/33956

otp

string

One-time password used to verify the request where required.

Example: 123456

ResendPreauthDoctorRequest

Resend a doctor approval request for a preauthorization.

practitioner_registration_number

string · required

Registration number of the doctor whose approval is being requested. Example is dummy data.

Example: A00000

request_type

string · enum · required

Type of doctor request. Use PREAUTH_DOCTOR_APPROVAL_REQUEST for preauthorizations.

Enum values:

PREAUTH_DOCTOR_APPROVAL_REQUEST

Example: PREAUTH_DOCTOR_APPROVAL_REQUEST

consent_token

string · required

Patient consent token authorising the doctor request.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the request is issued against.

Example: SHA-11-001

ResendEmergencyClaimDoctorRequest

Resend a doctor approval request for an emergency claim. The claim is identified by `emergency_claim_id` (with its `created` timestamp) and the doctor by the identification fields, which are resolved against the Health Worker Registry. Do not include `service_type` - that field selects a different request shape.

request_type

string · enum · required

Type of doctor request. Use EMERGENCY_CLAIM_DOCTOR_APPROVAL_REQUEST for emergency claims.

Enum values:

EMERGENCY_CLAIM_DOCTOR_APPROVAL_REQUEST

Example: EMERGENCY_CLAIM_DOCTOR_APPROVAL_REQUEST

consent_token

string · required

Consent token of the emergency claim's authorization. The authorization must be active (authorized or emergency-authorized) and belong to the requesting facility.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the request is issued against. Must exist on the emergency claim's authorization.

Example: SHA-01-004

emergency_claim_id

string · required

Identifier of the emergency claim, as returned when the claim was created. Links the doctor's approval response back to the claim.

Example: baf2c4dc-dc65-4b8d-b40b-775dba2d1917

created

string · date-time · required

ISO 8601 timestamp of when the emergency claim was created.

Example: 2026-07-17T10:47:26+03:00

identification_type

string · enum · required

Type of identifier supplied for the doctor.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

identification_number

string · required

Doctor's identification number, matching the identification type. Used to resolve the doctor in the Health Worker Registry. Example is dummy data.

Example: A00000

regulation_body

string · enum · required

Regulatory body the doctor is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

practitioner_registration_number

string

Optional. The doctor's registration number. The emergency flow resolves the doctor from the identification fields above, not this field. Example is dummy data.

Example: A00000

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.PractitionerIdentificationType

string · enum

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.AddEmergencyClaimDoctorRequest

consent_token

string · required

Beneficiary consent token authorizing the doctor to be added to the emergency claim.

Example: K5HLPJVDNV

identification_number

string · required

Identification number of the attending doctor, per the selected identification type. Example is dummy data.

Example: A00000

identification_type

string · enum · required

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum · required

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemoveEmergencyClaimDoctorRequest

consent_token

string · required

Consent token authorising the action on the beneficiary's claim.

Example: K5HLPJVDNV

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.EmergencyModeOfArrival

string · enum

Enum values:

AMBULANCE

WALK-IN

OTHER

AMBULANCE

WALK-IN

OTHER

Example: AMBULANCE

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.EmergencyBroughtBy

string · enum

Enum values:

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

Example: PARAMEDICS

EmergencyClaimBaseRequest

Shared fields for creating an emergency-care claim under the Emergency, Chronic and Critical Illness Fund (ECCIF). Emergency interventions are identified by the SHA-01 code family. Exactly one intervention is billed per emergency claim.

interventions

string[] · required

Emergency intervention code(s) being treated. Emergency interventions belong to the SHA-01 code family; exactly one intervention is sent per emergency claim.

Example: ["SHA-01-005"]

mode_of_arrival

string · enum · required

Enum values:

AMBULANCE

WALK-IN

OTHER

AMBULANCE

WALK-IN

OTHER

Example: AMBULANCE

brought_by

string · enum · required

Enum values:

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

Example: PARAMEDICS

reference_number

string · required

Provider's reference number for the emergency visit.

Example: EMG/1/2026

identification_number

string · required

Identification number of the attending practitioner (doctor). Example is dummy data.

Example: A00000

identification_type

string · enum · required

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum · required

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

notes

string

Optional free-text clinical notes for the emergency presentation.

Example: Patient presented with severe shock following a road traffic accident.

EmergencyClaimIdentifiedRequest

Create an emergency claim for a patient who can be identified at the point of care. Includes the beneficiary CR ID and a patient OTP in addition to the base fields.

interventions

string[] · required

Emergency intervention code(s) being treated. Emergency interventions belong to the SHA-01 code family; exactly one intervention is sent per emergency claim.

Example: ["SHA-01-005"]

mode_of_arrival

string · enum · required

Enum values:

AMBULANCE

WALK-IN

OTHER

AMBULANCE

WALK-IN

OTHER

Example: AMBULANCE

brought_by

string · enum · required

Enum values:

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

Example: PARAMEDICS

reference_number

string · required

Provider's reference number for the emergency visit.

Example: EMG/1/2026

identification_number

string · required

Identification number of the attending practitioner (doctor). Example is dummy data.

Example: A00000

identification_type

string · enum · required

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum · required

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

beneficiary_cr_id

string · required

Client Registry ID of the identified patient.

Example: CR2594484249725-2

otp

string · required

One-time password sent to the patient to consent to the emergency visit.

Example: 123456

notes

string

Optional free-text clinical notes for the emergency presentation.

Example: Patient presented with severe shock following a road traffic accident.

EmergencyClaimUnidentifiedRequest

Create an emergency claim for a patient who cannot be identified at the point of care (for example, brought in unconscious and alone). Omits beneficiary_cr_id and otp; the patient may be identified later using the Identify Unknown Patient variant.

interventions

string[] · required

Emergency intervention code(s) being treated. Emergency interventions belong to the SHA-01 code family; exactly one intervention is sent per emergency claim.

Example: ["SHA-01-005"]

mode_of_arrival

string · enum · required

Enum values:

AMBULANCE

WALK-IN

OTHER

AMBULANCE

WALK-IN

OTHER

Example: AMBULANCE

brought_by

string · enum · required

Enum values:

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

Example: PARAMEDICS

reference_number

string · required

Provider's reference number for the emergency visit.

Example: EMG/1/2026

identification_number

string · required

Identification number of the attending practitioner (doctor). Example is dummy data.

Example: A00000

identification_type

string · enum · required

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum · required

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

notes

string

Optional free-text clinical notes for the emergency presentation.

Example: Patient presented with severe shock following a road traffic accident.

EmergencyIdentifyPatientRequest

Identify a previously-unidentified emergency patient by re-sending the original unidentified payload plus the now-known beneficiary_cr_id, a patient otp, and the consent_token of the unknown claim. Moves the claim from unknown to known; protocols already added are retained.

interventions

string[] · required

Emergency intervention code(s) being treated. Emergency interventions belong to the SHA-01 code family; exactly one intervention is sent per emergency claim.

Example: ["SHA-01-005"]

mode_of_arrival

string · enum · required

Enum values:

AMBULANCE

WALK-IN

OTHER

AMBULANCE

WALK-IN

OTHER

Example: AMBULANCE

brought_by

string · enum · required

Enum values:

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

RELATIVE

UNKNOWN

SAMARITAN

PARAMEDICS

Example: PARAMEDICS

reference_number

string · required

Provider's reference number for the emergency visit.

Example: EMG/1/2026

identification_number

string · required

Identification number of the attending practitioner (doctor). Example is dummy data.

Example: A00000

identification_type

string · enum · required

Enum values:

registration_number

National ID

Alien ID

Refugee ID

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum · required

Enum values:

KMPDC

COC

NCK

PPB

KMPDC

COC

NCK

PPB

Example: KMPDC

beneficiary_cr_id

string · required

Client Registry ID of the now-identified patient.

Example: CR2594484249725-2

otp

string · required

One-time password sent to the patient to consent to the emergency visit.

Example: 123456

consent_token

string · required

Authorization code (consent_token) returned when the unidentified emergency claim was created.

Example: K5HLPJVDNV

notes

string

Optional free-text clinical notes for the emergency presentation.

Example: Patient presented with severe shock following a road traffic accident.

beneficiary_contact_id

string

Optional. ID of the patient contact that the consent OTP was sent to.

Example: 1

internal_domain_claims.Intervention

accessPoint

string

active

boolean

annualQuantityLimit

integer

annualQuantityLimitChoice

string

annualQuantityLimitType

string

applicableDocumentTypes

string[]

applicableFacilityOwnership

string

applicableGender

string

benefit

integer

code

string

comment

string

complexity

string

coverageLevel

string

diagnosisBlock

string[]

diagnosisList

string[]

guid

string

id

integer

investigationTariffHasLimit

boolean

isIntraMetro

boolean

kephLevelTarrif

number

levelsApplicable

string[]

lowerAgeLimit

integer

managementTariffHasLimit

boolean

name

string

needApprovalBeforeClaimSubmission

boolean

needsDoctorAuthorization

boolean

needsManualPreauthApproval

boolean

needsMemberAuthorization

boolean

needsPreauth

boolean

optionalDocumentType

string[]

optionalPreauthDocumentTypes

string[]

overallTariff

number

overallTariffHasLimit

boolean

paymentMechanism

string

preauthFinalised

boolean

protocolUsed

string

requiredPreauthDocumentTypes

string[]

requiresOncologyPreauth

boolean

requiresOpticalPreauth

boolean

requiresRadiologyPreauth

boolean

requiresRenalPreauth

boolean

requiresSurgicalPreauth

boolean

status

string

upperAgeLimit

integer

usageFrequencyLimit

integer

usageFrequencyType

string

internal_domain_claims.Protocol

applicableTariff

string

guid

string

id

integer

object[]

name

string

protocolClassificationType

string

protocolCode

string

protocolType

string

status

string

internal_domain_claims.ProtocolResponse

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

AddEmergencyProtocolRequest

Adds an approved emergency protocol to an emergency claim as a billable line. Sent as a raw JSON body. unit_price must be within the protocol's approved applicableTariff.

consent_token

string · required

Authorization code from emergency claim creation. Signifies an authorised claim.

Example: K5HLPJVDNV

protocol_code

string · required

Code of the approved protocol being billed (from the fetch-protocols response).

Example: PROT-001

intervention_code

string · required

Emergency intervention code the protocol applies to. Emergency interventions belong to the SHA-01 code family.

Example: SHA-01-005

unit_price

string · required

Unit price for the protocol, within the approved applicableTariff. A numeric value sent as a string.

Example: 5000

quantity

string · required

Quantity billed. A numeric value sent as a string.

Example: 1

AddEmergencyProtocolCombinedRequest

Adds an emergency protocol together with diagnoses and supporting document attachments in a single request. Because it carries file uploads, it must be sent as multipart/form-data: the protocol, diagnoses and attachments metadata are form fields, and each attachment's binary file is a separate form part named by its file_field_name (e.g. attachments_0_file_blob). Attachments are at the intervention level and document_type must be from the intervention's applicableDocumentTypes.

consent_token

string · required

Authorization code from emergency claim creation. Signifies an authorised claim.

Example: K5HLPJVDNV

protocol_code

string · required

Code of the approved protocol being billed (from the fetch-protocols response).

Example: PROT-001

intervention_code

string · required

Emergency intervention code the protocol applies to. Emergency interventions belong to the SHA-01 code family.

Example: SHA-01-005

unit_price

string · required

Unit price for the protocol, within the approved applicableTariff. A numeric value sent as a string.

Example: 5000

quantity

string · required

Quantity billed. A numeric value sent as a string.

Example: 1

diagnoses

string[]

JSON array of ICD-11 diagnosis codes for the emergency intervention. Sent as a JSON-encoded string in the multipart form.

Example: ["QB95.Z"]

object[]

Attachment metadata as a JSON-encoded string. Each entry's file_field_name references a separate binary file part in the same multipart request.

Example: [{"document_title":"Case Notes","document_type":"DISCHARGE_SUMMARY","file_field_name":"attachments_0_file_blob"}]

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.AddInterventionInput

consent_token

string · required

Beneficiary consent token authorizing the intervention to be added.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention (benefit package) code being added to the claim or preauthorization.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RestoreInterventionInput

consent_token

string · required

Consent token authorising the action on the beneficiary's preauthorisation.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code to restore.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RetireInterventionInput

consent_token

string · required

Consent token authorising the action on the beneficiary's preauthorisation.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code to retire.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.SwitchInterventionRequest

consent_token

string · required

Consent token authorising the intervention switch.

Example: K5HLPJVDNV

existing_intervention_code

string · required

SHA intervention code currently in use, to be switched from.

Example: SHA-18-005

new_intervention_code

string · required

SHA intervention code to switch to.

Example: SHA-18-006

retain_bill_items

boolean · required

Whether to keep the existing bill items on the new intervention.

Example: true

bill_from

string · date-time

Start of the billing period for the switched intervention, as an ISO 8601 date-time.

Example: 2026-04-23T13:30:00+03:00

bill_to

string · date-time

End of the billing period for the switched intervention, as an ISO 8601 date-time.

Example: 2026-04-23T13:30:00+03:00

SingleLineItemRequest

Adds a single billable line item to a claim's invoice. Sent as a raw JSON body. Optionally include the attending practitioner's details by supplying the three practitioner fields together.

consent_token

string · required

Authorization code from claim creation. Signifies an authorised claim.

Example: 8EUTW6AQF5

intervention_code

string · required

Intervention code for the service being billed.

Example: SHA-09-021

unit_price

string · required

Unit price of the service. A numeric value sent as a string.

Example: 300

quantity

string · required

Quantity billed. A numeric value sent as a string.

Example: 1

service_name

string

Human-readable name of the service being billed.

Example: Basic consultation

service_identifier

string

Facility's own identifier for the service.

Example: C/123

practitioner_identification_type

string · enum

Optional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the line.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_identification_number

string

Example: A00000

practitioner_regulation_body

string · enum

Optional. Regulation body the attending practitioner is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

CombinedBillingRequest

Adds a billable line item together with diagnoses and supporting document attachments in a single request. Because it carries file uploads, it must be sent as multipart/form-data: the line, diagnoses and attachments metadata are form fields, and each attachment's binary file is a separate form part named by its file_field_name (e.g. attachments_0_file_blob).

consent_token

string · required

Authorization code from claim creation. Signifies an authorised claim.

Example: 8EUTW6AQF5

intervention_code

string · required

Intervention code for the service being billed.

Example: SHA-09-021

unit_price

string · required

Unit price of the service. A numeric value sent as a string.

Example: 300

quantity

string · required

Quantity billed. A numeric value sent as a string.

Example: 1

service_name

string

Human-readable name of the service being billed.

Example: Basic consultation

service_identifier

string

Facility's own identifier for the service.

Example: C/123

practitioner_identification_type

string · enum

Optional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the line.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_identification_number

string

Example: A00000

practitioner_regulation_body

string · enum

Optional. Regulation body the attending practitioner is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

diagnoses

string[]

JSON array of ICD-11 diagnosis codes for the service. Sent as a JSON-encoded string in the multipart form.

Example: ["QB95.Z"]

object[]

Attachment metadata as a JSON-encoded string. Each entry's file_field_name references a separate binary file part in the same multipart request.

Example: [{"document_title":"Lab Results","document_type":"FINAL_BILL","file_field_name":"attachments_0_file_blob"},{"document_title":"Discharge Summary","document_type":"DISCHARGE_SUMMARY","file_field_name":"attachments_1_file_blob"}]

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemoveClaimLineRequest

Request payload for removing a line item from a virtual claim.

consent_token

string · required

Patient consent token authorising the change.

Example: K5HLPJVDNV

line_guid

string · required

GUID of the claim line item to remove.

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.EditClaimLineRequest

Request payload for editing an existing line item in a virtual claim.

consent_token

string · required

Patient consent token authorising the claim line edit.

Example: K5HLPJVDNV

line_id

string · required

Unique identifier of the claim line item to edit.

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

quantity

integer

Updated quantity for the claim line item.

Example: 2

unit_price

string

Updated unit price for the claim line item, in KES.

Example: 1500

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ResubmitClaimLineRequest

Request payload for resubmitting a claim line that was previously rejected or failed.

consent_token

string · required

Consent token authorising resubmission of the claim line.

Example: K5HLPJVDNV

internal_domain_claims.ResubmitClaimLineResponse

line_id

string

message

string

resubmitted_at

string

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PreviewClaimRequest

Request payload for previewing a virtual claim before submission. Requires consent token.

consent_token

string · required

Consent token from the authorization/visit step, identifying the claim to preview.

Example: K5HLPJVDNV

internal_domain_claims.ProviderClaimDoctor

claim

string

doctor_name

string

id

string

internal_domain_claims.ClaimPreview

authorization_code

string

object[]

claim_attachments_count

integer

claim_auth_status

string

object[]

created_by_name

string

diagnoses_count

integer

id

string

object[]

invoice_attachments_count

integer

object[]

is_negative

boolean

is_zero

boolean

member_number

string

number_of_invoices

integer

patient_name

string

patient_number

string

provider_name

string

scheme_code

string

scheme_name

string

service_type

string

total_claim_amount

number

total_claim_copay

number

total_claim_discount

number

total_claim_net_amount

number

total_claim_splits

number

visit_end

string

visit_start

string

workflow_state

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Intervention

activeForUhc

boolean

array

applicableSchemes

string[]

authInterventionId

integer

code

string

dispenseMedication

boolean

fallBackKephLevelTariff

number

fund

string

id

integer

array

kephLevelTarrif

number

name

string

needsPreauth

boolean

numberOfDaysToFallback

integer

overallTariff

number

array

paymentMechanism

string

preauthFinalised

boolean

prescriptionMedication

boolean

requiresSurgicalPreauth

boolean

array

subBenefitCode

string

supportedScheme

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.MinimalAuthorizationDetails

authorizingDeviceOs

string

beneficiaryCode

string

beneficiaryName

string

beneficiaryNumber

string

biometricMatchLogId

string

ekycToken

string

guid

string

object[]

isBiometricsDischargeAuthorization

boolean

isElective

boolean

isOpen

boolean

parentAuthorization

integer

parentType

string

object

sessionType

string

shaGuid

string

shaVerificationRequestId

string

status

string

token

string

workStationId

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.ElectivePreauth

doctorReviewStatus

string

isElective

boolean

memberName

string

preauthType

string

serviceEnd

string

serviceStart

string

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Cover

group

string

groupCode

string

jobGroup

string

validFrom

string

validTo

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Member

age

integer

beneficiaryCode

string

gender

string

group

string

idNo

string

idNoType

string

isAlive

boolean

isMinor

boolean

isPrincipal

boolean

names

string

object

principalRelationship

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.EligibilityDetails

object

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.ShaVerificationRequest

EmbedExpiry

integer

embededToken

string

requestId

string

requestUrl

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.AuthorizationDetails

authCode

string

authorizationReason

string

authorizationType

string[]

authorizingDeviceOs

string

beneficiary

integer

beneficiaryCode

string

beneficiaryName

string

beneficiaryNumber

string

beneficiaryScheme

string

benefitType

string

biometricMatchLogId

string

object[]

createdByName

string

dateAuthorized

string

ekycToken

string

object

eligibility

string

object

endDate

string

endedVia

string[]

expiry

string

guardian

string

guid

string

id

integer

interventions

array · gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Intervention (circular)

isBiometricsDischargeAuthorization

boolean

isComplete

boolean

isElective

boolean

isOpen

boolean

label

string

needsPreauth

boolean

notes

string

overallPreauthFinalised

boolean

parentAuthorization

integer

parentPreauth

circular

parentType

string

payerName

string

payerSladeCode

integer

preauthIds

integer[]

object

provider

integer

providerFid

string

providerName

string

requestedBy

string

sessionType

string

shaGuid

string

object

shaVerificationRequestId

string

status

string

token

string

workStationId

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Identifier

identifier

string

identifierType

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.SchemeCode

string · enum

Enum values:

UHC

PMF

BOTH

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.BeneficiaryDetails

DoB

string

beneficiaryCode

string

beneficiaryId

integer

categoryCode

string

categoryName

string

firstName

string

gender

string

guid

string

object[]

lastName

string

otherNames

string

schemeCode

string · enum

Enum values:

UHC

PMF

BOTH

schemeName

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.InterventionData

code

string

fallBackKephLevelTariff

number

guid

string

id

integer

kephLevelTarrif

number

name

string

numberOfDaysToFallback

integer

overallTariff

number

paymentMechanism

string

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.DocumentType

string · enum

Enum values:

BIOPSY_RESULT

CASE_NOTES_JUSTIFYING_ADMISSION

CASE_NOTES_INDICATING_NEED_FOR_DEVICE

CASE_SUMMARY

CLINICAL_DOCUMENTATION

CRITICAL_CARE_UNIT_CASE_NOTES

CONSULTANT_REPORT

DIAGNOSTIC_REQUESTS

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.PreauthAttachment

attachment

integer

attachmentType

string · enum

Enum values:

BIOPSY_RESULT

CASE_NOTES_JUSTIFYING_ADMISSION

CASE_NOTES_INDICATING_NEED_FOR_DEVICE

CASE_SUMMARY

CLINICAL_DOCUMENTATION

CRITICAL_CARE_UNIT_CASE_NOTES

CONSULTANT_REPORT

DIAGNOSTIC_REQUESTS

author

string

authorEmail

string

authorName

string

contentType

string

description

string

guid

string

id

integer

interventionCode

string

organisationName

string

source

string

title

string

uploadedFile

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.PreauthDiagnosis

authorizationIntervention

string

description

string

guid

string

id

integer

interventionCode

string

interventionName

string

name

string

preauthDiagnosisType

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

siteCode

string

siteCodeType

string

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Contact

active

boolean

businessPartner

canSendComm

boolean

contactName

string

contactType

string

contactValue

string

deactivationReason

string

guid

string

id

integer

isConfirmed

boolean

role

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.DoctorProfile

active

boolean

object[]

country

string

currencyCode

string

guid

string

id

integer

object[]

name

string

nationalIdentifier

string

practitionerCadre

string

practitionerDisciplineName

string

practitionerGender

string

practitionerIdNumber

string

practitionerIdType

string

practitionerInHealthWorkerRegistry

boolean

practitionerLicenceNumber

string

practitionerLicenceStart

string

practitionerLicenceType

string

practitionerLicenceValidity

string

practitionerLicenseBody

string

practitionerLicenseStatus

string

practitionerPostalAddress

string

practitionerQualifications

string

practitionerRegistrationNumber

string

practitionerRegistryId

string

practitionerSpecialty

string

practitionerSubSpecialty

string

practitionerType

string

sladeCode

integer

specialty

string[]

suspended

boolean

suspensionReason

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.PreauthDoctor

object

doctorReviewStatus

string

doctorType

string

guid

string

hospitalDoctorName

string

id

integer

isHospitalDoctor

boolean

name

string

notes

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

sladeCode

integer

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.PreauthItem

approvedAmount

number

approvedBy

string

approvedByName

string

approvedQuantity

string

approvedUnitPrice

number

category

string

chargeDate

string

cmCode

string

description

string

estimatedAmount

number

guid

string

id

integer

intervention

string

interventionCode

string

interventionName

string

name

string

payerInvoiceLineNo

string

providerCurrency

string

quantity

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

schemeCode

string · enum

Enum values:

UHC

PMF

BOTH

schemeName

string

status

string

unitPrice

number

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.PreauthNote

author

string

authorEmail

string

authorName

string

guid

string

id

integer

note

string

organisationName

string

source

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.ProviderDetails

active

boolean

bpLevel

string

businessPartnerId

integer

guid

string

object[]

name

string

nationalIdentifier

string

sladeCode

integer

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.CarcinomaStage

string · enum

Enum values:

STAGE_1

STAGE_2

STAGE_3

STAGE_4

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.Metastasis

string · enum

Enum values:

LUNG

LIVER

BRAIN

BONE

OTHER

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_shared.TreatmentSetting

string · enum

Enum values:

DAY_WARD

SIDE_ROOM

RECLINING_CHAIR

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.RequestExtraData

anaesthesiaType

string

carcinomaStaging

string · enum

Enum values:

STAGE_1

STAGE_2

STAGE_3

STAGE_4

chiefComplaint

string

clinicalIndications

string

coinsuranceDetails

string

comorbidity

string

conditionEmploymentRelated

boolean

conditionOtherRelated

boolean

consultationDescription

string

costPerSession

number

eyeExaminationAmount

number

eyeExaminationDescription

string

frameAmount

number

frameDescription

string

hasCoinsurance

boolean

hpi

string

investigations

string

lensAmount

number

lensDescription

string

lensPrescription

string

metastases

string[]

Enum values:

LUNG

LIVER

BRAIN

BONE

OTHER

physicalExamination

string

progressReport

string

reasonForService

string

replacement

string

sessionExpectedDate

string

sessionsFrequency

string

sessionsRequired

integer

subType

string

treatmentSetting

string[]

Enum values:

DAY_WARD

SIDE_ROOM

RECLINING_CHAIR

vitalSigns

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.ResponseExtraData

finalizeNote

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_domain_preauth.Preauth

accessPoint

string

anaesthesiaType

string

authorization

integer

object

carcinomaStaging

string

clinicalIndications

string

comorbidity

string

conditionCause

string

conditionEmploymentRelated

boolean

conditionOtherRelated

boolean

costPerSession

string

countdown

integer

createdByName

string

description

string

doctorApproved

boolean

doctorReviewStatus

string

finalApprovedAmount

number

guid

string

id

integer

interventionCode

string

object

isElective

boolean

isEmergency

boolean

isHmisPreauth

boolean

isOncology

boolean

isOptical

boolean

isRadiology

boolean

isRenal

boolean

isRequestPhase

boolean

isResponsePhase

boolean

isSurgical

boolean

lengthOfStay

integer

memberIdentifier

string

memberIsVip

boolean

memberIsVvip

boolean

memberName

string

memberScheme

string

metastases

string

needsDoctorApproval

boolean

numberOfPreauthDoctorsRequired

integer

otherMetastases

string

payerIdentifier

string

payerInvoiceNo

string

payerName

string

object[]

array

object[]

preauthType

string

providerConsent

boolean

providerCurrency

string

object

providerName

string

providerNotificationEmail

string

reasonForAcuteDialysis

string

reasonForSelectingOther

string

object

serviceEnd

string

serviceStart

string

sessionExpectedDate

string

sessionType

string

sessionsFrequency

string

sessionsRequired

integer

status

string

submissionDateIn_EAT

string

token

string

totalEstimatedAmountForPreauth

number

totalInterimApprovedAmountForPreauth

number

updatedByName

string

internal_domain_claims.PayerAuthorization

guid

string · required

id

integer · required

authCode

string

authorizationReason

string

authorizationType

string[]

beneficiaryCode

string

beneficiaryJoinDate

string

beneficiaryName

string

beneficiaryNumber

string

beneficiaryScheme

string

benefitType

string

created

string

createdByName

string

currentAvailableBalance

number

expiry

string

object[]

isComplete

boolean

isElective

boolean

isOpen

boolean

label

string

needsPreauth

boolean

notes

string

overallPreauthFinalised

boolean

owner

integer

parentAuthorization

integer

object

parentType

string

policyEffectiveDate

string

preauthIds

integer[]

providerName

string

requestedBy

string

sessionType

string

status

string

token

string

totalAuthorizedAmount

number

internal_domain_claims.DoctorProfile

practitionerCadre

string

practitionerGender

string

practitionerLicenceNumber

string

practitionerLicenceValidity

string

practitionerLicenseBody

string

practitionerQualifications

string

practitionerRegistrationNumber

string

practitionerRegistryId

string

internal_domain_claims.PayerClaimDoctor

object

name

string

internal_domain_claims.ClaimFlag

code

string

description

string

flagType

string

guid

string

id

integer

isResolved

boolean

message

string

workflowState

string

internal_domain_claims.PayerClaimLine

approvedLineTotal

number

billFrom

string

billTo

string

billingCode

string

chargeDate

string

claimLineGrossTotal

number

claimLineTotal

number

guid

string

id

integer

intervention

integer

interventionCode

string

interventionName

string

name

string

providerClaimLineNo

string

quantity

number

rejectedLineTotal

number

schemeCode

string

schemeName

string

unit

string

unitPrice

number

workflowState

string

internal_domain_claims.ClaimNote

author

string

guid

string

id

integer

note

string

source

string

workflowState

string

internal_domain_claims.ClaimTransition

guid

string

id

integer

transitionDate

string

workflowStateFrom

string

workflowStateTo

string

internal_domain_claims.Diagnosis

encounter

integer

encounterGuid

string

guid

string

intervention

integer

name

string

siteCode

string

siteCodeType

string

internal_domain_claims.PayerClaim

object · required

guid

string · required

id

integer · required

actualDeductableCopay

number

authToken

string

billFrom

string

billTo

string

object[]

claimType

string

created

string

object[]

encounter

integer

encounter ID

isCreditNote

boolean

isInpatient

boolean

memberName

string

memberNumber

string

owner

integer

proposedValue

number

proposedValueLessCopays

number

providerClaimNo

string

providerName

string

schemeName

string

totalCopayValue

number

trackingNumber

string

workflowDisplayName

string

workflowState

string

internal_domain_claims.PayerClaimPreview

pageSize

integer

object[]

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.PatientOPDischargeReason

string · enum

Enum values:

RECOVERED

REFERRED

ABSCONDED

OTHER

Reason the outpatient is being discharged. DECEASED is not valid here - it is an inpatient discharge reason, supplied on POST /claims/discharge.

Example: RECOVERED

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.DischargeStatus

string · enum

Enum values:

PARTIAL

FULL

Whether this call completes the visit or only discharges the patient. FULL (the default) discharges the patient and immediately submits the claim to SHA, running all submission validations. PARTIAL takes consent and records the discharge reason so the patient can leave, but holds the claim back so the facility can finish assembling documentation, then submit it with a second call carrying FULL.

Example: FULL

SubmitClaimBaseRequest

Shared fields for submitting a virtual claim. Every submission carries the consent token authorising it, the provider invoice number and the reason the patient is being discharged.

consent_token

string · required

Consent token authorising submission of the virtual claim.

Example: K5HLPJVDNV

invoice_number

string · required

Provider invoice number for the claim. Required on every submission, including the first call of a partial discharge.

Example: OPD/1/23

discharge_reason

string · enum · required

Reason the outpatient is being discharged. DECEASED is not valid here - it is an inpatient discharge reason, supplied on POST /claims/discharge.

Enum values:

RECOVERED

REFERRED

ABSCONDED

OTHER

Example: RECOVERED

discharge_status

string · enum

Enum values:

PARTIAL

FULL

Example: FULL

notes

string

Free-text notes accompanying the claim submission. Recorded only on the authorised (non-emergency) submission path.

Example: Patient stable on discharge.

SubmitClaimStandardRequest

Submit an ordinary outpatient claim for an identified patient. The visit end must be authorised by the patient through one of two alternative paths: supply `otp` for the OTP path (optionally with `beneficiary_contact_id` naming the contact the OTP was sent to), or supply `discharge_auth_guid` for the biometrics path. Supply one path, not both.

consent_token

string · required

Consent token authorising submission of the virtual claim.

Example: K5HLPJVDNV

invoice_number

string · required

Provider invoice number for the claim. Required on every submission, including the first call of a partial discharge.

Example: OPD/1/23

discharge_reason

string · enum · required

Reason the outpatient is being discharged. DECEASED is not valid here - it is an inpatient discharge reason, supplied on POST /claims/discharge.

Enum values:

RECOVERED

REFERRED

ABSCONDED

OTHER

Example: RECOVERED

discharge_status

string · enum

Enum values:

PARTIAL

FULL

Example: FULL

notes

string

Free-text notes accompanying the claim submission. Recorded only on the authorised (non-emergency) submission path.

Example: Patient stable on discharge.

otp

string

One-time password used to confirm the patient's consent to close the visit. Use this on the OTP authorisation path.

Example: 123456

beneficiary_contact_id

string

Identifier of the beneficiary contact the discharge OTP was sent to (the id from Get OTP Contacts, not a phone number). Optional even on the OTP path. Omit it on the biometrics path, where discharge_auth_guid is used instead.

Example: BC-001

discharge_auth_guid

string

GUID of the discharge authorisation associated with the visit. Use this on the biometrics authorisation path, in place of otp.

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

SubmitClaimEmergencyIdentifiedRequest

Submit an emergency claim for a patient who has been identified. The base fields are all that is read: the visit-end authorisation fields (`otp`, `beneficiary_contact_id`, `discharge_auth_guid`, `notes`) are skipped for emergency claims. The gate here is doctor consent instead - the claim's doctor consent status must be `APPROVED` before the submission is accepted.

consent_token

string · required

Consent token authorising submission of the virtual claim.

Example: K5HLPJVDNV

invoice_number

string · required

Provider invoice number for the claim. Required on every submission, including the first call of a partial discharge.

Example: OPD/1/23

discharge_reason

string · enum · required

Reason the outpatient is being discharged. DECEASED is not valid here - it is an inpatient discharge reason, supplied on POST /claims/discharge.

Enum values:

RECOVERED

REFERRED

ABSCONDED

OTHER

Example: RECOVERED

discharge_status

string · enum

Enum values:

PARTIAL

FULL

Example: FULL

notes

string

Free-text notes accompanying the claim submission. Recorded only on the authorised (non-emergency) submission path.

Example: Patient stable on discharge.

SubmitClaimEmergencyUnidentifiedRequest

Submit an emergency claim for a patient who is still unidentified at submission. Identical to the identified variant plus a mandatory `reason_for_unknown_patient`: the submission is rejected without it. Doctor consent must be `APPROVED`, and the visit-end authorisation fields are not read.

consent_token

string · required

Consent token authorising submission of the virtual claim.

Example: K5HLPJVDNV

invoice_number

string · required

Provider invoice number for the claim. Required on every submission, including the first call of a partial discharge.

Example: OPD/1/23

discharge_reason

string · enum · required

Reason the outpatient is being discharged. DECEASED is not valid here - it is an inpatient discharge reason, supplied on POST /claims/discharge.

Enum values:

RECOVERED

REFERRED

ABSCONDED

OTHER

Example: RECOVERED

reason_for_unknown_patient

string · enum · required

Reason the patient could not be identified. Required when submitting an emergency claim for a patient who is still unidentified at submission.

Enum values:

SHA_UNREGISTERED

DECEASED

Example: SHA_UNREGISTERED

discharge_status

string · enum

Enum values:

PARTIAL

FULL

Example: FULL

notes

string

Free-text notes accompanying the claim submission. Recorded only on the authorised (non-emergency) submission path.

Example: Patient stable on discharge.

SubmitClaimFinalisePartialRequest

The second call of a partial discharge. Once a visit has been discharged with `discharge_status: PARTIAL`, this call submits the held claim to SHA. It needs nothing but the consent token and `discharge_status: FULL` - no fresh consent, no OTP, no discharge reason and no invoice number, because all of those were taken on the first call. The submission validations deferred by the first call run now. The claim must still be in a draft-like state and must not be a resubmission, otherwise the call is rejected.

consent_token

string · required

Consent token of the visit that was partially discharged.

Example: K5HLPJVDNV

discharge_status

string · enum · required

Must be FULL to finalise the partial discharge and submit the claim.

Enum values:

FULL

Example: FULL

OTPVisitRequest

Request payload for starting a visit using OTP-based consent. The patient's one-time password is provided to confirm consent before the claim is created.

intervention_codes

string[] · required

Intervention code(s) for the service scheduled to be offered.

Example: ["SHA-12-001"]

patient_id

string · required

Client Registry identifier of the beneficiary associated with the patient. Example is dummy data.

Example: CR2594484249725-2

service_type

string · enum · required

Type of service being initiated.

Enum values:

CAPITATION

OUTPATIENT

INPATIENT

EMERGENCY

Example: OUTPATIENT

otp

string · required

One-time password sent to the beneficiary's registered contact.

Example: 123456

practitioner_identification_type

string · enum

Optional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the claim.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_identification_number

string

Example: A00000

practitioner_regulation_body

string · enum

Optional. Regulation body the attending practitioner is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

BiometricsVisitRequest

Request payload for starting a visit using biometrics-based consent. The authorization GUID from the preceding biometric authorization is provided in place of an OTP.

intervention_codes

string[] · required

Intervention code(s) for the service scheduled to be offered.

Example: ["SHA-12-001"]

patient_id

string · required

Client Registry identifier of the beneficiary associated with the patient. Example is dummy data.

Example: CR2594484249725-2

service_type

string · enum · required

Type of service being initiated.

Enum values:

CAPITATION

OUTPATIENT

INPATIENT

EMERGENCY

Example: INPATIENT

auth_guid

string · required

Unique authorization identifier issued when the patient's biometric consent was captured. Obtained from the response of POST /api/v1/claims/authorize.

Example: 233e623d-9193-40e3-ac87-352752fe1f96

practitioner_identification_type

string · enum

Optional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the claim.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_identification_number

string

Example: A00000

practitioner_regulation_body

string · enum

Optional. Regulation body the attending practitioner is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

MatchVisitRequest

Request payload for starting a visit for a minor whose consent was attested by a fingerprint match. The `match_id` of the completed match is provided in place of an OTP or an authorization GUID, and the gateway mints the authorization itself from the match it validated.

intervention_codes

string[] · required

Intervention code(s) for the service scheduled to be offered.

Example: ["SHA-12-001"]

patient_id

string · required

Client Registry identifier of the minor the visit is for, including the dependant suffix. It must be the same value sent as health_id when the match was requested; the gateway compares the two and refuses a mismatch. Example is dummy data.

Example: CR2594484249725-2

service_type

string · enum · required

Type of service being initiated.

Enum values:

CAPITATION

OUTPATIENT

INPATIENT

EMERGENCY

Example: OUTPATIENT

match_id

string · required

Example: 9f2c1d4e-6b8a-4c37-9f10-2a5b7c3d8e41

practitioner_identification_type

string · enum

Optional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the claim.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

practitioner_identification_number

string

Optional. Identification number of the attending practitioner (doctor). Provide the identification number, identification type and regulation body together to attach the doctor to the claim if they were not added before. The same doctor details can be supplied through any of the three endpoints - Create Virtual Claim, Add Diagnosis, or Add Billable Line Item. Example is dummy data.

Example: A00000

practitioner_regulation_body

string · enum

Optional. Regulation body the attending practitioner is registered with.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

internal_domain_tenants.BedOccupancyRate

dialysis_visits

integer

hdu_visits

integer

icu_visits

integer

newborn_visits

integer

normal_ip_visits

integer

number_of_baby_cot

integer

number_of_dialysis_bed

integer

number_of_hdu_bed

integer

number_of_icu_bed

integer

number_of_normal_bed

integer

total_ip_visits

integer

total_number_of_bed

integer

internal_domain_tenants.FacilityOccupancy

object

bp_level

string

name

string

internal_domain_patients.BenefitResult

parentBenefit

string

parentBenefitCode

string

internal_domain_patients.Benefit

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

internal_domain_patients.Intervention

accessPoint

string

active

boolean

annualLimitValue

number

annualQuantityLimit

integer

annualQuantityLimitChoice

string

annualQuantityLimitType

string

applicableDocumentTypes

string[]

applicableFacilityOwnership

string

applicableGender

string

applicableSchemes

string[]

benefit

integer

benefitCode

string

benefitName

string

code

string

comment

string

complexity

string

coverageLevel

string

diagnosisBlock

string[]

diagnosisList

string[]

fallBackLevel2Tariff

number

fallBackLevel3Tariff

number

fallBackLevel4Tariff

number

fallBackLevel5Tariff

number

fallBackLevel6Tariff

number

fallBackOverallTariff

number

fund

string

guid

string

id

integer

investigationTariff

number

investigationTariffHasLimit

boolean

isIntraMetro

boolean

kephLevelTarriff

number

level2Tariff

number

level3Tariff

number

level4Tariff

number

level5Tariff

number

level6Tariff

number

levelsApplicable

string[]

lowerAgeLimit

integer

managementTariff

number

managementTariffHasLimit

boolean

name

string

needApprovalBeforeClaimSubmission

boolean

needsDoctorAuthorization

boolean

needsManualPreauthApproval

boolean

needsMemberAuthorization

boolean

needsPreauth

boolean

numberOfDaysToFallback

integer

numberOfDoctorsRequired

integer

optionalDocumentTypes

string[]

optionalPreauthDocumentTypes

string[]

overallTariff

number

overallTariffHasLimit

boolean

parentBenefitCode

string

parentBenefitName

string

paymentMechanism

string

preauthFinalised

boolean

protocolUsed

string

requiredPreauthDocumentTypes

string[]

requiresOncologyPreauth

boolean

requiresOpticalPreauth

boolean

requiresRadiologyPreauth

boolean

requiresRenalPreauth

boolean

requiresSurgicalPreauth

boolean

status

string

supportedScheme

string

tariffLimitPerIndividual

number

tariffPerAdditionalKilometer

number

upperAgeLimit

integer

usageFrequencyLimit

integer

usageFrequencyType

string

internal_domain_patients.InterventionResponse

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

internal_domain_patients.IntermediatePeriodUsage

individualMaxDuringPeriod

integer

individualUtilisedDuringPeriod

integer

lastUsageDate

string

period

string

internal_domain_patients.ComputationalDetail

coverageEndDate

string

coverageStartDate

string

eligibility

boolean

householdLimitAvailableCount

integer

individualLimitAvailableCount

integer

object

limitAvailableAmount

number

nextAvailableDate

string

internal_domain_patients.FundUtilization

availableAmount

number

fundType

string

maxAmount

number

utilisedAmount

number

internal_domain_patients.PatientUtilizationResponse

code

string

object

crId

string

object[]

householdMaxLimit

integer

householdUtilisedLimit

integer

individualMaxLimit

integer

individualUtilisedLimit

integer

limitScope

string

nextAvailability

string

utilizationDays

integer

internal_domain_patients.Coverage

endDate

string

message

string

possibleSolution

string

reason

string

startDate

string

status

string

internal_domain_patients.CoveragePolicy

endDate

string

number

string

startDate

string

internal_domain_patients.EligibilityDetail

jobGroup

string

name

string

internal_domain_patients.PrincipalContributor

crNumber

string

object

employmentType

string

idNumber

string

idType

string

name

string

relationship

string

internal_domain_patients.CoverageScheme

schemeId

integer · required

schemeName

string · required

object

memberType

string

object

internal_domain_patients.CoverageResult

requestIdNumber

string · required

requestIdType

integer · required

age

integer

dateOfBirth

string

facilityBiometricsEnforced

boolean

Whether the facility is required to use biometrics for patient consent. When true, OTP is only available to whitelisted patients.

Example: true

fullName

string

gender

string

isAlive

boolean

Whether the patient is recorded as alive. When false, the patient is deceased and integrators must block all subsequent transactions for the patient.

Example: true

memberCrNumber

string

object[]

statusCode

string

statusDesc

string

whitelistedForOTP

boolean

Whether the patient is whitelisted to use OTP as a consent method (the fallback when biometrics cannot be used).

Example: false

internal_domain_patients.FamilyMember

dateOfBirth

string

Consider using time.Time

email

string

firstName

string

gender

string

householdId

string

isActive

boolean

lastName

string

memberNumber

string

middleName

string

nationalId

string

parentNumber

string

phone

string

phoneCode

string

relationshipType

string

schemeCount

integer

shaNumber

string

title

string

internal_domain_patients.Balance

balance

number

member

string

internal_domain_patients.PMFSubBenefit

object[]

description

string

limit

integer

name

string

subBenefitCode

string

subBenefitGender

string[]

subBenefitId

integer

subBenefitRelation

string[]

subBenefitShared

string

subBenefitWaitingPeriod

type

string

internal_domain_patients.PMFBenefit

object[]

benefitCode

string

benefitGender

string[]

benefitId

integer

benefitRelation

string[]

benefitShared

string

description

string

limit

integer

name

string

object[]

type

string

internal_domain_patients.PMFPolicy

PolicyYear

string

activeDate

string

companyName

string

description

string

endDate

string

hasHospitalCodes

boolean

hasICD10Code

boolean

hasImagingServices

boolean

hasIncludeandExclude

boolean

hasLabtests

boolean

hasMedicalprocedures

boolean

hasMedicines

boolean

hasOpticalServices

boolean

iCD10Type

string

medicalproceduresType

string

name

string

policyCode

string

policyGroup

string

policyId

string

schemeCode

string

schemeName

string

status

string

terminationDate

string

totalBenefit

integer

type

string

internal_domain_patients.MemberPolicy

object[]

dependentCount

string[]

joinDate

string

leaveDate

string

memberOriginalJoinDate

string

parentMemberNumber

string

object

policyJoinDate

string

spouseCount

string[]

status

string

internal_domain_patients.POMSFBalance

dateOfBirth

string

email

string

object[]

firstName

string

gender

string

householdId

string

id

string

lastName

string

memberNumber

string

object[]

middleName

string

nationalId

string

parentNumber

string

phone

string

phoneCode

string

policyCount

integer

registeredOn

string

relationshipType

string

schemeCount

integer

shaNumber

string

title

string

internal_domain_patients.Cover

category

string

categoryCode

string

effectivePolicyNumber

string

group

string

groupCode

string

groupType

string

isEmployerGroup

boolean

jobGroup

string

policyNumber

string

validFrom

string

validTo

string

internal_domain_patients.SubBenefit

accessPoint

string

active

boolean

allowedInterventions

string[]

applicableLimit

string

code

string

object

fund

string

guid

string

id

integer

interventionCombination

string[]

name

string

packageCombination

string[]

parentBenefit

string

parentBenefitCode

string

standaloneInterventions

string[]

status

string

internal_domain_patients.SubBenefitResponse

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

internal_domain_preauth.Intervention

activeForUhc

boolean

array

applicableSchemes

string[]

authInterventionId

integer

code

string

dispenseMedication

boolean

fallBackKephLevelTariff

number

fund

string

id

integer

array

kephLevelTarrif

number

name

string

needsPreauth

boolean

numberOfDaysToFallback

integer

overallTariff

number

array

paymentMechanism

string

preauthFinalised

boolean

prescriptionMedication

boolean

requiresSurgicalPreauth

boolean

array

subBenefitCode

string

supportedScheme

string

internal_domain_preauth.MinimalAuthorizationDetails

authorizingDeviceOs

string

beneficiaryCode

string

beneficiaryName

string

beneficiaryNumber

string

biometricMatchLogId

string

ekycToken

string

guid

string

object[]

isBiometricsDischargeAuthorization

boolean

isElective

boolean

isOpen

boolean

parentAuthorization

integer

parentType

string

object

sessionType

string

shaGuid

string

shaVerificationRequestId

string

status

string

token

string

workStationId

string

internal_domain_preauth.ElectivePreauth

doctorReviewStatus

string

isElective

boolean

memberName

string

preauthType

string

serviceEnd

string

serviceStart

string

status

string

internal_domain_preauth.Cover

group

string

groupCode

string

jobGroup

string

validFrom

string

validTo

string

internal_domain_preauth.Member

age

integer

beneficiaryCode

string

gender

string

group

string

idNo

string

idNoType

string

isAlive

boolean

isMinor

boolean

isPrincipal

boolean

names

string

object

principalRelationship

string

internal_domain_preauth.EligibilityDetails

object

internal_domain_preauth.ShaVerificationRequest

EmbedExpiry

integer

embededToken

string

requestId

string

requestUrl

string

internal_domain_preauth.AuthorizationDetails

authCode

string

authorizationReason

string

authorizationType

string[]

authorizingDeviceOs

string

beneficiary

integer

beneficiaryCode

string

beneficiaryName

string

beneficiaryNumber

string

beneficiaryScheme

string

benefitType

string

biometricMatchLogId

string

object[]

createdByName

string

dateAuthorized

string

ekycToken

string

object

eligibility

string

object

endDate

string

endedVia

string[]

expiry

string

guardian

string

guid

string

id

integer

interventions

array · internal_domain_preauth.Intervention (circular)

isBiometricsDischargeAuthorization

boolean

isComplete

boolean

isElective

boolean

isOpen

boolean

label

string

needsPreauth

boolean

notes

string

overallPreauthFinalised

boolean

parentAuthorization

integer

parentPreauth

circular

parentType

string

payerName

string

payerSladeCode

integer

preauthIds

integer[]

object

provider

integer

providerFid

string

providerName

string

requestedBy

string

sessionType

string

shaGuid

string

object

shaVerificationRequestId

string

status

string

token

string

workStationId

string

internal_domain_preauth.Identifier

identifier

string

identifierType

string

internal_domain_preauth.BeneficiaryDetails

DoB

string

beneficiaryCode

string

beneficiaryId

integer

categoryCode

string

categoryName

string

firstName

string

gender

string

guid

string

object[]

lastName

string

otherNames

string

schemeCode

string · enum

Enum values:

UHC

PMF

BOTH

schemeName

string

internal_domain_preauth.InterventionData

code

string

fallBackKephLevelTariff

number

guid

string

id

integer

kephLevelTarrif

number

name

string

numberOfDaysToFallback

integer

overallTariff

number

paymentMechanism

string

status

string

internal_domain_preauth.PreauthAttachment

attachment

integer

attachmentType

string · enum

Enum values:

BIOPSY_RESULT

CASE_NOTES_JUSTIFYING_ADMISSION

CASE_NOTES_INDICATING_NEED_FOR_DEVICE

CASE_SUMMARY

CLINICAL_DOCUMENTATION

CRITICAL_CARE_UNIT_CASE_NOTES

CONSULTANT_REPORT

DIAGNOSTIC_REQUESTS

author

string

authorEmail

string

authorName

string

contentType

string

description

string

guid

string

id

integer

interventionCode

string

organisationName

string

source

string

title

string

uploadedFile

string

internal_domain_preauth.PreauthDiagnosis

authorizationIntervention

string

description

string

guid

string

id

integer

interventionCode

string

interventionName

string

name

string

preauthDiagnosisType

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

siteCode

string

siteCodeType

string

status

string

internal_domain_preauth.Contact

active

boolean

businessPartner

canSendComm

boolean

contactName

string

contactType

string

contactValue

string

deactivationReason

string

guid

string

id

integer

isConfirmed

boolean

role

string

internal_domain_preauth.DoctorProfile

active

boolean

object[]

country

string

currencyCode

string

guid

string

id

integer

object[]

name

string

nationalIdentifier

string

practitionerCadre

string

practitionerDisciplineName

string

practitionerGender

string

practitionerIdNumber

string

practitionerIdType

string

practitionerInHealthWorkerRegistry

boolean

practitionerLicenceNumber

string

practitionerLicenceStart

string

practitionerLicenceType

string

practitionerLicenceValidity

string

practitionerLicenseBody

string

practitionerLicenseStatus

string

practitionerPostalAddress

string

practitionerQualifications

string

practitionerRegistrationNumber

string

practitionerRegistryId

string

practitionerSpecialty

string

practitionerSubSpecialty

string

practitionerType

string

sladeCode

integer

specialty

string[]

suspended

boolean

suspensionReason

string

internal_domain_preauth.PreauthDoctor

object

doctorReviewStatus

string

doctorType

string

guid

string

hospitalDoctorName

string

id

integer

isHospitalDoctor

boolean

name

string

notes

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

sladeCode

integer

status

string

internal_domain_preauth.PreauthItem

approvedAmount

number

approvedBy

string

approvedByName

string

approvedQuantity

string

approvedUnitPrice

number

category

string

chargeDate

string

cmCode

string

description

string

estimatedAmount

number

guid

string

id

integer

intervention

string

interventionCode

string

interventionName

string

name

string

payerInvoiceLineNo

string

providerCurrency

string

quantity

string

requestedBy

string

requestedByName

string

requestedOn

string

respondedBy

string

respondedByName

string

respondedOn

string

responseNote

string

schemeCode

string · enum

Enum values:

UHC

PMF

BOTH

schemeName

string

status

string

unitPrice

number

internal_domain_preauth.PreauthNote

author

string

authorEmail

string

authorName

string

guid

string

id

integer

note

string

organisationName

string

source

string

internal_domain_preauth.ProviderDetails

active

boolean

bpLevel

string

businessPartnerId

integer

guid

string

object[]

name

string

nationalIdentifier

string

sladeCode

integer

internal_domain_preauth.RequestExtraData

anaesthesiaType

string

carcinomaStaging

string · enum

Enum values:

STAGE_1

STAGE_2

STAGE_3

STAGE_4

chiefComplaint

string

clinicalIndications

string

coinsuranceDetails

string

comorbidity

string

conditionEmploymentRelated

boolean

conditionOtherRelated

boolean

consultationDescription

string

costPerSession

number

eyeExaminationAmount

number

eyeExaminationDescription

string

frameAmount

number

frameDescription

string

hasCoinsurance

boolean

hpi

string

investigations

string

lensAmount

number

lensDescription

string

lensPrescription

string

metastases

string[]

Enum values:

LUNG

LIVER

BRAIN

BONE

OTHER

physicalExamination

string

progressReport

string

reasonForService

string

replacement

string

sessionExpectedDate

string

sessionsFrequency

string

sessionsRequired

integer

subType

string

treatmentSetting

string[]

Enum values:

DAY_WARD

SIDE_ROOM

RECLINING_CHAIR

vitalSigns

string

internal_domain_preauth.ResponseExtraData

finalizeNote

string

internal_domain_preauth.Preauth

accessPoint

string

anaesthesiaType

string

authorization

integer

object

carcinomaStaging

string

clinicalIndications

string

comorbidity

string

conditionCause

string

conditionEmploymentRelated

boolean

conditionOtherRelated

boolean

costPerSession

string

countdown

integer

createdByName

string

description

string

doctorApproved

boolean

doctorReviewStatus

string

finalApprovedAmount

number

guid

string

id

integer

interventionCode

string

object

isElective

boolean

isEmergency

boolean

isHmisPreauth

boolean

isOncology

boolean

isOptical

boolean

isRadiology

boolean

isRenal

boolean

isRequestPhase

boolean

isResponsePhase

boolean

isSurgical

boolean

lengthOfStay

integer

memberIdentifier

string

memberIsVip

boolean

memberIsVvip

boolean

memberName

string

memberScheme

string

metastases

string

needsDoctorApproval

boolean

numberOfPreauthDoctorsRequired

integer

otherMetastases

string

payerIdentifier

string

payerInvoiceNo

string

payerName

string

object[]

array

object[]

preauthType

string

providerConsent

boolean

providerCurrency

string

object

providerName

string

providerNotificationEmail

string

reasonForAcuteDialysis

string

reasonForSelectingOther

string

object

serviceEnd

string

serviceStart

string

sessionExpectedDate

string

sessionType

string

sessionsFrequency

string

sessionsRequired

integer

status

string

submissionDateIn_EAT

string

token

string

totalEstimatedAmountForPreauth

number

totalInterimApprovedAmountForPreauth

number

updatedByName

string

BasePreauthRequest

Base schema for preauthorization requests. Contains common fields required for all types of preauthorizations.

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

NormalPreauthRequest

Normal preauthorization request. Contains only the base fields for any normal preauthorisations.

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

SurgicalPreauthRequest

Surgical preauthorization request. Contains surgical-specific fields.

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

chief_complaint

string · required

Patient's chief complaint

Example: Clifford Ouma

vital_signs

string · required

Patient's vital signs

Example: 110 BP

history_of_present_illness

string · required

History of present illness

Example: None

physical_examination

string · required

Physical examination findings

Example: Looks pale and weak

investigation_report_details

string · required

Investigation report details

Example: None

type_of_anaesthesia

string · enum · required

Type of anaesthesia to be used

Enum values:

GENERAL

LOCAL

SPINAL_BLOCK

SEDATION

Example: GENERAL

surgery_date

string · date-time · required

Scheduled surgery date and time

Example: 2025-09-08T15:30:00+03:00

RenalPreauthRequest

Renal preauthorization request. Contains renal-specific fields

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

number_of_sessions_required

integer · required

Number of renal (dialysis) treatment sessions required.

Example: 20

cost_per_session

number · required

Cost per renal treatment session.

Example: 5000

frequency_of_sessions

string · enum · required

How often the treatment sessions occur.

Enum values:

TWICE_A_WEEK

ONCE_A_WEEK

ONE_TIME_EVERY_2_WEEKS

ONE_TIME_EVERY_3_WEEKS

ONCE_A_MONTH

Example: ONCE_A_WEEK

clinical_indications

string · required

Clinical indications justifying the renal treatment.

Example: Pain in lower abdomen

start_date

string · date-time

Scheduled start date and time of the renal treatment.

Example: 2025-09-10T15:30:00+03:00

OncologyPreauthRequest

Oncology preauthorization request. Contains extra oncology-specific fields.

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

carcinoma_staging

string · enum · required

Stage of carcinoma

Enum values:

STAGE_1

STAGE_2

STAGE_3

STAGE_4

Example: STAGE_1

comorbidity

string · required

Patient comorbidities

Example: The comorbidity

treatment_setting

string[] · required

Treatment setting

Enum values:

DAY_WARD

RECLINING_CHAIR

SIDE_ROOM

Example: ["DAY_WARD"]

number_of_sessions_required

integer · required

Number of treatment sessions required

Example: 20

cost_per_session

number · required

Cost per treatment session

Example: 2500

metastases

string[]

Sites of metastases

Enum values:

LUNG

LIVER

BRAIN

BONE

OTHER

Example: ["LUNG"]

start_date

string · date-time

Treatment start date

Example: 2025-09-08T15:30:00+03:00

OpticalPreauthRequest

Optical preauthorization request. Contains optical-specific fields.

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

necessity_of_service

string · required

Necessity of the optical service

Example: To help patient see clearly

lens_prescription

string · enum · required

Type of lens prescription

Enum values:

FRAMES_LENSES

CONTACT_LENSES

Example: FRAMES_LENSES

lens_amount

number · required

Cost of lenses

Example: 10000

eye_examination_amount

number · required

Cost of eye examination

Example: 2000

frame_amount

number · required

Cost of frames

Example: 10000

new_or_replacement

string · enum · required

Whether this is for new glasses or replacement

Enum values:

NEW

REPLACEMENT

Example: REPLACEMENT

ImagingPreauthRequest

Imaging preauthorization request. Contains imaging-specific fields

consent_token

string · required

Consent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.

Example: J6LAFNBPZN

intervention_code

string · required

Intervention code for the service offered

Example: SHA-11-001

service_start

string · required

ISO timestamp for when the service started

Example: 2025-08-18T15:30:00+03:00

service_end

string · required

ISO 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":"A00000","identification_type":"registration_number","regulation_body":"KMPDC","intervention_code":"SHA-11-001","is_primary":true}]

object[] · required

List of attachments

Example: [{"document_title":"Lab Results","document_type":"LAB_TESTS","file_field_name":"attachments_0_file_blob"}]

provider_notification_email

string · email · required

Email to notify the provider of any updates on the preauthorization request

Example: clifford.ouma@savannahinformatics.com

clinical_indications

string · required

Clinical indications for imaging

Example: Prescence of head pains

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CancelPreauthRequest

Request payload for canceling a preauthorization. Requires consent token and intervention code.

consent_token

string · required

Beneficiary consent token authorizing the preauthorization to be cancelled.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention (benefit package) code of the preauthorization being cancelled.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemovePreauthDiagnosisRequest

consent_token

string · required

Consent token authorising the action on the beneficiary's preauthorisation.

Example: K5HLPJVDNV

icd_code

string · required

ICD-11 diagnosis code to remove from the preauthorisation.

Example: ca07.0

intervention_code

string · required

SHA intervention code the diagnosis is associated with.

Example: SHA-18-005

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemovePreauthDoctorRequest

consent_token

string · required

Consent token authorising the action on the beneficiary's preauthorisation.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the doctor is associated with.

Example: SHA-18-005

practitioner_registration_number

string · required

Regulatory registration number of the practitioner to remove. Example is dummy data.

Example: A00000

internal_domain_prescriptions.Authorization

authCode

string

beneficiaryCode

string

beneficiaryName

string

beneficiaryNumber

string

expiry

string

guid

string

id

integer

payerName

string

providerName

string

replicated

string

status

string

token

string

internal_domain_prescriptions.Contact

active

boolean

contactType

string

contactValue

string

id

integer

isMainContact

boolean

ownerType

string

internal_domain_prescriptions.Identifier

id

integer

identifier

string

identifierType

string

isMainIdentifier

boolean

internal_domain_prescriptions.Beneficiary

age

integer

beneficiaryCode

string

object[]

dob

string

gender

string

guid

string

id

integer

object[]

isPrincipal

boolean

mainIdentifier

string

names

string

internal_domain_prescriptions.Dosage

doseQuantity

string

doseUnit

string

duration

string

durationUnit

string

endDate

string

frequency

integer

guid

string

id

integer

medication

string

medicationIdentifier

string

medicationPrice

number

patientInstruction

string

periodUnit

string

practitionerId

string

prescription

integer

replicated

string

route

string

routeCode

string

startDate

string

internal_domain_prescriptions.Intervention

accessPoint

string

active

boolean

activeForUhc

boolean

applicableFacilityOwnership

string

applicableGender

string

applicableSchemes

string[]

benefit

integer

benefitCode

string

benefitName

string

code

string

coverageLevel

string

fund

string

guid

string

id

integer

levelsApplicable

string[]

name

string

packageCombinations

string[]

parentBenefitCode

string

parentBenefitName

string

paymentMechanism

string

replicated

string

status

string

supportedScheme

string

internal_domain_prescriptions.Prescription

object

code

string

doctorReviewStatus

string

object[]

guid

string

id

integer

object

replicated

string

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.MedicationItem

additional_instruction

string

Additional dispensing or administration instructions for the medication.

Example: Take after meals.

dose_quantity

integer

Amount of the medication to be taken per dose.

Example: 1

dose_unit

string

Unit of measure for the dose quantity (e.g. tablet, ml).

Example: tablet

duration

integer

Length of the treatment course, expressed in duration units.

Example: 7

duration_unit

string

Unit of measure for the treatment duration (e.g. day, week).

Example: day

end_date

string

Date the medication course ends.

Example: 2026-06-08

frequency

integer

Number of times the dose is taken per period.

Example: 3

generic_concept_code

string

Terminology code identifying the generic medication concept.

Example: 387517004

needs_refill

boolean

Whether the medication requires refills.

Example: false

patient_instruction

string

Instructions for the patient on how to take the medication.

Example: Take one tablet twice daily for five days.

period_unit

string

Unit of measure for the dosing period (e.g. day).

Example: day

refill_count

integer

Number of refills authorised for the medication.

Example: 2

start_date

string

Date the medication course starts.

Example: 2026-06-08

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CreatePrescriptionRequest

consent_token

string · required

Patient consent token authorising the prescription request.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the prescription is issued against.

Example: SHA-18-005

object[] · minItems: 1 · required

List of medication items to be prescribed.

identification_number

string

Identification number of the prescribing practitioner, matching the identification type. Example is dummy data.

Example: A00000

identification_type

string · enum

Type of identifier supplied for the prescribing practitioner.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

regulation_body

string · enum

Regulatory body that registered the prescribing practitioner.

Enum values:

KMPDC

COC

NCK

PPB

Example: KMPDC

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.ActualProduct

actual_product_code

string · required

Code identifying the actual product (e.g. medication) that was dispensed.

Example: SHA-19-SC-13

medication_price

number · required

Unit price of the dispensed medication, in Kenyan Shillings.

Example: 1500

total_quantity

integer · required

Total quantity of the product dispensed.

Example: 30

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.DispenseDoctor

identification_number

string · required

Identification number of the dispensing doctor, matching the identification type. Example is dummy data.

Example: A00000

identification_type

string · enum · required

Type of identifier supplied for the dispensing doctor.

Enum values:

registration_number

National ID

Alien ID

Refugee ID

Example: registration_number

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CreateDispenseRequest

object[] · required

Products actually dispensed to the patient for this intervention.

consent_token

string · required

Patient consent token authorising the dispense.

Example: K5HLPJVDNV

object[] · required

Doctors associated with the dispense (e.g. prescriber).

intervention_code

string · required

SHA intervention code the dispense is recorded against.

Example: SHA-18-005

internal_domain_prescriptions.DispenseDosage

dispense

integer

doseQuantity

integer

doseUnit

string

duration

string

durationUnit

string

endDate

string

frequency

integer

genericDosageInstruction

integer

guid

string

id

integer

medication

string

medicationIdentifier

string

medicationPrice

string

medicationRequestId

string

periodUnit

string

practitionerId

string

route

string

routeCode

string

startDate

string

status

string

totalQuantity

string

internal_domain_prescriptions.DispensingDoctor

dispense

integer

id

integer

internal_domain_prescriptions.Dispense

object[]

id

integer

object

status

string

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RemovePrescriptionDoctorRequest

consent_token

string · required

Consent token authorising the action on the beneficiary's prescription.

Example: K5HLPJVDNV

intervention_code

string · required

SHA intervention code the doctor is associated with.

Example: SHA-18-005

practitioner_registration_number

string · required

Regulatory registration number of the prescribing doctor to remove. Example is dummy data.

Example: A00000

internal_domain_tenants.AuthType

string · enum

Enum values:

oauth2_client_credentials

api_key

basic_auth

bearer_static

bearer_login

none

How the HIE authenticates when it calls your endpoint. none is the only value you can set yourself: every other value needs a secret_ref, and secrets are provisioned by the HIE rather than through the API.

Example: none

internal_domain_tenants.Environment

string · enum

Enum values:

production

sandbox

Which of your environments this endpoint belongs to. Only production and sandbox are accepted; prod is rejected.

Example: sandbox

internal_domain_tenants.HTTPMethod

string · enum

Enum values:

GET

POST

PUT

PATCH

DELETE

HTTP method the HIE uses when calling your endpoint. DELETE is accepted at registration but is not supported at delivery time, so use POST for status callbacks.

Example: POST

internal_domain_tenants.RetryConfig

Retry policy applied when a delivery attempt does not return a 2xx.

backoff_ms

integer

Delay before the first retry, in milliseconds.

Example: 1000

backoff_multiplier

integer

Factor the delay is multiplied by after each failed attempt.

Example: 2

max_retries

integer

Number of retries after the initial attempt.

Example: 3

internal_domain_tenants.TenantEndpointOperation

A registered operation on a tenant endpoint. Returned in full on every read and after every partial update, so a zero value stays visible rather than disappearing from the payload.

action

string

The event this operation answers. status_changed for status callbacks.

Example: status_changed

created_at

string

When the operation was registered.

Example: 2026-08-06T13:10:16.828383Z

endpoint_id

string

The parent endpoint this operation belongs to.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

object

Static headers sent on this operation's deliveries, on top of the endpoint's own.

Example: {"X-Callback":"status"}

id

integer

Internal row identifier. Address the operation by operation_id, not by this.

Example: 12

is_active

boolean

Whether this operation is eligible for delivery. Both the endpoint and the operation must be active.

Example: true

method

string · enum

HTTP method the HIE uses when calling your endpoint. DELETE is accepted at registration but is not supported at delivery time, so use POST for status callbacks.

Enum values:

GET

POST

PUT

PATCH

DELETE

Example: POST

name

string

Your label for the operation.

Example: Claim status changed

operation_id

string

The identifier to use on the read, update and delete routes.

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

path

string

Path appended to the endpoint's base_url unless path_url_override is set.

Example: /callbacks/claim-status

path_url_override

string

Absolute URL that replaces base_url + path when set. Returned as null when unused.

Example: https://callbacks.example.co.ke/hie/claim-status

request_content_type

string

Content type of the delivered body.

Example: application/json

object

Retry policy applied when a delivery attempt does not return a 2xx.

timeout_ms

integer

Response deadline for this operation. null means the endpoint's value applies.

Example: 30000

updated_at

string

When the operation was last changed.

Example: 2026-08-06T13:10:16.828383Z

internal_domain_tenants.TenantEndpoint

A registered tenant endpoint. Returned in full on every read and after every partial update, so a zero value - `is_active: false`, `timeout_ms: 0`, an empty `secret_ref` - stays visible rather than disappearing from the payload.

auth_type

string · enum

Enum values:

oauth2_client_credentials

api_key

basic_auth

bearer_static

bearer_login

none

Example: none

base_url

string

Scheme and host each operation's path is appended to.

Example: https://his.example.co.ke/hie

created_at

string

When the endpoint was registered.

Example: 2026-08-06T13:10:16.828383Z

endpoint_id

string

The identifier to use when registering operations, and on the update and delete routes.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

entity_type

string

Which entity's status changes reach this endpoint: claim, preauth or authorization.

Example: claim

environment

string · enum

Which of your environments this endpoint belongs to. Only production and sandbox are accepted; prod is rejected.

Enum values:

production

sandbox

Example: sandbox

facility_fr_code

string

Facility Registry code this endpoint serves. The fallback selector at delivery time.

Example: FID-47-115307-8

object

Static headers sent on every delivery to this endpoint.

Example: {"X-Source":"HIE"}

id

integer

Internal row identifier. Address the endpoint by endpoint_id, not by this.

Example: 8

is_active

boolean

Whether this endpoint is eligible for delivery. Nothing is delivered while it is false, and no error is raised.

Example: true

name

string

Your label for the endpoint.

Example: Claim status callbacks

object[]

The operations registered under this endpoint. Empty until you register one - an endpoint on its own delivers nothing.

retry_config

circular

secret_ref

string

Reference to the credential the HIE uses. Empty when auth_type is none. The credential itself is never returned.

Example: his-callbacks-bearer

tenant_code

string

Primary selector, matched against the tenant_code the EDI backend publishes before facility_fr_code is tried. Normally the same value as your client ID, and unique to you.

Example: his-tenant-code

tenant_id

string

The tenant that owns this endpoint, as resolved from the path when it was registered.

Example: b5f8c2d4-3e7a-4f19-9c6b-1a2d3e4f5a6b

timeout_ms

integer

How long the HIE waits for your response before treating the attempt as failed.

Example: 60000

updated_at

string

When the endpoint was last changed.

Example: 2026-08-06T13:10:16.828383Z

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.RetryConfigInput

Retry policy for deliveries to this endpoint. Omit it to accept the platform default.

backoff_ms

integer

Delay before the first retry, in milliseconds.

Example: 1000

backoff_multiplier

integer

Factor the delay is multiplied by after each failed attempt. With backoff_ms: 1000 and a multiplier of 2, retries are spaced 1s, 2s, 4s.

Example: 2

max_retries

integer

Number of retries after the initial attempt.

Example: 3

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CreateEndpointInput

Registers the endpoint the HIE calls when an entity's status changes. Register one endpoint per entity type: a facility may hold at most one endpoint per `entity_type`.

auth_type

string · required

How the HIE authenticates to your endpoint. Required. none is the only value you can set yourself; every other value also requires secret_ref, and secrets are stored by the HIE out of band.

Example: none

base_url

string · required

Scheme and host the operation path is appended to. Required, and must be an absolute URL.

Example: https://his.example.co.ke/hie

entity_type

string · enum · required

Which entity's status changes this endpoint receives. Required, and must be one of the three values listed. A facility holds at most one endpoint per entity type, so register a separate endpoint for each kind you want.

Enum values:

claim

preauth

authorization

Example: claim

environment

string · required

Required. production or sandbox. prod is rejected.

Example: sandbox

name

string · required

Your label for the endpoint. Required. It is not parsed and does not have to be unique.

Example: Claim status callbacks

facility_fr_code

string

Facility Registry code this endpoint serves. Used as the fallback selector at delivery time when no tenant matches tenant_code, and as a lookup key on GET /tenants/{tenant_id}/endpoints.

Example: FID-47-115307-8

object

Static headers sent on every delivery to this endpoint. Use them for routing or tracing values, never for credentials.

Example: {"X-Source":"HIE"}

object

Retry policy for deliveries to this endpoint. Omit it to accept the platform default.

secret_ref

string

Reference to the credential the HIE uses for this endpoint. Required whenever auth_type is not none. The HIE issues the value; there is no API route that stores a secret.

Example: his-callbacks-bearer

tenant_code

string

Selector matched first at delivery time against the tenant_code the EDI backend publishes. This is normally the same value as your client ID, and it is unique to you. Defaults to the resolved tenant's own code when omitted, which is usually what you want.

Example: his-tenant-code

timeout_ms

integer

How long the HIE waits for your response before treating the attempt as failed. Defaults to 60000.

Example: 60000

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.CreateOperationInput

Registers what the HIE does on the endpoint. For status callbacks the action is always `status_changed`; the parent endpoint's `entity_type` is what distinguishes a claim integration from a preauth or authorization one.

action

string · required

The event this operation answers. Required. For status callbacks it is always status_changed, whatever the entity type.

Example: status_changed

method

string · required

HTTP method the HIE calls with. Required, one of GET, POST, PUT, PATCH, DELETE. Use POST: DELETE passes validation here but fails at delivery time.

Example: POST

name

string · required

Your label for the operation. Required.

Example: Claim status changed

object

Static headers for this operation, in addition to the endpoint's own.

Example: {"X-Callback":"status"}

path

string

Path appended to the endpoint's base_url. Required unless you send path_url_override.

Example: /callbacks/claim-status

path_url_override

string

Absolute URL that replaces base_url + path entirely. Use it when this one callback must go somewhere other than the endpoint's host; the endpoint's base_url is then ignored for this operation.

Example: https://callbacks.example.co.ke/hie/claim-status

request_content_type

string

Content type of the delivered body. Defaults to application/json, which is what the status-callback payload is.

Example: application/json

object

Retry policy for deliveries to this endpoint. Omit it to accept the platform default.

timeout_ms

integer

Response deadline for this operation, overriding the endpoint's value.

Example: 30000

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.UpdateEndpointInput

Partial update of a registered endpoint. Send only the fields you want to change; omitted fields are left untouched. At least one field is required, and an empty body is rejected with a 400.

auth_type

string

New authentication mechanism. Changing it to anything other than none needs a secret_ref the HIE has issued.

Example: none

base_url

string

New scheme and host. Must be an absolute URL.

Example: https://his.example.co.ke/hie/v2

entity_type

string · enum

Move this endpoint to a different entity type. Must be one of the three values listed. Changing it re-points a live integration, so it is rarely what you want on a working registration.

Enum values:

claim

preauth

authorization

Example: claim

environment

string

production or sandbox.

Example: production

object

Replaces the stored header map wholesale rather than merging into it.

Example: {"X-Source":"HIE"}

is_active

boolean

Set to false to stop delivery without deleting the registration. Nothing is delivered while this is false, and no error is raised - the first thing to check when callbacks stop arriving.

Example: true

name

string

New label for the endpoint.

Example: Claim status callbacks

secret_ref

string

New credential reference, issued by the HIE.

Example: his-callbacks-bearer

tenant_code

string

New primary selector, matched against the tenant_code the EDI backend publishes.

Example: his-tenant-code

timeout_ms

integer

New response deadline in milliseconds.

Example: 30000

gitlab_slade360emr_com_sha-edi_hie-middleware_internal_dto.UpdateOperationInput

Partial update of a registered operation. Send only the fields you want to change. At least one field is required, and an empty body is rejected with a 400.

action

string

New action. Changing it away from status_changed stops status callbacks reaching this operation.

Example: status_changed

object

Replaces the stored header map wholesale rather than merging into it.

Example: {"X-Callback":"status"}

is_active

boolean

Set to false to stop delivery without deleting the operation. Both the endpoint and the operation must be active for anything to arrive, and an inactive record raises no error.

Example: true

method

string

New HTTP method, one of GET, POST, PUT, PATCH, DELETE.

Example: POST

name

string

New label for the operation.

Example: Claim status changed

path

string

New path, appended to the endpoint's base_url.

Example: /callbacks/claim-status

path_url_override

string

New absolute URL, replacing base_url + path for this operation.

Example: https://callbacks.example.co.ke/hie/claim-status

request_content_type

string

New content type for the delivered body.

Example: application/json

timeout_ms

integer

New response deadline for this operation, in milliseconds.

Example: 30000