consent_management

Edit Subscription

Edits a subscription and approves it in the same step, changing which HIPs and categories the HIU is subscribed to.

PUT/api/consent-management/patients/subscription-requests/{subscriptionId}

Authorizations

Authorizationbearer tokenRequired

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

Path parameters

subscriptionIdstringRequired

Passed as a path segment.

Body

hiuIdstringRequired

subscriptionEditAndApprovalRequestobjectRequired

subscriptionEditAndApprovalRequest.isApplicableForAllHIPsbooleanRequired

subscriptionEditAndApprovalRequest.includedSourcesobject[]Required

subscriptionEditAndApprovalRequest.includedSources.hiTypesstring[]Required

subscriptionEditAndApprovalRequest.includedSources.purposeobjectRequired

subscriptionEditAndApprovalRequest.includedSources.purpose.textstringRequired

subscriptionEditAndApprovalRequest.includedSources.purpose.codestringRequired

subscriptionEditAndApprovalRequest.includedSources.purpose.refUristringRequired

subscriptionEditAndApprovalRequest.includedSources.categoriesstring[]Required

subscriptionEditAndApprovalRequest.includedSources.periodobjectRequired

subscriptionEditAndApprovalRequest.includedSources.period.fromstringRequired

subscriptionEditAndApprovalRequest.includedSources.period.tostringRequired

subscriptionEditAndApprovalRequest.excludedSourcesobject[]Required

Responses

401

Example values, scrubbed.

Everything returns 401

500

Example values, scrubbed.

Error codes for this module

Edit Subscription

curl --request PUT \
  --url https://phrsbx.abdm.gov.in/api/consent-management/patients/subscription-requests/{subscriptionId} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiuId": "<HIU_ID>",
  "subscriptionEditAndApprovalRequest": {
    "isApplicableForAllHIPs": true,
    "includedSources": [
      {
        "hiTypes": [
          "DiagnosticReport",
          "Prescription",
          "ImmunizationRecord",
          "DischargeSummary",
          "OPConsultation",
          "HealthDocumentRecord",
          "WellnessRecord"
        ],
        "purpose": {
          "text": "Care Management",
          "code": "CAREMGT",
          "refUri": "www.abdm.gov.in"
        },
        "categories": [
          "DATA",
          "LINK"
        ],
        "period": {
          "from": "2024-01-09T09:00:00.000Z",
          "to": "2123-12-31T09:00:00.000Z"
        }
      }
    ],
    "excludedSources": []
  }
}'

{
  "code": "ABDM-9999: ",
  "message": "Authentication required"
}

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