consent_management

Approve Consent Request

Approves a consent request. consents names the HIPs and care contexts the person is granting, and the artefact ids come back.

POST/api/consent-management/consent-requests/{consentRequestId}/approve

Authorizations

Authorizationbearer tokenRequired

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

Path parameters

consentRequestIdstringRequired

Passed as a path segment.

Body

consentsobject[]Required

consents.hiTypesstring[]Required

consents.hipobjectRequired

consents.hip.idstringRequired

consents.careContextsobject[]Required

consents.careContexts.patientReferencestringRequired

consents.careContexts.careContextReferencestringRequired

consents.permissionobjectRequired

consents.permission.accessModestringRequired

consents.permission.dateRangeobjectRequired

consents.permission.dateRange.fromstringRequired

consents.permission.dateRange.tostringRequired

consents.permission.dataEraseAtstringRequired

consents.permission.frequencyobjectRequired

consents.permission.frequency.unitstringRequired

consents.permission.frequency.valueintegerRequired

consents.permission.frequency.repeatsintegerRequired

Responses

200

Example values, scrubbed.

500

Example values, scrubbed.

Error codes for this module

Approve Consent Request

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/consent-requests/{consentRequestId}/approve \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "consents": [
    {
      "hiTypes": [
        "OPConsultation"
      ],
      "hip": {
        "id": "wdwsd"
      },
      "careContexts": [
        {
          "patientReference": "nithishjanithi@sbx",
          "careContextReference": "25ac532f-178d-5885-9bcb-b82052f345eb_20260428112424637418"
        }
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2023-05-09T08:58:09.738Z",
          "to": "2025-04-12T09:00:00.738Z"
        },
        "dataEraseAt": "2026-09-12T13:26:00.738Z",
        "frequency": {
          "unit": "HOUR",
          "value": 0,
          "repeats": 0
        }
      }
    }
  ]
}'

{
  "message": "<MESSAGE>",
  "consentIds": [
    {
      "id": "<ID>"
    }
  ],
  "error": {
    "code": "<CODE>",
    "message": "<MESSAGE>"
  }
}

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