Skip to main content

Link on carecontext

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/link/on_carecontext

This API endpoint serves as a callback for the /api/hiecm/hip/v3/link/carecontext API. It is used to communicate the outcome of the care context linking process. The response will vary based on the success or failure of the linking operation:

<br><br/> <ol> <li>If the linking is successful, pass the successful message </li> <li>If the linking is unsuccessful, pass the error message with the error code and message </li> </ol>

Authorizations

Authorizationbearer tokenRequired

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

Responses

200

OK

401

Unauthorized

Everything returns 401

404

server cannot find the requested resource

Error codes for this module

500

Internal Server Error

Error codes for this module

Where this fits

hiecm-m2.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.