Get health locker settings of a patient by locker ID

GET/api/hiecm/subscription-requests/v3/patients/lockers/{locker-id}

By invoking this API, users can access detailed information about the configuration and preferences of the patient’s health locker. This functionality is essential for managing and customizing the storage and access settings of health records, ensuring that patients have control over their health information. The API supports secure and efficient retrieval of health locker settings, enhancing the overall management of health data within the healthcare ecosystem.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Path parameters

locker-idstringRequired

The locker id

Headers

REQUEST-IDstringRequired

Unique UUID for tracking the end-to-end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds, and milliseconds

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

X-AUTH-TOKENstringRequired

JWT Authentication token issued by ABDM after successful validation of username and password

Responses

200

lockerIdstring

lockerNamestring

activeboolean

dateCreatedstring

subscriptionsobject[]

subscriptions.subscriptionIdstringRequired

subscriptions.purposeobjectRequired

subscriptions.purpose.textstringRequired

One of Care ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requested

subscriptions.purpose.codestringRequired

One of CAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQT

subscriptions.purpose.refUristringRequired

The reference URL. Allows alpha numeric character and special characters like "^[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&//=]*)$"

subscriptions.statusstringRequired

One of REQUESTEDGRANTEDDENIEDEXPIREDREVOKED

subscriptions.dateCreatedstringRequired

subscriptions.dateGrantedstringRequired

subscriptions.patientobjectRequired

subscriptions.patient.idstringRequired

The abha address of the patient. Must start with Alphanumeric . and _ in the middle and must be ending with @abdm or @sbx

subscriptions.requesterobjectRequired

subscriptions.requester.idstringRequired

subscriptions.requester.namestringRequired

subscriptions.requester.typestringRequired

subscriptions.includedSourcesobject[]Required

Included sources, carrying the list of hi types.

subscriptions.includedSources.hiTypesstring[]Required

Types of health information document.

subscriptions.includedSources.purposeobjectRequired

subscriptions.includedSources.purpose.textstringRequired

One of Care ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requested

subscriptions.includedSources.purpose.codestringRequired

One of CAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQT

subscriptions.includedSources.purpose.refUristringRequired

The reference URL. Allows alpha numeric character and special characters like "^[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b(?:[-a-zA-Z0-9()@:%_\\+.~#?&//=]*)$"

subscriptions.includedSources.hipobjectRequired

Identifier and name of the health information provider.

subscriptions.includedSources.hip.idstringRequired

The service ID of the health information provider. Must be Alpha numeric and _ or - in middle

subscriptions.includedSources.hip.namestringRequired

The name of the health information provider. Allows alphanumeric characters and special characters like _\-@,. ":

subscriptions.includedSources.hip.typestring

The type of the health information provider. Allows alphanumeric characters and special characters like _\-@,. ":

subscriptions.includedSources.categoriesstring[]Required

subscriptions.includedSources.periodobjectRequired

The date range between when the subscription will be active

subscriptions.includedSources.period.fromstringRequired

UTC date time in ISO format

subscriptions.includedSources.period.tostringRequired

UTC date time in ISO format

subscriptions.includedSources.statusstring

The status of the subscription approval

autoApprovalsobject[]

autoApprovals.idnumber

autoApprovals.autoApprovalIdstring

autoApprovals.hiuIdstring

Identifier of the health information user that raised the request.

autoApprovals.patientIdstring

autoApprovals.isActiveboolean

autoApprovals.dateCreatedstring

autoApprovals.dateModifiedstring

autoApprovals.policyobject

autoApprovals.policy.isApplicableForAllHIPsbooleanRequired

autoApprovals.policy.hiuobjectRequired

autoApprovals.policy.hiu.idstringRequired

The service ID of the health information user. Must be Alpha numeric and _ or - in middle

autoApprovals.policy.hiu.namestring

The name of the health information user. Allows alphanumeric characters and special characters like _\-@,. ":

autoApprovals.policy.hiu.typestring

The type of the health information user. Allows alphanumeric characters and special characters like _\-@,. ":

autoApprovals.policy.includedSourcesobject[]Required

Included sources, carrying the list of hi types.

