Skip to main content

Confirm the linking of care contexts for 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/link/care-context/confirm

The confirm API endpoint facilitates the confirmation of care context linking for a patient. When a request is made to this endpoint, it verifies the linking process using a provided token and reference number. This ensures that the care contexts are accurately linked to the patient’s ABHA (Ayushman Bharat Health Account) address.

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

Body

confirmationobjectRequired
confirmation.tokenintegerRequired

The token number. Must be 6 digit and contain only 0-9

confirmation.linkRefNumberstringRequired

The link reference number random uuid. Allows alpha numeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \"':|()/]{0,255}$"

Responses

200

OK

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

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.