Skip to main content

Submit the health information data request from HIU

Facilitates the exchange of health data between Health Information Providers (HIP) and Health Information Users (HIU) within the ABDM system.

POST/api/hiecm/data-flow/v3/health-information/request

It ensures secure and efficient data transfer, enabling seamless communication and interoperability between different healthcare entities.

  1. X-HIU-ID if the requester is HIU (SERVICE-ID).

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

Suffix of the consent manager to which the request was intended

X-HIU-IDstringRequired

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

Body

hiRequestobjectRequired
hiRequest.consentobjectRequired
hiRequest.consent.idstringRequired

The consent artefact id for health information request. Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$"

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

202

Accepted

The callback never arrives

400

Bad Request

Error codes for this module

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1015 - Invalid Response. May be returned either bare (ABDM-1015) or with a trailing ": " separator (ABDM-1015: ); match on the code itself and tolerate the separator.

error.messagestringRequired
401

Unauthorized

Everything returns 401

codestringRequired

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

messagestringRequired
descriptionstringRequired
403

Access Denied

Error codes for this module

404

Not Found

Error codes for this module

500

Internal Server Error

Error codes for this module

codestring

900900 - Unclassified Authentication Failure. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

messagestring
descriptionstring
503

Service Unavailable

Error codes for this module

codestringRequired

ABDM-1024 - Dependent service unavailable. May be returned either bare (ABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.

messagestringRequired

Callbacks​

  • After this call, ABDM posts Health information data request acknowledgement to HIU. to /api/v3/hiu/health-information/on-request. Open the callback.