consent_management

Init Consent Request

Raises a consent request as a HIU: names the patient, the purpose, the record types and the period of care wanted.

POST/api/consent-management/consent/request/init

Authorizations

Authorizationbearer tokenRequired

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

Body

consentobjectRequired

consent.purposeobjectRequired

consent.purpose.textstringRequired

consent.purpose.codestringRequired

consent.purpose.refUristringRequired

consent.patientobjectRequired

consent.patient.idstringRequired

consent.hiuobjectRequired

consent.hiu.idstringRequired

consent.hipobjectRequired

consent.hip.idstringRequired

consent.careContextsnullRequired

consent.requesterobjectRequired

consent.requester.namestringRequired

consent.requester.identifierobjectRequired

consent.requester.identifier.typestringRequired

consent.requester.identifier.valuestringRequired

consent.requester.identifier.systemstringRequired

consent.hiTypesstring[]Required

consent.permissionobjectRequired

consent.permission.accessModestringRequired

consent.permission.dateRangeobjectRequired

consent.permission.dateRange.fromstringRequired

consent.permission.dateRange.tostringRequired

consent.permission.dataEraseAtstringRequired

consent.permission.frequencyobjectRequired

consent.permission.frequency.unitstringRequired

consent.permission.frequency.valueintegerRequired

consent.permission.frequency.repeatsintegerRequired

Responses

400

Example values, scrubbed.

Error codes for this module

401

Example values, scrubbed.

Everything returns 401

Init Consent Request

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/consent/request/init \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "consent": {
    "purpose": {
      "text": "Care management",
      "code": "CAREMGT",
      "refUri": "www.abdm.gov.in"
    },
    "patient": {
      "id": "nithishjanithi@sbx"
    },
    "hiu": {
      "id": "IN0002222"
    },
    "hip": {
      "id": "wdwsd"
    },
    "careContexts": null,
    "requester": {
      "name": "<NAME>",
      "identifier": {
        "type": "REGNO1",
        "value": "MH1001",
        "system": "https://www.mciindia.9985"
      }
    },
    "hiTypes": [
      "Prescription"
    ],
    "permission": {
      "accessMode": "VIEW",
      "dateRange": {
        "from": "2023-05-09T08:58:09.738Z",
        "to": "2025-04-12T09:00:00.738Z"
      },
      "dataEraseAt": "2026-09-10T12:26:00.738Z",
      "frequency": {
        "unit": "HOUR",
        "value": 0,
        "repeats": 0
      }
    }
  }
}'

{
  "code": "ABDM-9999: ",
  "message": "Invalid data erase date or date must be a future date"
}

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