v1

latestOpenAPI 3.0.02026-07-14327580.4 KB
consent flow

Result of fetch request for a consent artefact

Must contain either consent or error. Possible reason of errors are

  1. consentId passed through /fetch is invalid
post/v0.5/consents/on-fetch

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

{
  "consent": {
    "consentDetail": {
      "careContexts": [
        {
          "careContextReference": "Episode1",
          "patientReference": "hinapatel79@hospital"
        }
      ],
      "patient": {
        "id": "hinapatel@ndhm"
      },
      "requester": {
        "identifier": {
          "system": "https://www.mciindia.org",
          "type": "REGNO",
          "value": "MH1001"
        },
        "name": "Dr. Manju"
      }
    },
    "signature": "Signature of CM as defined in W3C standards; Base64 encoded"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

Request Accepted