data transfer

Acknowledge a health information data request

Also known as: HIP Health Information Response. Async Callback: After ABDM Gateway sends a health information request to the HIP bridge URL ({bridgeUrl}/v0.5/health-information/hip/request), the HIP calls this Gateway endpoint to acknowledge receipt and indicate it will begin processing (ACKNOWLEDGED).

Mandatory

Certification case HIP_INIT_SHARE_CARECONTEXT

POST/hiecm/data-flow/v3/health-information/hip/on-request

After this, the HIP prepares and encrypts FHIR records, then pushes them to the HIU's dataPushUrl.

Authorizations

Authorizationbearer tokenRequired

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

Body

hiRequestobjectRequired

hiRequest.transactionIdstringRequired

Transaction ID from the original data request

hiRequest.sessionStatusstringRequired

One of ACKNOWLEDGEDERRORED

responseobjectRequired

Echo of the requestId from the original Gateway-to-HIP request

response.requestIdstringRequired

requestId received in the original Gateway request to HIP bridge

Responses

202

Health information request acknowledgement 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

Acknowledge a health information data request

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/data-flow/v3/health-information/hip/on-request \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiRequest": {
    "transactionId": "txn-uuid-data-001",
    "sessionStatus": "ACKNOWLEDGED"
  },
  "response": {
    "requestId": "req-uuid-from-hi-request"
  }
}'

Health information request acknowledgement accepted

Callbacks

You make this call in reply to A request for the records a consent covers, which ABDM posts to /api/v3/hip/health-information/request. Open the callback.

Acknowledge a health information data request

Authorizations

Body

Responses

Callbacks​

Callbacks