v1

latestOpenAPI 3.0.02026-07-14327580.4 KB

subscriptions

callback API for the /subscription-requests/cm/init to notify a HIU on acceptance/acknowledgement of the request for subscription.

This callback API acknowledges the request for subscription from a HIU, and sends back a "id" that will be used when the patient/user approves or denies the subscription.

post/v0.5/subscription-requests/hiu/on-init

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

{
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd",
  "subscriptionRequest": {
    "id": "f29f0e59-8388-4698-9fe6-05db67aeac46"
  }
}

Response

Request Accepted.