Receive the transferred health information

NOTE: This API is actually the callback URL that is passed as dataPushUrl in the data request API - /api/v3/hip/health-information/request.

POST/health-information/transfer

This API is directly called by HIP Data Bridge and is not mediated via CM, and hence not routed through the Gateway.

This API should be implemented at HIU side. It may be implemented by the Data Bridge representing the HIU.

Entry elements may be content or link, although for version 1, entry content is preferred.

Entry content (or even link reference content) must be encrypted by means of Elliptic-curve Diffie–Hellman Key Exchange, using the HIU key materials that are passed through the data request API - /api/v3/hip/health-information/request.

Media contains the mimetype of content, and for v1, it is "application/fhir+json".

Checksum is MD5 checksum of the data content, before encryption.

Please refer to the ABDM Sandbox Documentation for the format of FHIR bundle that is passed through content.

Authorisation token is mandatory for this API.

Authorizations

Authorizationbearer tokenRequired

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

Body

pageNumberintegerRequired

Current page number.

pageCountintegerRequired

Total number of pages.

transactionIdstringRequired

Transaction Id issued when data requested.

entriesobject[]Required

entries.contentstringRequired

Encrypted content

entries.mediastringRequired

One of application/fhir+json

entries.checksumstringRequired

Md5 checksum of the content before encryption

entries.careContextReferencestringRequired

care context reference number.

keyMaterialobjectRequired

Encryption and decryption key details.

keyMaterial.cryptoAlgstringRequired

One of ECDH

keyMaterial.curvestringRequired

One of Curve25519

keyMaterial.dhPublicKeyobjectRequired

keyMaterial.dhPublicKey.expirystringRequired

keyMaterial.dhPublicKey.parametersstringRequired

Parameters of the encryption and decryption key.

One of Curve25519/32byte random key

keyMaterial.dhPublicKey.keyValuestringRequired

keyMaterial.noncestringRequired

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

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

error.messagestringRequired

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.