Skip to main content

Notify patient record

Update the status of the health record transfer process.

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

It is invoked by the PHR application and HIU to notify the HIE-CM about the completion status of the transaction and the individual care-contexts. Each care-context's transfer status is included to provide a detailed update on which records were successfully shared and received.

The PHR app or health locker, on the transfer of data, sends sessionStatus as one of TRANSFERRED, PARTIAL_TRANSFERRED or FAILED, and an hiStatus for each careContextReference as one of DELIVERED or ERRORED.

The HIU, on receipt of data, sends sessionStatus as one of RECEIVED, PARTIAL_RECEIVED or FAILED, for example FAILED when data was not received or invalid data was received, and an hiStatus for each careContextReference as one of VALID, CORRUPTED, BLANK or ERRORED.

Send the notification once, after the data transfer has completed. The HIE-CM forwards it to the other side's /api/v3/patient-record/on-notify 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

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 HIE-CM forwards the status to the other side's on-notify callback.

The callback never arrives

Callbacks​

  • After this call, ABDM posts Receive the other side's transfer status. to /api/v3/patient-record/on-notify. Open the callback.