Endpoints for checking beneficiary eligibility.
Get facility bed occupancy
Returns total capacity and current bed occupancy data for the facility.
Related documentation: Facility Bed Occupancy
path Parameters
facilityCodeFacility FR code Example is a dummy value.
Get facility bed occupancy › Responses
Facility occupancy retrieved successfully
bp_levelnameGet patient benefits coverage
Returns the patient's SHA benefit coverage, listing the parent benefits the patient is entitled to.
Related documentation: Benefits Coverage, Benefit Matrix, Understanding Benefits and Intervention Codes
query Parameters
patient_idPatient's client registry (CR) ID Dummy example — obtain a real value from the Patient Search API.
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Get patient benefits coverage › Responses
OK
countcurrentPageendIndexnextpageSizepreviousstartIndextotalPagesGet patient benefit interventions
Returns the patient's SHA benefit interventions. The optional filters below narrow the results; omit them to return all of the patient's benefit interventions.
Related documentation: Interventions Coverage, Benefit Matrix, Understanding Benefits and Intervention Codes
query Parameters
patient_idPatient's client registry (CR) ID Dummy example — obtain a real value from the Patient Search API.
sub_benefit_codeSub-benefit code to narrow interventions
parent_interventionOptional parent intervention code to filter by
pagePagination page number
page_sizePagination page size
sub_interventionsWhen set, return sub-interventions only
exclude_capitationWhen set, exclude capitation interventions from the results
access_pointOptional access point to filter interventions by
searchOptional search term to match across interventions
codeOptional intervention code to filter by
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Get patient benefit interventions › Responses
OK
countcurrentPageendIndexnextpageSizepreviousstartIndextotalPagesGet patient utilization balances
Returns the patient's utilization balances for a given intervention, showing benefit usage so far and the remaining limits available to the patient.
Related documentation: Patient Utilization
query Parameters
patient_idPatient's client registry (CR) number Dummy example — obtain a real value from the Patient Search API.
intervention_codeIntervention code to fetch balances for
Get patient utilization balances › Responses
OK
codecrIdhouseholdMaxLimithouseholdUtilisedLimitindividualMaxLimitindividualUtilisedLimitlimitScopenextAvailabilityutilizationDaysCheck patient SHA eligibility
Checks whether a patient is eligible for services under the Social Health Authority (SHA), based on their current payment standing, and returns the schemes the patient qualifies for.
Related documentation: Eligibility Check
query Parameters
identification_numberPatient identification number. Example value is dummy data.
identification_typePatient identification type
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Check patient SHA eligibility › Responses
OK
requestIdNumberrequestIdTypeagedateOfBirthfacilityBiometricsEnforcedWhether the facility is required to use biometrics for patient consent. When true, OTP is only available to whitelisted patients.
fullNamegenderisAliveWhether the patient is recorded as alive. When false, the patient is deceased and integrators must block all subsequent transactions for the patient.
memberCrNumberstatusCodestatusDescwhitelistedForOTPWhether the patient is whitelisted to use OTP as a consent method (the fallback when biometrics cannot be used).
Get POMSF balances for a patient
Returns Public Officers Medical Scheme Fund (POMSF) benefit balances for a civil-servant patient, showing their available cover for the policy year.
Related documentation: POMSF Balance, PMF Tariffs Guide
query Parameters
patient_idPatient's POMSF member number (CR number) Dummy example — obtain a real value from the Patient Search API.
policy_yearPolicy year to fetch balances for; defaults to the current policy year
principal_member_numberPrincipal POMSF member's CR number, if patient is a dependent. Example value is dummy data.
Get POMSF balances for a patient › Responses
OK
dateOfBirthemailfirstNamegenderhouseholdIdidlastNamememberNumbermiddleNamenationalIdparentNumberphonephoneCodepolicyCountregisteredOnrelationshipTypeschemeCountshaNumbertitleGet patient sub-benefits coverage
Returns the patient's SHA sub-benefit coverage, listing the sub-benefits under their parent benefits.
Related documentation: Sub-Benefits Coverage, Benefit Matrix, Understanding Benefits and Intervention Codes
query Parameters
patient_idPatient's client registry (CR) ID Dummy example — obtain a real value from the Patient Search API.
parent_benefit_codeParent benefit code to filter sub-benefits by
fieldsComma-separated list of fields to include in the response
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Get patient sub-benefits coverage › Responses
OK
countcurrentPageendIndexnextpageSizepreviousstartIndextotalPages