Skip to main content

data retrieval

Notify the gateway that data was received

Also known as: HIU Data Flow Notification. After receiving all FHIR health data at the dataPushUrl, the HIU calls this endpoint to notify the ABDM Gateway that the data transfer session is complete.

MandatoryAny one of them is mandatory

Certification cases HIP_INIT_SHARE_CARECONTEXT, HIU_FLOW_101, HIU_FLOW_102, HIU_FLOW_103, HIU_FLOW_104, HIU_FLOW_105, HIU_FLOW_106, HIU_FLOW_107, HIU_FLOW_108, HIU_FLOW_109, HIU_FLOW_110, HIU_FLOW_111, HIU_FLOW_112, HIU_FLOW_113

POST/hiecm/data-flow/v3/health-information/notify

The statusNotification.sessionStatus should be: - RECEIVED, All data received successfully - FAILED, Data receipt failed (with details in statusResponses)

The notifier.type must be HIU (contrast with M2 where the HIP sends the same endpoint with notifier.type: HIP, and the value it sends is TRANSFERRED rather than RECEIVED; the two milestones report the same event with different values because they are the two ends of the same transfer).

Authorizations

Authorizationbearer tokenRequired

Bearer token obtained from POST /hiecm/gateway/v3/sessions

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. The callback that answers it carries the same value. In M3 a single consent can produce several callbacks, so keep the mapping from request id to consent request id rather than relying on ordering.

TIMESTAMPstringRequired

The current time in ISO 8601 UTC, with milliseconds and the Z suffix. The gateway rejects a request whose timestamp has drifted too far from its own clock, so take this from a synchronised clock rather than from a local one.

X-CM-IDstringRequired

Which consent manager you are talking to. sbx on the sandbox and abdm in production.

Body

notificationobjectRequired
notification.consentIdstringRequired
notification.transactionIdstringRequired
notification.doneAtstringRequired
notification.notifierobjectRequired
notification.notifier.typestringRequired

Must be "HIU" for M3 (vs "HIP" for M2)

One of HIPHIU

notification.notifier.idstringRequired
notification.statusNotificationobjectRequired
notification.statusNotification.sessionStatusstringRequired

HIU-side value, this is the M3 half of the exchange. RECEIVED on success, not TRANSFERRED, which is what the HIP sends on the M2 side of the same event.

One of RECEIVEDFAILED

notification.statusNotification.hipIdstringRequired
notification.statusNotification.statusResponsesobject[]Required
notification.statusNotification.statusResponses.careContextReferencestring
notification.statusNotification.statusResponses.hiStatusstring

One of OKERRORED

notification.statusNotification.statusResponses.descriptionstring

Responses

202

Notification accepted

The callback never arrives

400

Bad request, invalid parameters or missing fields

Error codes for this module

401

Unauthorized, missing or invalid Bearer token

Everything returns 401

Last updated on