Sign in

v1

latestOpenAPI 3.0.02026-07-144898115.8 KB
discovery
cm facing

Discover patient's accounts

Request for patient care context discover, made by CM for a specific HIP. It is expected that HIP will subsequently return either zero or one patient record with (potentially masked) associated care contexts

  1. At least one of the verified identifier matches
  2. Name (fuzzy), gender matches
  3. If YoB was given, age band(+-2) matches
  4. If unverified identifiers were given, one of them matches
  5. If more than one patient records would be found after aforementioned steps, then patient who matches most verified and unverified identifiers would be returned.
  6. If there would be still more than one patients (after ranking) error would be returned
  7. Intended HIP should be able to resolve and identify results returned in the subsequent link confirmation request via the specified transactionId
  8. Intended HIP should store the discovery results with transactionId and care contexts discovered for subsequent link initiation
post/v0.5/care-contexts/discover

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server.

X-HIP-IDstring required

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

correlation-Id for patient discovery and subsequent care context linkage

Example request

{
  "patient": {
    "id": "<patient-id>@<consent-manager-id>",
    "name": "chandler bing",
    "unverifiedIdentifiers": [
      {
        "value": "+919800083232"
      }
    ],
    "verifiedIdentifiers": [
      {
        "value": "+919800083232"
      }
    ],
    "yearOfBirth": 2000
  },
  "requestId": "499a5a4a-7dda-4f20-9b67-e24589627061"
}

Response

Request accepted