care_context_link

Save Care Context Link

Records a care context link for a person, with the HIP it came from and whether its data has been transferred.

POST/api/care-context-link/save

Authorizations

Authorizationbearer tokenRequired

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

Body

hipIdstringRequired

patientIdstringRequired

careContextobjectRequired

careContext.patientReferencestringRequired

careContext.careContextReferencestringRequired

careContext.hiTypesstring[]Required

dataTransferredbooleanRequired

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

Save Care Context Link

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/care-context-link/save \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hipId": "IN0002222",
  "patientId": "<PATIENT_ID>",
  "careContext": {
    "patientReference": "NITHISH_1999",
    "careContextReference": "Prescription566",
    "hiTypes": [
      "Prescription",
      "WellnessRecord",
      "Invoice",
      "OPConsultation",
      "HealthDocumentRecord"
    ]
  },
  "dataTransferred": true
}'

{
  "id": 1018,
  "hipId": "IN0002222",
  "patientId": "<PATIENT_ID>",
  "careContext": {
    "patientReference": "NITHISH_1999",
    "careContextReference": "Prescription566",
    "hiTypes": [
      "Prescription",
      "WellnessRecord",
      "Invoice",
      "OPConsultation",
      "HealthDocumentRecord"
    ]
  },
  "dateCreated": "2026-06-13 17:51:19.114",
  "dateModified": "2026-06-13 17:51:19.114",
  "resourceDate": "2026-06-13 17:51:19.114",
  "dataTransferStatus": "NEW",
  "dataReceived": false,
  "bookmarked": false
}

Generated from the schema. The values are placeholders, not a captured response.