consent_management

Initiate Subscription Request

Raises a subscription request as a HIU: asks to be notified when the patient links new care contexts at the HIPs and categories named, for a period.

POST/api/consent-management/subscription-requests/init

Authorizations

Authorizationbearer tokenRequired

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

Body

hiuobjectRequired

hiu.idstringRequired

patientobjectRequired

patient.idstringRequired

purposeobjectRequired

purpose.textstringRequired

purpose.codestringRequired

purpose.refUristringRequired

hipsobject[]Required

hips.idstringRequired

categoriesstring[]Required

periodobjectRequired

period.fromstringRequired

period.tostringRequired

Responses

400

Example values, scrubbed.

Error codes for this module

401

Example values, scrubbed.

Everything returns 401

Initiate Subscription Request

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/subscription-requests/init \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiu": {
    "id": "<hiu-id>"
  },
  "patient": {
    "id": "<abha-address>@abdm"
  },
  "purpose": {
    "text": "Care Management",
    "code": "CAREMGT",
    "refUri": "www.abdm.gov.in"
  },
  "hips": [
    {
      "id": "<hip-id>"
    }
  ],
  "categories": [
    "LINK",
    "DATA"
  ],
  "period": {
    "from": "2021-01-01T00:00:00.000Z",
    "to": "2023-12-31T23:59:59.999Z"
  }
}'

{
  "code": "<CODE>",
  "message": "<MESSAGE>"
}

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