Receive the discovered care contexts of a patient

Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.

POST/api/v3/hiu/patient/care-context/on-discover

The on-discover API endpoint allows HIUs to receive and process the care contexts associated with a patient. When a request is made to this endpoint, it returns a detailed response containing the patient’s care contexts, transaction details, and any errors that occurred. This ensures that HIUs have the necessary information to manage patient care effectively.

NOTE: In the request body, either 'patient' or 'error' must be included.

In case of success scenario, patient object is mandatory and error object is optional

In case of error scenario, error object is mandatory and patient object is optional

Response is mandatory in both scenarios

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-HIU-IDstringRequired

Identifier of the health information user to which the request was intended

Body

transactionIdstringRequired

patientobject[]Required

patient.referenceNumberstringRequired

A patient identifier with which patient is registered in the facility/hospital.Allows alpha numeric characters and special characters like "^[a-zA-Z0-9_\\-@,. ()/:\\\\]{0,255}$"

patient.displaystring

Display text for patient reference.Allows alpha numeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \"':|()/]{0,255}$"

patient.careContextsobject[]Required

List of care contexts linked at the HIP end for the identified patient.

patient.careContexts.referenceNumberstringRequired

An identifier of patient's care context created in HIP. A care context is a group of patient's health data (Not the actual health data).Allows alpha numeric characters and special characters like "^[a-zA-Z0-9_\\-@,. ()/:\\\\]{0,255}$"

patient.careContexts.displaystringRequired

Display text for care context reference. Allows alpha numeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \"':|()/]{0,255}$"

patient.hiTypestringRequired

The health information type

One of DiagnosticReportDischargeSummaryHealthDocumentRecordImmunizationRecordOPConsultationPrescriptionWellnessRecordInvoice

patient.countintegerRequired

The count should match the number of care contexts in the payload

createdAtstringRequired

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1001 - No data found. May be returned either bare (ABDM-1001) or with a trailing ": " separator (ABDM-1001: ); match on the code itself and tolerate the separator.

error.messagestringRequired

The appropriate error message

responseobjectRequired

response.requestIdstringRequired

The request id that was passed.Allows alpha numeric characters and special characters like "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}"

Responses

200

transactionIdstring

patientobject[]

patient.referenceNumberstring

Reference number used while linking the health records of the patient.

patient.displaystring

Displayed information about the care context.

patient.careContextsobject[]

List of care contexts linked at the HIP end for the identified patient.

patient.careContexts.referenceNumberstring

Reference number used while linking the health records of the patient.

patient.careContexts.displaystring

Displayed information about the care context.

patient.hiTypestring

One of DiagnosticReportDischargeSummaryHealthDocumentRecordImmunizationRecordOPConsultationPrescriptionWellnessRecordInvoice

patient.countinteger

Number of health records in the careContext object.

createdAtstring

responseobject

response.requestIdstring

400

Bad Request

Error codes for this module

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1106 - Duplicate On discovery request. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

error.messagestringRequired

401

Unauthorized

Everything returns 401

codestring

900901 - Invalid Credentials. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

messagestring

descriptionstring

403

Forbidden

Error codes for this module

500

Internal Server Error

Error codes for this module

timestampnumberRequired

pathstringRequired

statusintegerRequired

errorstringRequired

The error code and message, if any occurred.

requestIdstringRequired

curl --request POST \
  --url {bridgeUrl}/api/v3/hiu/patient/care-context/on-discover \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'X-HIU-ID: IN2810014366' \
  --header 'Content-Type: application/json' \
  --data '{
  "transactionId": "f901b782-bfdf-4224-9f8d-da2cadc20c0d",
  "patient": [
    {
      "referenceNumber": "abc123",
      "display": "12345",
      "careContexts": [
        {
          "referenceNumber": "abc123",
          "display": "12345"
        }
      ],
      "hiType": "Prescription",
      "count": 1
    }
  ],
  "createdAt": "2024-12-31T05:45:35.429Z",
  "error": {
    "code": "ABDM-1001",
    "message": "No data found"
  },
  "response": {
    "requestId": "f29f0e59-8388-4698-9fe6-05db67aeac46"
  }
}'

{
  "transactionId": "0d36501c-551a-4bb5-b247-eec4bb42984b",
  "patient": [
    {
      "referenceNumber": "example01",
      "display": "abcd-display",
      "careContexts": [
        {
          "referenceNumber": "abcd",
          "display": "123-display"
        }
      ],
      "hiType": "Prescription",
      "count": 1
    }
  ],
  "createdAt": "2023-06-13T08:05:43.030Z",
  "response": {
    "requestId": "d89525a2-3a3f-4d39-98b5-477afb1865f6"
  }
}

Where this fits

You produce this callback by calling This API will be invoked by the patient/user from PHR application to discover his/her health records..

Receive the discovered care contexts of a patient

Authorizations

Headers

Body

Responses

Where this fits​

Where this fits