Skip to main content

webhooks

A discovery request for a patient you may hold records for

Inbound to every HIP. Answer with care context metadata only: a discovery response carries no clinical or sensitive data. A rejected answer is reported as ABDM-1109.

POST/api/v3/hip/patient/care-context/discover

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

A fresh identifier for this discovery flow. Echo it back as response.requestId when you answer on m2_on_discover_care_contexts.

patientobjectRequired
patient.idstringRequired

A patient identifier to search your records by.

patient.verifiedIdentifiersobject[]Required
patient.unverifiedIdentifiersobject[]

Identifiers to search your own records by, not verified by ABDM.

patient.namestringRequired
patient.genderstringRequired

One of MFODTU

patient.yearOfBirthintegerRequired

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 On Discovery, HIP responds with found care contexts.

Last updated on