Endpoints for managing visit consent and OTP verification.
Create new virtual claim
Creates a new virtual claim for a beneficiary after verifying their consent. Use the OTP strategy when consent was captured via a one-time password, or the biometrics strategy when consent was captured via eKYC or fingerprint — in which case the authorization GUID from POST /api/v1/claims/authorize is passed instead of an OTP.
Related documentation: Start Visit Workflow, Biometrics Integration
Create new virtual claim › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: intervention_codes, patient_id, service_type +1 more | |
| type = object · requires: intervention_codes, patient_id, service_type +1 more |
intervention_codesIntervention code(s) for the service scheduled to be offered.
patient_idClient Registry identifier of the beneficiary associated with the patient. Example is dummy data.
service_typeType of service being initiated.
otpOne-time password sent to the beneficiary's registered contact.
practitioner_identification_typeOptional. Identification type of the attending practitioner (doctor). Supply the three practitioner fields together to attach the doctor's details to the claim.
practitioner_identification_numberOptional. 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.
practitioner_regulation_bodyOptional. Regulation body the attending practitioner is registered with.
Create new virtual claim › Responses
Visit started 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