hip linking

Link Care Context Notify

Sends an explicit notification to the ABDM Gateway about a newly linked care context. This is called after successful care context linking to ensure the patient's ABHA App receives a timely notification with the care context details.

ConditionalMandatory for the Government Integartors / Private Integrators

Certification cases HIP_INTI_LINK_501, HIP_INTI_LINK_502, HIP_INTI_LINK_503, HIP_INTI_LINK_504, HIP_INTI_LINK_505, HIP_INTI_LINK_506

POST/hiecm/hip/v3/link/context/notify

Authorizations

Authorizationbearer tokenRequired

Bearer token obtained from POST /hiecm/gateway/v3/sessions

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-CM-IDstringRequired

Which consent manager you are talking to. sbx on the sandbox and abdm in production. A dedicated error code exists for an invalid value here, which tells you how often it is wrong.

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

notificationobjectRequired

notification.patientobjectRequired

notification.patient.idstring

Patient ABHA address

notification.careContextobjectRequired

notification.careContext.patientReferencestring

notification.careContext.careContextReferencestring

notification.hiTypesobject[]Required

notification.datestringRequired

notification.hipobjectRequired

id, name and type are all required. What name and type contain beyond a string is not documented.

notification.hip.idstringRequired

notification.hip.namestringRequired

notification.hip.typestringRequired

Responses

202

Notification accepted

The callback never arrives

400

Bad request, invalid parameters or missing fields

Error codes for this module

401

Unauthorized, missing or invalid Bearer token

Everything returns 401

403

Forbidden. Returned as plain text ("Access Denied"), not JSON.

Error codes for this module

404

Resource not found

Error codes for this module

500

Internal server error.

Error codes for this module

Link Care Context Notify

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/hip/v3/link/context/notify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 5f7a4a1e-59ba-4c0c-9e0c-8e6b3b6e2f11' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'X-CM-ID: <X_CM_ID>' \
  --header 'X-HIP-ID: IN2810014366' \
  --header 'Content-Type: application/json' \
  --data '{
  "notification": {
    "patient": {
      "id": "patient@sbx"
    },
    "careContext": {
      "patientReference": "patient@sbx",
      "careContextReference": "VISIT-2024-001"
    },
    "hiTypes": [
      "Prescription"
    ],
    "date": "2024-01-10T12:00:00.000Z",
    "hip": {
      "id": "HIP_SERVICE_ID",
      "name": "S Y Hospital",
      "type": "HIP"
    }
  }
}'

Notification accepted

Callbacks

After this call, ABDM posts The outcome of a care context notify call you made to /v3/links/context/on-notify. Open the callback.

Link Care Context Notify

Authorizations

Headers

Body

Responses

Callbacks​

Callbacks