user_initiated_linking

call-back link-on-confirm

Callback the gateway sends after a link confirmation: the patient's linked care contexts, or the error that stopped it.

POST/api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

patientobject[]Required

patient.referenceNumberstringRequired

patient.displaystringRequired

patient.careContextsobject[]Required

patient.careContexts.referenceNumberstringRequired

patient.careContexts.displaystringRequired

patient.hiTypestringRequired

patient.countintegerRequired

responseobjectRequired

response.requestIdstringRequired

Responses

200

No response body is documented for this request.

call-back link-on-confirm

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/hiecm/user-initiated-linking/v3/link/care-context/on-confirm \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "patient": [
    {
      "referenceNumber": "<ABHA_ADDRESS>",
      "display": "Test",
      "careContexts": [
        {
          "referenceNumber": "Test 4",
          "display": "Sugar Test"
        }
      ],
      "hiType": "Invoice",
      "count": 1
    }
  ],
  "response": {
    "requestId": "<TXN_ID>"
  }
}'

No response body is documented for this request.