Skip to main content

Receive the other side's transfer status

Hosted by the PHR application and by the HIU, not by ABDM. The HIE-CM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.

POST/api/v3/patient-record/on-notify

This is a callback API for the PHR application and the HIU. This API is used to receive the status of the health record transfer process: the HIU receives what the PHR app sent to notify, and the PHR app receives what the HIU sent.

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

timestampstringRequired

ISO 8601 timestamp of when the callback was sent.

x-hiu-idstringRequired

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

Body

notificationobjectRequired

The transaction id, the session status and each care context's transfer status.

notification.transactionIdstringRequired
notification.doneAtstringRequired

When the transfer completed.

notification.statusNotificationobjectRequired
notification.statusNotification.sessionStatusstringRequired

TRANSFERRED, PARTIAL_TRANSFERRED or FAILED from the PHR app or health locker; RECEIVED, PARTIAL_RECEIVED or FAILED from the HIU.

One of TRANSFERREDPARTIAL_TRANSFERREDRECEIVEDPARTIAL_RECEIVEDFAILED

notification.statusNotification.statusResponsesobject[]Required
notification.statusNotification.statusResponses.careContextReferencestringRequired
notification.statusNotification.statusResponses.hiStatusstringRequired

DELIVERED or ERRORED from the PHR app or health locker; VALID, CORRUPTED, BLANK or ERRORED from the HIU.

One of DELIVEREDERROREDVALIDCORRUPTEDBLANK

notification.statusNotification.statusResponses.descriptionstring

Responses

202

Accepted.

The callback never arrives

Where this fits​

You produce this callback by calling Notify the HIE-CM of the transfer status, once, after the data transfer completes..