v1

latestOpenAPI 3.0.02026-07-14327580.4 KB

subscriptions

Notification for subscription grant/deny/revoke

This API is used by CM to notify a HIU to grant or deny a request for subscription, and also to notify that in case an existing subscription is revoked or expired. For notifying that a particular subscription request was GRANTED or DENIED, the subscriptionRequestId is passed.

post/v0.5/subscription-requests/hiu/notify

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

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

{
  "notification": {
    "subscription": {
      "id": "subscription Id",
      "patient": {
        "id": "hinapatel@ndhm"
      }
    },
    "subscriptionRequestId": "request id of the subscription"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted