Endpoints for claim submission and dispatch.
Close a virtual claim
Closes an existing claim, marking it complete and preventing further modifications. The request body carries a superset of fields; OTP and biometrics are alternative authorization paths, so supply the OTP for the OTP flow or the biometric fields for the biometrics flow.
Related documentation: Close Claim, Understanding Claim Statuses
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.
Close a virtual claim › Request Body
cancel_reason_textFree-text explanation for closing/cancelling the claim.
cancel_reason_typeconsent_tokenPatient consent token authorising the claim closure.
Close a virtual claim › Responses
Claim closed successfully
admitted_onappointment_numberattributesauthorization_codeauthorization_guidbeneficiary_guidbeneficiary_idbeneficiary_is_fuzzy_matchedcancel_reason_textcancel_reason_typeclaim_attachments_countclaim_auth_statusclaim_idcreated_by_namecurrencydiagnoses_countdischarge_cancel_datedischarge_cancel_remarksdischarge_reasondischarged_onedi_claim_guidemergency_visit_expiryestimate_ip_daysexpected_discharge_datehas_reviewed_claimidinitial_interventioninvoice_attachments_countinvoice_idinvoice_numberis_charge_master_mappedis_negativeis_resubmittedis_zerolast_retrylocation_codelocation_namemember_namemember_numbermember_number_has_tokenmode_of_arrivalnhif_numbernotesnumber_of_invoicespatient_namepatient_numberpayer_codepayer_namepayer_slade_codepolicy_numberpolicy_valid_frompolicy_valid_toprovider_nameprovider_slade_codereason_for_unknown_patientreference_numberresubmission_workflow_stateretry_countscheme_codescheme_nameservice_typetotal_claim_amounttotal_claim_copaytotal_claim_discounttotal_claim_net_amounttotal_claim_splitsupdated_by_namevisit_endvisit_numbervisit_startworkflow_stateDischarge a patient
Discharges a patient, signifying the end of treatment. The request body carries a superset of fields; OTP and biometric/discharge-auth-guid are alternative authorization paths, so supply the OTP for the OTP flow or the biometric fields / discharge authorization guid for the biometrics flow.
Related documentation: Inpatient Claim Dispatch, Understanding Claim Statuses
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.
Discharge a patient › Request Body
consent_tokenPatient consent token authorising the discharge.
discharge_auth_guidIdentifier of the discharge authorisation associated with the request.
discharge_dateDate and time the patient was discharged.
discharge_reasoninvoice_numberFacility invoice number for the inpatient episode.
otpOne-time password used to verify the request where required.
Discharge a patient › Responses
Patient discharged successfully
admitted_onappointment_numberattributesauthorization_codeauthorization_guidbeneficiary_guidbeneficiary_idbeneficiary_is_fuzzy_matchedcancel_reason_textcancel_reason_typeclaim_attachments_countclaim_auth_statusclaim_idcreated_by_namecurrencydiagnoses_countdischarge_cancel_datedischarge_cancel_remarksdischarge_reasondischarged_onedi_claim_guidemergency_visit_expiryestimate_ip_daysexpected_discharge_datehas_reviewed_claimidinitial_interventioninvoice_attachments_countinvoice_idinvoice_numberis_charge_master_mappedis_negativeis_resubmittedis_zerolast_retrylocation_codelocation_namemember_namemember_numbermember_number_has_tokenmode_of_arrivalnhif_numbernotesnumber_of_invoicespatient_namepatient_numberpayer_codepayer_namepayer_slade_codepolicy_numberpolicy_valid_frompolicy_valid_toprovider_nameprovider_slade_codereason_for_unknown_patientreference_numberresubmission_workflow_stateretry_countscheme_codescheme_nameservice_typetotal_claim_amounttotal_claim_copaytotal_claim_discounttotal_claim_net_amounttotal_claim_splitsupdated_by_namevisit_endvisit_numbervisit_startworkflow_stateSubmit a virtual claim
Submits a virtual claim for both normal and emergency cases. The request body carries a superset of fields; OTP and biometric/discharge-auth-guid are alternative authorization paths, so supply the OTP for the OTP flow or the biometric fields / discharge authorization guid for the biometrics flow.
Related documentation: Outpatient Claim Dispatch, Inpatient Claim Dispatch, Adding a Claim Doctor
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.
Submit a virtual claim › Request Body
consent_tokenConsent token authorising submission of the virtual claim.
beneficiary_contact_idIdentifier of the beneficiary contact used to reach the patient.
discharge_auth_guidGUID of the discharge authorisation associated with the visit.
discharge_reasoninvoice_numberProvider invoice number for the claim.
notesFree-text notes accompanying the claim submission.
otpOne-time password used to confirm the patient's consent.
reason_for_unknown_patientReason recorded when the patient identity could not be verified.
Submit a virtual claim › Responses
Claim submitted successfully
admitted_onappointment_numberattributesauthorization_codeauthorization_guidbeneficiary_guidbeneficiary_idbeneficiary_is_fuzzy_matchedcancel_reason_textcancel_reason_typeclaim_attachments_countclaim_auth_statusclaim_idcreated_by_namecurrencydiagnoses_countdischarge_cancel_datedischarge_cancel_remarksdischarge_reasondischarged_onedi_claim_guidemergency_visit_expiryestimate_ip_daysexpected_discharge_datehas_reviewed_claimidinitial_interventioninvoice_attachments_countinvoice_idinvoice_numberis_charge_master_mappedis_negativeis_resubmittedis_zerolast_retrylocation_codelocation_namemember_namemember_numbermember_number_has_tokenmode_of_arrivalnhif_numbernotesnumber_of_invoicespatient_namepatient_numberpayer_codepayer_namepayer_slade_codepolicy_numberpolicy_valid_frompolicy_valid_toprovider_nameprovider_slade_codereason_for_unknown_patientreference_numberresubmission_workflow_stateretry_countscheme_codescheme_nameservice_typetotal_claim_amounttotal_claim_copaytotal_claim_discounttotal_claim_net_amounttotal_claim_splitsupdated_by_namevisit_endvisit_numbervisit_startworkflow_state