consent_management

Get Links

Lists the person's linked care contexts at the HIPs given, for choosing what to grant in a consent.

POST/api/consent-management/link/get-links

Authorizations

Authorizationbearer tokenRequired

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

Body

patientIdstringRequired

hipIdsstring[]Required

Responses

200

Example values, scrubbed.

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

Get Links

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/link/get-links \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "patientId": "<PATIENT_ID>",
  "hipIds": [
    "<hip-id-1>",
    "<hip-id-2>"
  ]
}'

[
  {
    "patient": {
      "id": "nithishjanithi@sbx",
      "links": [
        {
          "hip": {
            "id": "DigiLocker_NEGD",
            "name": "<NAME>",
            "type": "HIP"
          },
          "referenceNumber": "nithishjanithi@sbx",
          "display": "Health Document",
          "careContexts": [
            {
              "referenceNumber": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604192056317009",
              "display": "DigiLocker_2026-06-04-19:20:57",
              "hiTypes": [
                "OPConsultation"
              ]
            }
          ],
          "dateCreated": "2026-06-04T13:50:57.157Z"
        },
        {
          "hip": {
            "id": "DigiLocker_NEGD",
            "name": "<NAME>",
            "type": "HIP"
          },
          "referenceNumber": "nithishjanithi@sbx",
          "display": "Health Document",
          "careContexts": [
            {
              "referenceNumber": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604191949954362",
              "display": "DigiLocker_2026-06-04-19:19:51",
              "hiTypes": [
                "OPConsultation"
              ]
            }
          ],
          "dateCreated": "2026-06-04T13:49:51.549Z"
        },
        {
          "hip": {
            "id": "DigiLocker_NEGD",
            "name": "<NAME>",
            "type": "HIP"
          },
          "referenceNumber": "nithishjanithi@sbx",
          "display": "Health Document",
          "careContexts": [
            {
              "referenceNumber": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604190956854815",
              "display": "DigiLocker_2026-06-04-19:09:58",
              "hiTypes": [
                "OPConsultation"
              ]
            }
          ],
          "dateCreated": "2026-06-04T13:39:58.310Z"
        },
        {
          "hip": {
            "id": "DigiLocker_NEGD",
            "name": "<NAME>",
            "type": "HIP"
          },
          "referenceNumber": "nithishjanithi@sbx",
          "display": "Health Document",
          "careContexts": [
            {
              "referenceNumber": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604190355820063",
              "display": "DigiLocker_2026-06-04-19:03:56",
              "hiTypes": [
                "OPConsultation"
              ]
            }
          ],
          "dateCreated": "2026-06-04T13:33:56.753Z"
        },
        {
          "hip": {
            "id": "DigiLocker_NEGD",
            "name": "<NAME>",
            "type": "HIP"
          },
          "referenceNumber": "nithishjanithi@sbx",
          "display": "Health Document",
          "careContexts": [
            {
              "referenceNumber": "25ac532f-178d-5885-9bcb-b82052f345eb_20260604184756756185",
              "display": "DigiLocker_2026-06-04-18:47:57",
              "hiTypes": [
                "OPConsultation"
              ]
            }
          ],
          "dateCreated": "2026-06-04T13:17:57.653Z"
        }
      ]
    }
  }
]

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