v1

latestOpenAPI 3.0.02026-07-14327580.4 KB

data flow

Health information data request

Callback API for acknowledgement of Health information request made by HIU. Gateway calls this API when request has validated for the specified consent id. Either the hiRequest or error would be specified. If the health info request was valid, then the hiRequest.transactionId specifies the transaction context against which HIP would send over the data. Possible cases of errors are

Invalid consent artefact id
Consent has expired
Date ranges are invalid

post/v0.5/health-information/hiu/on-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-HIU-IDstring required

Identifier of the health information user 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

Example request

{
  "hiRequest": {
    "transactionId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d"
  },
  "requestId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d"
}

Response

Request Accepted