Insurance plan
Policies have traditionally been PDFs that hospital desks interpret by hand, producing ambiguity about benefits, claim conditions and documents, and rework and rejections downstream.
APIs
| Call | Called by | Method and path | What it does |
|---|---|---|---|
| Provider: request an insurance plan | Provider | POST /v1/insuranceplan/request | Provider sends a Task with code poll naming both a policy number and its HFR id to fetch the payer's machine-readable InsurancePlan for that pairing. |
| Payer: send the insurance plan | Payer | POST /v1/insuranceplan/on_request | Payer returns the InsurancePlan collection Bundle (InsurancePlan, Organization, optional Questionnaire) under the request correlation id. |
Callbacks you host
The exchange posts these to the endpoint_url you registered. Answer each with HTTP 202 first.
| Path | Hosted by |
|---|---|
/v1/insuranceplan/request | The payer |
/v1/insuranceplan/on_request | The provider |
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox, NHCX exchange. | https://apisbx.abdm.gov.in/hcx |
| Production. | https://apisprod.nha.gov.in/hcx |
Guides that use these calls
The whole specification, with a request you can send from the page, is the Insurance plan API reference.