Endpoints for emergency case claims and protocols.
Add a doctor to an emergency claim
Adds a doctor to an emergency-case claim as part of the emergency-care flow; returns a JSON object with the request status.
Related documentation: 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.
Add a doctor to an emergency claim › Request Body
consent_tokenBeneficiary consent token authorizing the doctor to be added to the emergency claim.
identification_numberIdentification number of the attending doctor, per the selected identification type. Example is dummy data.
identification_typeregulation_bodyAdd a doctor to an emergency claim › Responses
Doctor successfully added to claim
Remove a doctor from an emergency claim
Removes a doctor from an authorized emergency-case claim as part of the emergency-care flow.
Related documentation: 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.
Remove a doctor from an emergency claim › Request Body
consent_tokenConsent token authorising the action on the beneficiary's claim.
Remove a doctor from an emergency claim › Responses
No Content
Create an emergency claim
Creates a claim for an emergency-care patient as part of the emergency-care flow.
Related documentation: Create Emergency Claim, Identify Unknown Patient
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.
Create an emergency claim › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: interventions, mode_of_arrival, brought_by +6 more | |
| type = object · requires: interventions, mode_of_arrival, brought_by +4 more | |
| type = object · requires: interventions, mode_of_arrival, brought_by +7 more |
interventionsEmergency intervention code(s) being treated. Emergency interventions belong to the SHA-01 code family; exactly one intervention is sent per emergency claim.
mode_of_arrivalbrought_byreference_numberProvider's reference number for the emergency visit.
identification_numberIdentification number of the attending practitioner (doctor). Example is dummy data.
identification_typeregulation_bodybeneficiary_cr_idClient Registry ID of the identified patient.
otpOne-time password sent to the patient to consent to the emergency visit.
notesOptional free-text clinical notes for the emergency presentation.
Create an emergency claim › Responses
Emergency claim created 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_stateFetch emergency protocols
Fetches the emergency-care protocols available for a given intervention code, optionally filtered by active status.
Related documentation: Get Emergency Protocols
query Parameters
activeFilter intervention if it is still active
intervention_codeIntervention applicable to a protocol
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.
Fetch emergency protocols › Responses
Emergency protocol retrieved successfully
countcurrentPageendIndexnextpageSizepreviousstartIndextotalPagesAdd a protocol to an emergency claim
Adds an emergency-care protocol (as a line) to an emergency claim; accepts a JSON body or multipart form-data.
Related documentation: Add Emergency Protocols
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.
Add a protocol to an emergency claim › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: consent_token, protocol_code, intervention_code +2 more | |
| type = object · requires: consent_token, protocol_code, intervention_code +2 more |
consent_tokenAuthorization code from emergency claim creation. Signifies an authorised claim.
protocol_codeCode of the approved protocol being billed (from the fetch-protocols response).
intervention_codeEmergency intervention code the protocol applies to. Emergency interventions belong to the SHA-01 code family.
unit_priceUnit price for the protocol, within the approved applicableTariff. A numeric value sent as a string.
quantityQuantity billed. A numeric value sent as a string.
Add a protocol to an emergency claim › Responses
Emergency protocol added successfully
attributesbill_frombill_tocharge_datediscountdiscount_reasondoctor_codedoctor_nameidintervention_codeinvoiceis_activeis_cancellationis_returnitem_codeitem_nameline_copayline_net_amountline_numberline_total_amountlinked_invoice_linemap_requestmap_request_descriptionmapped_slade_codenhif_rebate_amountpatient_discount_amountpatient_net_pricepmf_line_statusquantityscheme_codescheme_namesponsor_net_priceuhc_exceededunitunit_priceCreate an EMT claim
Creates an EMT (Emergency Medical Transport) claim from a multipart/form-data submission, as part of the emergency-care flow.
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.
Create an EMT claim › Request Body
consent_tokenAuthorization code from claim creation. Signifies an authorised claim.
protocol_codecase_numberpractitioner_reg_numberbeneficiary_cr_idotpprovider_registration_numberdiagnosesinterventionsAttachment metadata, sent as a JSON-encoded string in the multipart form. Each entry's file_field_name references a separate binary file part in the same request.
Create an EMT claim › Responses
EMT claim created 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