Fetch his/her subscription requests details
Be invoked by the patient or user through the Personal Health Record (PHR) application to fetch details of their subscription requests.
By using this API, patients can retrieve comprehensive information about all their subscription requests, including the status and specifics of each request. This functionality is essential for maintaining transparency and enabling patients to manage their subscriptions effectively. The API supports secure and efficient access to subscription data, enhancing the overall user experience within the healthcare ecosystem. The access token from POST /api/hiecm/gateway/v3/sessions, sent with a How many items to return at one time How many items out of line Query string parameter restricts the data returned from your request Unique UUID for track the end to end request transaction 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 Suffix of the consent manager to which the request was intended JWT Authentication token which was issued by ABDM after successful validation of username and password OK One of One of 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()@:%_\\+.~#?&//=]*)$" The abha address of the patient. Must start with Alphanumeric . and _ in the middle and must be ending with @abdm or @sbx. Allows alpha numeric character and special characters like ^[a-zA-Z0-9][a-zA-Z0-9_.\\-!]+[a-zA-Z0-9]@(abdm|sbx)$ The service ID of the health information user. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ The name of the health information user. Allows alphanumeric characters and special characters like"^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The type of the health information user. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The service ID of the health information provider. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ The name of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" The type of the health information provider. Allows alphanumeric characters and special characters like "^[a-zA-Z0-9_\\-@,. \":]{0,255}$" UTC date time in ISO format.Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" UTC date time in ISO format.Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" One of One of Bad Request The error code and message, if any occurred. ABDM-1066 - Invalid JWT token. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator. Unauthorized 900901 - Invalid Credentials. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator. Internal Server Error The error code and message, if any occurred. Service Unavailable ABDM-1024 - Dependent service unavailable. May be returned either bare (Authorizations
Authorizationbearer tokenRequiredBearer prefix.Query parameters
limitintegerRequiredoffsetintegerRequiredstatusstringRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredResponses
200sizeintegerRequiredlimitintegerRequiredoffsetintegerRequiredrequestsobject[]Requiredrequests.subscriptionIdstringrequests.requestIdstringRequiredrequests.createdAtstringrequests.lastUpdatedstringrequests.purposeobjectrequests.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requestedrequests.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTrequests.purpose.refUristringRequiredrequests.patientobjectrequests.patient.idstringRequiredrequests.hiuobjectrequests.hiu.idstringRequiredrequests.hiu.namestringrequests.hiu.typestringrequests.hipsobject[]requests.hips.idstringRequiredrequests.hips.namestringrequests.hips.typestringrequests.categoriesstring[]requests.periodobjectrequests.period.fromstringRequiredrequests.period.tostringRequiredrequests.statusstringREQUESTEDGRANTEDDENIEDEXPIREDREVOKEDrequests.requestTypestringHEALTH_LOCKERHIUHIP400errorobjecterror.codestringRequirederror.messagestringRequired401codestringmessagestringdescriptionstring500timestampnumberRequiredpathstringRequiredstatusintegerRequirederrorstringRequiredrequestIdstringRequired503codestringRequiredABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.messagestringRequired