webhooks

Acknowledgement of a health information request

Carries the transaction id, the request id and the current status. This is an acknowledgement, not the records. The records arrive at the data push URL you supplied.

POST/api/v3/hiu/health-information/on-request

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Body

hiRequestobjectRequired

hiRequest.transactionIdstringRequired

hiRequest.sessionStatusstringRequired

errornullRequired

responseobjectRequired

response.requestIdstringRequired

Responses

200

Your bridge acknowledged the callback with 200 OK. The gateway validates the body you send back, so a 200 carrying the wrong body is still a failure.

Acknowledgement of a health information request

curl --request POST \
  --url https://dev.abdm.gov.in/api/api/v3/hiu/health-information/on-request \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiRequest": {
    "transactionId": "8376a2b0-3fc9-4bb5-8af5-54a49a3910f4",
    "sessionStatus": "REQUESTED"
  },
  "error": null,
  "response": {
    "requestId": "e492d2b5-5f0a-4406-8a5d-5b4351e2ff2c"
  }
}'

Your bridge acknowledged the callback with 200 OK. The gateway validates the body you send back, so a 200 carrying the wrong body is still a failure.

Where this fits

You produce this callback by calling Request a patient's health information.

Acknowledgement of a health information request

Authorizations

Body

Responses

Where this fits​

Where this fits