Sign in

v1

latestOpenAPI 3.0.02026-07-14327580.4 KB
consent flow

Consent notification

Health information user will get notified about the consent request granted or denied, consent revoked, consent expired.

  1. For consent request grant, status=GRANTED, consentRequestId=<consent-request-id>, and consentArtefacts is an array of generated consent artefact Ids.
  2. For consent request expiry, status=EXPIRED, consentRequestId=<consent-request-id>
  3. For consent request denied, status=DENIED, consentRequestId=<consent-request-id>
  4. For consent revocation, status=REVOKED, consentArtefacts is an array of revoked consent artefact ids
post/v0.5/consents/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": {
    "consentArtefacts": [
      {
        "id": "<consent-artefact-id>"
      }
    ],
    "consentRequestId": "<consent-request-id>"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted.