Skip to main content

webhooks

A request to start linking a care context

Inbound to the HIP. A duplicate arrives as ABDM-1104, and a rejected answer as ABDM-1110.

POST/api/v3/hip/link/care-context/init

Retry count, backoff and timeout for this callback are not stated in NHA's material, so treat them as unknown.

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>. M2 also uses per flow tokens, a link token for linking and an authorisation token for patient scoped calls. Their header names are not yet published.

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. The callback that answers it carries the same value, so this is how you match an asynchronous reply to the call that caused it. Store it before you send the request, not after.

TIMESTAMPstringRequired

The current time in ISO 8601, UTC, with milliseconds and a Z suffix, from a synchronised clock. The sandbox rejects IST and accepts UTC.

X-HIP-IDstringRequired

Identifier of the Health Information Provider the request or callback belongs to. This is per facility, and it is what a callback arriving at your one bridge URL is routed on. The bridge URL and your credentials belong to the integration, not to the facility.

Body

transactionIdstringRequired
abhaAddressstringRequired
patientobject[]Required
patient.referenceNumberstringRequired
patient.displaystringRequired
patient.careContextsobject[]Required
patient.hiTypeobjectRequired
patient.countinteger

Responses

202

Your bridge accepted the callback. The gateway validates the body you send back, so a 202 carrying the wrong body is still a failure.

The callback never arrives

Where this fits​

Answer this callback by calling Link On-Init, HIP responds with OTP communication details.

Last updated on