Sign in

v1

latestOpenAPI 3.0.02026-07-144898115.8 KB
consent flow
cm facing

Consent notification

Notification of consents to health information providers consent request granted, consent revoked, consent expired. Only the GRANTED, REVOKED and EXPIRED status notifications will be sent to HIP.

  1. If consent is granted, status=GRANTED, then consentDetail contains the consent artefact details and signature is available.
  2. If consent is revoked, then status=REVOKED, and consentId specifes which consent artefact is revoked.
  3. If the consent has expired, then status=EXPIRED, and consentId specifies which consent artefact has expired. Note, this is also responsibility of the HIP to keep track of consent expiry. Any data request on expired consent artefact must not be done.
post/v0.5/consents/hip/notify

Headers

Authorizationstring required

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

X-HIP-IDstring required

Identifier of the health information provider 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": {
    "consentDetail": {
      "careContexts": [
        {
          "careContextReference": "Episode1",
          "patientReference": "hinapatel79@hospital"
        }
      ],
      "patient": {
        "id": "hinapatel79@ndhm"
      }
    },
    "signature": "Signature of CM as defined in W3C standards; Base64 encoded"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted