care_context_link

Health Information Data Transfer (HIP to HIU)

Receives a page of encrypted health information from a HIP, with the key material needed to decrypt it. Pages arrive in sequence under one transaction id.

POST/api/care-context-link/v0.5/health-information/transfer

Authorizations

Authorizationbearer tokenRequired

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

Body

pageNumberintegerRequired

pageCountintegerRequired

transactionIdstringRequired

entriesobject[]Required

entries.contentstringRequired

entries.mediastringRequired

entries.checksumstringRequired

entries.careContextReferencestringRequired

keyMaterialobjectRequired

keyMaterial.cryptoAlgstringRequired

keyMaterial.curvestringRequired

keyMaterial.dhPublicKeyobjectRequired

keyMaterial.dhPublicKey.expirystringRequired

keyMaterial.dhPublicKey.parametersstringRequired

keyMaterial.dhPublicKey.keyValuestringRequired

keyMaterial.noncestringRequired

Responses

200

No response body is documented for this request.

Health Information Data Transfer (HIP to HIU)

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/care-context-link/v0.5/health-information/transfer \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pageNumber": 1,
  "pageCount": 1,
  "transactionId": "txn-001",
  "entries": [
    {
      "content": "<encrypted-content-here>",
      "media": "application/fhir+json",
      "checksum": "checksum-value",
      "careContextReference": "care-context-ref-001"
    }
  ],
  "keyMaterial": {
    "cryptoAlg": "ECDH",
    "curve": "curve25519",
    "dhPublicKey": {
      "expiry": "2026-12-31T00:00:00.000Z",
      "parameters": "Ephemeral public key",
      "keyValue": "<KEYVALUE>"
    },
    "nonce": "<nonce-value>"
  }
}'

No response body is documented for this request.