Skip to main content

Submit the reply to a share request with the data push URL and the encryption key

Acts as the callback endpoint for the PHR application.

POST/api/hiecm/patient-record/v3/on-share

After the initial request, the HIU responds to this callback with the data push URL and the encryption key required for securely transferring the user's health records.

The HIU makes this call after receiving the share request on its /api/v3/patient-record/share bridge endpoint. The transactionId is the one that request carried, and response.requestId is that request's REQUEST-ID. The HIE-CM forwards the body to the PHR app's /api/v3/patient-record/on-share callback.

Authorizations

Authorizationbearer tokenRequired

JWT access token issued by the ABDM session API after successful validation of client id and secret.

Headers

REQUEST-IDstringRequired

Random UUID, a v4 style guid, unique per request.

TIMESTAMPstringRequired

ISO 8601 timestamp of when the request was initiated.

X-HIU-IDstringRequired

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

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended. sbx in the sandbox, abdm in production.

Body

hiRequestobjectRequired

The data push URL and the encryption key.

hiRequest.transactionIdstringRequired

The transactionId the share request carried.

hiRequest.dataPushUrlstringRequired

The HIU's URL the PHR app posts the encrypted records to.

hiRequest.keyMaterialobjectRequired
responseobjectRequired
response.requestIdstringRequired

The REQUEST-ID of the share request this answers.

Responses

202

Accepted. The HIE-CM forwards the data push URL and key to the PHR app's on-share callback.

The callback never arrives

Callbacks​

  • After this call, ABDM posts Receive the HIU's data push URL and encryption key, as the PHR app. to /api/v3/patient-record/on-share. Open the callback.
  • After this call, ABDM posts Receive the encrypted records at the data push URL, as the HIU. to /health-information/transfer. Open the callback.