Sign in

v1

latestOpenAPI 3.0.02026-07-144898115.8 KB
subscriptions
cm facing

Notification to HIU on basis of a granted subscription

This API is used by CM to notify a HIU for notification relevant to subscription. Notifications are sent to subscribed HIUs whenever a new care-context is linked or new data is available on an existing linked care-context.

  1. if event.category = LINK, then only care-contexts are passed when new care-contexts are linked for patient.
  2. If event.category = DATA, then hiTypes are passed. Care-context is passed only if the subscribed HIU has any valid consent for that care-context
post/v0.5/subscriptions/hiu/notify

Headers

Authorizationstring required

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

X-HIU-IDstring required

Identifier of the health information user 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

{
  "event": {
    "content": {
      "context": [
        {
          "careContext": {
            "careContextReference": "Episode1",
            "patientReference": "batman@tmh"
          }
        }
      ],
      "patient": {
        "id": "hinapatel79@ndhm"
      }
    },
    "id": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d",
    "subscriptionId": "subscription Id"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted