Skip to main content

Discover care contexts associated with 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/hip/patient/care-context/discover

The discover API endpoint facilitates the discovery of care contexts linked to a specific patient. When a request is made to this endpoint, it returns detailed information about the patient, including verified and unverified identifiers, ensuring accurate patient identification and continuity of care.

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-HIP-IDstringRequired

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

Body

transactionIdstringRequired

UUID

patientobjectRequired
patient.idstringRequired

A patient identifier with which patient is registered in the facility/hospital

patient.verifiedIdentifiersobject[]Required
patient.verifiedIdentifiers.typestringRequired

One of MRMOBILEABHA_NUMBERABHA_ADDRESSEMAIL

patient.verifiedIdentifiers.valuestringRequired

Allows alphanumeric characters and special characters like "^(\\+)?[a-zA-Z0-9_\\-@,. ]{0,255}$".

patient.unverifiedIdentifiersobject[]

Identifiers with which the HIP will search for the patient in its own records.

patient.unverifiedIdentifiers.typestringRequired

One of MRMOBILEABHA_NUMBERABHA_ADDRESSEMAIL

patient.unverifiedIdentifiers.valuestringRequired

Allows alphanumeric characters and special characters like "^(\\+)?[a-zA-Z0-9_\\-@,. ]{0,255}$".

patient.namestringRequired
patient.genderstringRequired

One of MFODTU

patient.yearOfBirthnumberRequired

Responses

202

Accepted

The callback never arrives

400

Bad Request

Error codes for this module

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1103 - Duplicate 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

Where this fits​

Answer this callback by calling HMIS/LIMS/HIP has to ensure that only unlinked records of the patient has to be shared through this API..