Skip to main content

Receive the health information data request to HIP

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/hip/health-information/request

Callback API to provide Health information request of HIP. CM calls this API when it has validated the Health Information request given the consent ID. 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

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

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

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

Body

transactionIdstringRequired
hiRequestobjectRequired
hiRequest.consentobjectRequired
hiRequest.consent.idstringRequired

The consent artefact id for health information request. 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}$"

hiRequest.dateRangeobjectRequired

Health information created between this date range is requested

hiRequest.dateRange.fromstringRequired

Should be a UTC date time in ISO Format. Allows alpha numeric character and special characters like \\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$

hiRequest.dateRange.tostringRequired

Should be a UTC date time in ISO Format.Allows alpha numeric character and special characters like \\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$

hiRequest.dataPushUrlstringRequired

The URL to which the Health Information Provider has to send the health information data. Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\\-@,. \":/]{0,255}$

hiRequest.keyMaterialobjectRequired

The requester's half of the ECDH key agreement. The HIP derives the shared key from it and its own key pair, and encrypts every entry it pushes with AES-GCM.

hiRequest.keyMaterial.cryptoAlgstringRequired

The key agreement algorithm. Always ECDH.

hiRequest.keyMaterial.curvestringRequired

The curve the key pair is generated on. Always Curve25519.

hiRequest.keyMaterial.dhPublicKeyobjectRequired

The public half of the ephemeral key pair generated for this transaction.

hiRequest.keyMaterial.dhPublicKey.expirystringRequired

When this key stops being valid, as an ISO 8601 timestamp.

hiRequest.keyMaterial.dhPublicKey.parametersstringRequired

The key parameters. Ephemeral public key.

hiRequest.keyMaterial.dhPublicKey.keyValuestringRequired

The public key, Base64 encoded, in X.509 SubjectPublicKeyInfo form.

hiRequest.keyMaterial.noncestring

32 random bytes, Base64 encoded, generated for this transaction. The other side combines it with its own nonce to derive the AES-GCM key and initialisation vector.

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

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1006 - Bad Request, invalid request Body. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

error.messagestringRequired

Short description of the failure.

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

codestring

900901 - Invalid Credentials. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

messagestring

Short description of the failure.

descriptionstring

Detailed description of the failure.

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

codestringRequired

404 - Runtime error. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

typestringRequired
messagestringRequired
descriptionstringRequired

Where this fits​

Answer this callback by calling Health information data request acknowledgement from HIP..