Documentation

Care context linking

curl --request POST \
  --url https://api.eka.care/abdm/v1/care-contexts/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "abha_address": "<string>",
  "care_contexts": [
    {
      "care_context_id": "<string>",
      "data": "<string>",
      "display": "<string>",
      "hi_type": "OPConsultation",
      "hi_types": [
        "<string>"
      ]
    }
  ],
  "oid": "<string>",
  "partner_user_id": "<string>"
}
'

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

HIP Inititated Linking

Care context linking

Use this API to link a care context to the patient’s ABHA address. A care context represents a visit, test, or any logical grouping of health records.

After calling this API, listen for the abha.link_care_context webhook to confirm whether the linking was successful. Once linked, other HIUs can request data for this care context through ABDM’s consent flow.

You can optionally pass the FHIR data as a base64-encoded string in the data field. If provided, Eka stores it and handles data sharing automatically — you won’t need to handle the abha.hip_data_fetch webhook. If not provided, you will receive the abha.hip_data_fetch webhook when an HIU requests the data.

POST

abdm

care-contexts

link

Care context linking

curl --request POST \
  --url https://api.eka.care/abdm/v1/care-contexts/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "abha_address": "<string>",
  "care_contexts": [
    {
      "care_context_id": "<string>",
      "data": "<string>",
      "display": "<string>",
      "hi_type": "OPConsultation",
      "hi_types": [
        "<string>"
      ]
    }
  ],
  "oid": "<string>",
  "partner_user_id": "<string>"
}
'

{
  "code": 123,
  "error": "<string>",
  "source_error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id

string

Eka User ID (OID)

X-Partner-Pt-Id

string

Partner User ID

X-Hip-Id

string

Partner HIP ID

Body

application/json

abha_address

string

care_contexts

object[] | null

Show child attributes

oid

string

partner_user_id

string

Response

Accepted

Get Linked CareContexts Care Context Discovery

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Care context linking

Authorizations

Headers

Body

Response