Setup an auto-approval policy for given HIU
Set up an auto-approval policy for a specified Health Information User (HIU).
By invoking this API, users can configure automatic approval of consent requests from the designated HIU, streamlining the process of granting access to health data. This functionality is essential for enhancing efficiency and reducing manual intervention in the consent management process. The API supports secure and compliant health information exchange, ensuring that auto-approval policies are implemented in accordance with user preferences and regulatory requirements. The access token from POST /api/hiecm/gateway/v3/sessions, sent with a 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 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 alpha numeric and special characters like "^[a-zA-Z]+[A-Za-z0-9_\\-@,().\\s\\xa0:/]+" The type of the health information user. Allows alpha numeric and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" Included sources, carrying the list of hi types. Types of health information document. One of One of The reference URL. Should be a valid URL. Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" 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 alpha numeric and special characters like "^[a-zA-Z]+[A-Za-z0-9_\\-@,().\\s\\xa0:/]+" The type of the health information provider. Allows alpha numeric and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" Should be UTC date time in ISO format.Allows alpha numeric and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" Should be UTC date time in ISO format.Allows alpha numeric 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. Should be a valid URL. Allows alpha numeric and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" 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 alpha numeric and special characters like "^[a-zA-Z]+[A-Za-z0-9_\\-@,().\\s\\xa0:/]+" The type of the health information provider. Allows alpha numeric and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" Should be UTC date time in ISO format.Allows alpha numeric and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" Should be UTC date time in ISO format. Allows alpha numeric and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" Unauthorized 900901 - Unauthorized. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator. Not Found The error code and message, if any occurred. ABDM-1001 - No data found. May be returned either bare ( Internal Server Error 900900 - Unclassified Authentication Failure. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator. Service Unavailable ABDM-1024 - Dependent service unavailable. May be returned either bare (Authorizations
Authorizationbearer tokenRequiredBearer prefix.Headers
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredBody
isApplicableForAllHIPsbooleanRequiredhiuobjectRequiredhiu.idstringRequiredhiu.namestringRequiredhiu.typestringRequiredincludedSourcesobject[]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.typestringRequiredincludedSources.periodobjectRequiredincludedSources.period.fromstringRequiredincludedSources.period.tostringRequiredexcludedSourcesobject[]excludedSources.hiTypesstring[]RequiredexcludedSources.purposeobjectexcludedSources.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedexcludedSources.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTexcludedSources.purpose.refUristringRequiredexcludedSources.hipobjectexcludedSources.hip.idstringRequiredexcludedSources.hip.namestringRequiredexcludedSources.hip.typestringRequiredexcludedSources.periodobjectRequiredexcludedSources.period.fromstringRequiredexcludedSources.period.tostringRequiredResponses
401codestringmessagestringdescriptionstring404errorobjecterror.codestringRequiredABDM-1001) or with a trailing ": " separator (ABDM-1001: ); match on the code itself and tolerate the separator.error.messagestringRequired500codestringmessagestringdescriptionstring503codestringRequiredABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.messagestringRequired