data transfer

Notify the gateway that a data transfer finished

Also known as: HIP Data Flow Notification. After successfully pushing all encrypted FHIR health data to the HIU's dataPushUrl, the HIP calls this endpoint to notify the ABDM Gateway that the data transfer session is complete. The Gateway relays this status to the HIU.

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

Authorizations

Authorizationbearer tokenRequired

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

Body

notificationobjectRequired

notification.consentIdstringRequired

notification.transactionIdstringRequired

notification.doneAtstringRequired

notification.notifierobjectRequired

notification.notifier.typestring

One of HIPHIU

notification.notifier.idstring

notification.statusNotificationobjectRequired

notification.statusNotification.sessionStatusstring

One of TRANSFERREDFAILED

notification.statusNotification.hipIdstring

notification.statusNotification.statusResponsesobject[]

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

Notify the gateway that a data transfer finished

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/data-flow/v3/health-information/notify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "notification": {
    "consentId": "consent-art-uuid-001",
    "transactionId": "txn-uuid-data-001",
    "doneAt": "2024-01-15T10:30:00.000Z",
    "notifier": {
      "type": "HIP",
      "id": "HIP_SERVICE_ID"
    },
    "statusNotification": {
      "sessionStatus": "TRANSFERRED",
      "hipId": "HIP_SERVICE_ID",
      "statusResponses": [
        {
          "careContextReference": "VISIT-2024-001",
          "hiStatus": "OK",
          "description": "Successfully transferred"
        }
      ]
    }
  }
}'

Notification accepted