Skip to main content

Communication

Every other NHCX exchange is provider-initiated and expects a matching response.

APIs​

CallCalled byMethod and pathWhat it does
Payer: send a communication requestPayerPOST /v1/communication/requestPayer pushes a Task plus Communication bundle to a provider mid-claim: TAT alerts, wallet or policy changes, grievances or extra-information requests.
Provider: acknowledge the communicationProviderPOST /v1/communication/on_requestProvider returns the acknowledgement Task bundle for a payer communication, echoing the reason code and correlation id so the payer can close the loop.

Callbacks you host​

The exchange posts these to the endpoint_url you registered. Answer each with HTTP 202 first.

PathHosted by
/v1/communication/requestThe provider
/v1/communication/on_requestThe payer

Base URLs​

EnvironmentBase 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 Communication API reference.