Sign in

v1

latestOpenAPI 3.0.02026-07-14307078.8 KB
Gateway

API for HIP initiated care-context linking for patient

API to submit care-context to CM for HIP initiated linking. The API must accompany the "accessToken" fetched in the users/auth process.

  1. subsequent usage for accessToken may be invalid if it was meant for one-time usage or if it expired
post/v0.5/links/link/add-contexts

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

{
  "link": {
    "patient": {
      "referenceNumber": "TMH-PUID-001"
    }
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

accepted