Sign in

v1

latestOpenAPI 3.0.02026-07-144898115.8 KB
data flow
hip facing
hiu facing

Notifications corresponding to events during data flow

API called by HIU and HIP during data-transfer.

  1. HIP on transfer of data would send sessionStatus - one of [TRANSFERRED, FAILED]
  2. HIP would also send hiStatus for each careContextReference - on of [DELIVERED, ERRORED]
  3. HIU on receipt of data would send sessionStatus - one of [TRANSFERRED, FAILED]. For example, FAILED when if data was not sent or if invalid data was sent
  4. HIU would also send hiStatus for each careContextReference - one of [OK, ERRORED]
post/v0.5/health-information/notify

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server.

X-CM-IDstring required

Suffix of the consent manager to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request.

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "notification": {
    "consentId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d",
    "notifier": {
      "id": "tmh"
    },
    "statusNotification": {
      "hipId": "max",
      "statusResponses": [
        {
          "hiStatus": "OK"
        }
      ]
    },
    "transactionId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d"
  },
  "requestId": "499a5a4a-7dda-4f20-9b67-e24589627061"
}

Response

Notification is Accepted