Sign in

v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
link

Link patient's care contexts

Request from Gateway to links care contexts associated with only one patient

  1. Validate account reference number and care context reference number
  2. Validate transactionId in the request with discovery request entry to check whether there was a discovery and were these care contexts discovered or not for a given patient
  3. Before eventual link confirmation, HIP needs to authenticate the request with the patient(eg: OTP verification)
  4. HIP should communicate the mode of authentication of a successful request to Consent Manager
post/v0.5/links/link/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-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

{
  "patient": {
    "id": "hinapatel79@ndhm",
    "referenceNumber": "TMH-PUID-001"
  }
}

Response

Request accepted