consent_management

HIU On-Fetch (Consent Artefact Fetch Callback)

Callback the gateway sends with a consent artefact the HIU asked to fetch, or the error that stopped it.

POST/api/consent-management/consent/on-fetch

Authorizations

Authorizationbearer tokenRequired

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

Body

requestIdstringRequired

timestampstringRequired

consentobjectRequired

consent.statusstringRequired

consent.consentDetailobjectRequired

consent.consentDetail.consentIdstringRequired

consent.consentDetail.createdAtstringRequired

consent.consentDetail.patientobjectRequired

consent.consentDetail.patient.idstringRequired

consent.consentDetail.careContextsobject[]Required

consent.consentDetail.purposeobjectRequired

consent.consentDetail.purpose.textstringRequired

consent.consentDetail.purpose.codestringRequired

consent.consentDetail.hipobjectRequired

consent.consentDetail.hip.idstringRequired

consent.consentDetail.hiuobjectRequired

consent.consentDetail.hiu.idstringRequired

consent.consentDetail.consentManagerobjectRequired

consent.consentDetail.consentManager.idstringRequired

consent.consentDetail.hiTypesstring[]Required

consent.consentDetail.permissionobjectRequired

consent.consentDetail.permission.accessModestringRequired

consent.consentDetail.permission.dateRangeobjectRequired

consent.consentDetail.permission.dataEraseAtstringRequired

consent.consentDetail.permission.frequencyobjectRequired

consent.signaturestringRequired

respobjectRequired

resp.requestIdstringRequired

Responses

200

No response body is documented for this request.

HIU On-Fetch (Consent Artefact Fetch Callback)

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/consent-management/consent/on-fetch \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requestId": "<GENERATED>",
  "timestamp": "<ISO_8601_TIMESTAMP>",
  "consent": {
    "status": "GRANTED",
    "consentDetail": {
      "consentId": "<consent-artefact-id>",
      "createdAt": "<ISO_8601_TIMESTAMP>",
      "patient": {
        "id": "<abha-address>@abdm"
      },
      "careContexts": [],
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT"
      },
      "hip": {
        "id": "<hip-id>"
      },
      "hiu": {
        "id": "<hiu-id>"
      },
      "consentManager": {
        "id": "sbx.abdm.gov.in"
      },
      "hiTypes": [
        "OPConsultation"
      ],
      "permission": {
        "accessMode": "VIEW",
        "dateRange": {
          "from": "2021-01-01T00:00:00.000Z",
          "to": "2023-12-31T23:59:59.999Z"
        },
        "dataEraseAt": "2024-12-31T23:59:59.999Z",
        "frequency": {
          "unit": "HOUR",
          "value": 1,
          "repeats": 0
        }
      }
    },
    "signature": "<signature>"
  },
  "resp": {
    "requestId": "<original-request-id>"
  }
}'

No response body is documented for this request.