Skip to main content

Discover his/her health records

Be invoked by the patient or user through the Personal Health Record (PHR) application to discover their health records.

POST/api/hiecm/user-initiated-linking/v3/patient/care-context/discover

By using this API, patients can initiate a search to locate and access their health information across various Health Information Providers (HIPs). This functionality empowers patients to have greater control and visibility over their health data, facilitating a more informed and engaged approach to managing their health. The API supports the seamless retrieval of health records, ensuring that patients can easily discover and review their care contexts.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

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

Suffix of the consent manager to which the request was intended

X-HIU-IDstringRequired

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

X-AUTH-TOKENstringRequired

JWT Authentication token which was issued by ABDM after successful validation of username and password

Body

hipobjectRequired

Identifier and name of the health information provider.

hip.idstringRequired

The service ID of the health information provider

unverifiedIdentifiersobject[]Required

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

unverifiedIdentifiers.typestringRequired

One of MRMOBILEABHA_NUMBERABHA_ADDRESS

unverifiedIdentifiers.valuestringRequired

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

Responses

202

Accepted

The callback never arrives

400

Bad Request

Error codes for this module

401

Unauthorized

Everything returns 401

403

Forbidden

Error codes for this module

500

Internal Server Error -> It is just one example, for every api the path will be changed.

Error codes for this module