Approve subscription request
Be invoked by the patient or user through the Personal Health Record (PHR) application to approve a subscription request.
By using this API, individuals can grant permission for the requested subscription, ensuring that they receive the desired health information services or updates. This functionality is essential for enabling users to manage their health data subscriptions effectively, ensuring they have control over the information they receive. The API supports secure and efficient approval of subscription requests, enhancing the overall user experience within the healthcare ecosystem. The access token from POST /api/hiecm/gateway/v3/sessions, sent with a The subscription request id 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 A boolean value to denote if the policy is applicable to all the HIPs or only the specified HIP Included sources, carrying the list of hi types. Types of health information document. 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()@:%_\\+.~#?&//=]*)$" Identifier and name of the health information provider. 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}$" The date range between when the subscription will be active 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$" Excluded sources, carrying the list of hi types. Types of health information document. 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()@:%_\\+.~#?&//=]*)$" Identifier and name of the health information provider. 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}$" The date range between when the subscription will be active 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$" Bad Request The error code and message, if any occurred. ABDM-9999 - Unknown exception. May be returned either bare ( 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.Path parameters
subscriptionRequestIdstringRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredBody
isApplicableForAllHIPsbooleanRequiredincludedSourcesobject[]RequiredincludedSources.hiTypesstring[]RequiredincludedSources.purposeobjectRequiredincludedSources.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedincludedSources.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTincludedSources.purpose.refUristringRequiredincludedSources.hipobjectincludedSources.hip.idstringRequiredincludedSources.hip.namestringRequiredincludedSources.hip.typestringincludedSources.categoriesstring[]RequiredincludedSources.periodobjectRequiredincludedSources.period.fromstringRequiredincludedSources.period.tostringRequiredexcludedSourcesobject[]excludedSources.hiTypesstring[]RequiredexcludedSources.purposeobjectRequiredexcludedSources.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedexcludedSources.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTexcludedSources.purpose.refUristringRequiredexcludedSources.hipobjectRequiredexcludedSources.hip.idstringRequiredexcludedSources.hip.namestringRequiredexcludedSources.hip.typestringexcludedSources.categoriesstring[]RequiredexcludedSources.periodobjectRequiredexcludedSources.period.fromstringRequiredexcludedSources.period.tostringRequiredResponses
400errorobjecterror.codestringRequiredABDM-9999) or with a trailing ": " separator (ABDM-9999: ); match on the code itself and tolerate the separator.error.messagestringRequired401codestringmessagestringdescriptionstring500timestampnumberRequiredpathstringRequiredstatusintegerRequirederrorstringRequiredrequestIdstringRequired503codestringRequiredABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.messagestringRequired