Sign in

v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
data flow

Health information data request

API called by CM to request Health information from HIP against a validated consent artefact. The transactionId is the correlation id that HIP should use use when pushing data to the dataPushUrl.

post/v0.5/health-information/hip/request

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-HIP-IDstring required

Identifier of the health information provider to which the request was intended.

Request body

requestIdstring uuid required
timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

transactionIdstring uuid required

Example request

{
  "hiRequest": {
    "keyMaterial": {
      "cryptoAlg": "ECDH",
      "curve": "Curve25519",
      "dhPublicKey": {
        "parameters": "Curve25519/32byte random key"
      },
      "nonce": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  },
  "requestId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d",
  "transactionId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d"
}

Response

Request accepted.