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.

<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-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 key and algorithm details that is used to encrypt/decrypt the data

hiRequest.keyMaterial.cryptoAlgstringRequired

Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\\-@,. \":/]{0,255}$

hiRequest.keyMaterial.curvestringRequired

Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\\-@,. \":/]{0,255}$

hiRequest.keyMaterial.dhPublicKeyobjectRequired
hiRequest.keyMaterial.dhPublicKey.expirystringRequired

UTC.Allows alpha numeric character and special characters like "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"

hiRequest.keyMaterial.dhPublicKey.parametersstringRequired

Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\-@,+#=. ":/]{0,255}$

hiRequest.keyMaterial.dhPublicKey.keyValuestringRequired
hiRequest.keyMaterial.noncestring

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-m2.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.