Skip to main content

Other

Calls that belong to no single use case: notification subscription, deletion, the status callback and the protocol error report.

Reprocess, cancellation and shortfall have their own group: Reprocess, cancel and shortfall.

APIs​

CallCalled byMethod and pathWhat it does
Patient app: subscribe an ABHA number to notificationsBeneficiary appPOST /v1/notification/subscribeA Beneficiary Service Provider (PHR app) subscribes an ABHA id to notification topics; NHCX persists it synchronously, Last-Linked-Wins per ABHA id.
Patient app: acknowledge a notification subscriptionNHCX, to the beneficiary appPOST /v1/notification/on_subscribeBSP-side subscription acknowledgement; the same name denotes the callback where NHCX pushes claim-event notifications for a subscribed ABHA id.
Support: delete records by correlation IDAny participant, when NHCX support asksPOST /v1/deleteInternal troubleshooting operation on the claim service that deletes records by correlationid and action; not part of the business transaction flows.
Recipient: answer a status checkNHCX or the recipient, in answer to /v1/statusPOST /v1/on_statusThe answer to a status request, delivered to the sender that asked.
NHCX: report a request it could not deliverNHCX, to the senderPOST /v1/errorWhere the exchange tells a sender that a request could not be delivered after five attempts.

Callbacks you host​

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

PathHosted by
/v1/on_statusEvery participant that sends /v1/status
/v1/errorEvery participant

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 Other API reference.