v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
Gateway

Token authenticated by HIP, indicating completion of linkage of care-contexts

Returns a list of linked care contexts with patient reference number.

  1. Validated and linked account reference number
  2. Validated that the token sent from Consent Manager is same as the one generated by HIP
  3. Verified that same Consent Manager which made the link request is sending the token
  4. Results of unmasked linked care contexts with patient reference number
post/v0.5/links/link/on-confirm

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

Example request

{
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

accepted