autoApprovals.policy.includedSources.hiTypesstring[]Required

Types of health information document.

autoApprovals.policy.includedSources.purposeobjectRequired

autoApprovals.policy.includedSources.hipobjectRequired

Identifier and name of the health information provider.

autoApprovals.policy.includedSources.categoriesstring[]Required

autoApprovals.policy.includedSources.periodobjectRequired

The date range between when the subscription will be active

autoApprovals.policy.includedSources.statusstring

The status of the subscription approval

autoApprovals.policy.excludedSourcesobject[]Required

Excluded sources, carrying the list of hi types.

autoApprovals.policy.excludedSources.hiTypesstring[]Required

Types of health information document.

autoApprovals.policy.excludedSources.purposeobjectRequired

autoApprovals.policy.excludedSources.hipobjectRequired

Identifier and name of the health information provider.

autoApprovals.policy.excludedSources.categoriesstring[]Required

autoApprovals.policy.excludedSources.periodobjectRequired

The date range between when the subscription will be active

autoApprovals.policy.excludedSources.statusstring

The status of the subscription approval

400

Bad Request

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1066 - Invalid JWT token. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

error.messagestringRequired

401

Unauthorized

Everything returns 401

codestring

900901 - Invalid Credentials. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

messagestring

descriptionstring

403

Forbidden

404

server cannot find the requested resource

500

Internal Server Error

timestampnumberRequired

pathstringRequired

statusintegerRequired

errorstringRequired

The error code and message, if any occurred.

requestIdstringRequired

503

Service Unavailable

codestringRequired

ABDM-1024 - Dependent service unavailable. May be returned either bare (ABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.

messagestringRequired

curl --request GET \
  --url https://dev.abdm.gov.in/api/hiecm/subscription-requests/v3/patients/lockers/{locker-id} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'X-CM-ID: sbx' \
  --header 'X-AUTH-TOKEN: <TOKEN>'

{
  "lockerId": "1234",
  "lockerName": "Locker 1",
  "active": true,
  "dateCreated": "2021-09-28T12:30:08.573Z",
  "subscriptions": [
    {
      "subscriptionId": "f29f0e59-8388-4698-9fe6-05db67aeac46",
      "purpose": {
        "text": "Care Management",
        "code": "CAREMGT",
        "refUri": "https://abc.def.in"
      },
      "status": "GRANTED",
      "dateCreated": "2021-09-28T12:30:08.573Z",
      "dateGranted": "2021-09-28T12:30:08.573Z",
      "patient": {
        "id": "<ABHA_ADDRESS>"
      },
      "requester": {
        "id": "<ABHA_ADDRESS>",
        "name": "ABDM_HIU",
        "type": "HIU"
      },
      "includedSources": [
        {
          "hiTypes": [
            "Prescription"
          ],
          "purpose": {
            "text": "Care Management",
            "code": "CAREMGT",
            "refUri": "https://abc.def.in"
          },
          "hip": {
            "id": "INDIA_HIP",
            "name": "INDIA HIP",
            "type": "HIP"
          },
          "categories": [
            "LINK"
          ],
          "period": {
            "from": "2024-05-09T10:34:00.389Z",
            "to": "2024-05-09T10:34:00.389Z"
          },
          "status": "SUCCESS"
        }
      ]
    }
  ],
  "autoApprovals": [
    {
      "id": 1234,
      "autoApprovalId": "e5ec415f-c098-40f6-a0db-faa162fc5295",
      "hiuId": "India_HIU",
      "patientId": "<ABHA_ADDRESS>",
      "isActive": false,
      "dateCreated": "2021-09-28T12:30:08.573Z",
      "dateModified": "2021-09-28T12:30:08.573Z",
      "policy": {
        "isApplicableForAllHIPs": true,
        "hiu": {
          "id": "INDIA_HIU",
          "name": "INDIA HIU",
          "type": "HIU"
        },
        "includedSources": [
          {
            "hiTypes": [],
            "categories": [],
            "status": "SUCCESS"
          }
        ],
        "excludedSources": [
          {
            "hiTypes": [],
            "categories": [],
            "status": "SUCCESS"
          }
        ]
      }
    }
  ]
}

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