v1

latestOpenAPI 3.0.02026-07-14307078.8 KB

Gateway

Response to patient's care context link request

Result of patient care-context link request from HIP end. This happens in context of previous discovery of patient found at HIP end, therefore the link requests ought to be in reference to the patient reference and care-context references previously returned by the HIP. The correlation of discovery and link request is maintained through the transactionId. HIP should have

Validated transactionId in the request to check whether there was a discovery done previously, and the link request corresponds to returned patient care care context references
Before returning the response, HIP should have sent an authentication request to the patient(eg: OTP verification)
HIP should communicate the mode of authentication of a successful request
HIP subsequently should expect the token passed via /link/confirm against the link.referenceNumber passed in this call

The error section in the body, represents the potential errors that may have occurred. Possible reasons:

Patient reference number is invalid
Care context reference numbers are invalid

post/v0.5/links/link/on-init

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

Suffix of the consent manager 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

transactionIdstring uuid required

Example request

{
  "link": {
    "meta": {
      "communicationExpiry": "2019-12-30T12:01:55Z"
    }
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd",
  "transactionId": "a1s2c932-2f70-3ds3-a3b5-2sfd46b12a18d"
}

Response

Request accepted