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

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

date and time format "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

401

Unauthorized

Everything returns 401

500

Internal Server Error

Error codes for this module

503

Service Unavailable

Error codes for this module