Skip to main content

Receive the health information data request acknowledgement to HIU

Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.

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

Callback API for acknowledgment of Health information request of HIU. CM calls this API when it has validated the Health Information request given the consent ID.

<br> Either the hiRequest or error would need to be specified. If the health info request was valid, then the hiRequest.transactionId specifies the transaction context against which HIP would send over the data.

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-HIU-IDstringRequired

Identifier of the health information user to which the request was intended

Body

hiRequestobjectRequired
hiRequest.transactionIdstringRequired

The UUID generated when the health information request was initiated.

hiRequest.sessionStatusstringRequired

The status of the health information request that was initiated.

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1001 - No data found. May be returned either bare (ABDM-1001) or with a trailing ": " separator (ABDM-1001: ); match on the code itself and tolerate the separator.

error.messagestringRequired

The appropriate error message

responseobjectRequired
response.requestIdstringRequired

The requestId that was passed. Allows alpha numeric character and special characters like ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}

Responses

200

OK

400

Bad Request. The request could not be processed because it was malformed or failed validation - a missing mandatory field, a value in the wrong format, or a header that did not match the body.

Error codes for this module

401

Unauthorized. The request carried no valid credentials, or the access token has expired. Obtain a fresh token from the session API and retry.

Everything returns 401

403

Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.

Error codes for this module

404

server cannot find the requested resource

Error codes for this module

Where this fits​

hiecm-m3.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.