Get the consent request details by REQUEST-ID
By invoking this API, users can obtain comprehensive information about a specific consent request, including its status, scope, and any associated conditions. This functionality is essential for ensuring that users have access to accurate and up-to-date consent information, supporting secure and compliant health information exchange. The API facilitates efficient management and verification of consent requests, enhancing the overall integrity of the consent management process. The access token from POST /api/hiecm/gateway/v3/sessions, sent with a The consent 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 The user token the PHR service issued when the patient logged in. OK One of One of The reference URL.Allows alpha numeric and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" The abha address of the patient 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}$" 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}$" List of care contexts linked at the HIP end for the identified patient. A patient identifier with which patient is registered in the facility/hospital An identifier of patient's care context created in HIP. A care context is a group of patient's health data (Not the actual health data) The name of the requester The type of the identification. Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" The identification value. Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$" One of One of Should be UTC date time in ISO format Should be UTC date time in ISO format The date at which the consent expire. Should be UTC date time in ISO format One of The frequency unit value. Should be be a integer Should be be a integer Bad Request The error code and message, if any occurred. ABDM-1039 - Invalid Consent request id. May be returned either bare ( 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.Path parameters
consentRequestIdstringRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredResponses
200requestIdstringpurposeobjectpurpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requestedpurpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTpurpose.refUristringRequiredpatientobjectpatient.idstringRequiredhipobjecthip.idstringRequiredhip.namestringRequiredhip.typestringhiuobjecthiu.idstringRequiredhiu.namestringRequiredhiu.typestringcareContextsobject[]careContexts.patientReferencestringRequiredcareContexts.careContextReferencestringRequiredrequesterobjectrequester.namestringRequiredrequester.identifierobjectRequiredrequester.identifier.valuestringRequiredrequester.identifier.typestringRequiredrequester.identifier.systemstringRequiredstatusstringREQUESTEDEXPIREDDENIEDGRANTEDREVOKEDcreatedAtstringlastUpdatedstringhiTypestring[]permissionobjectpermission.accessModestringRequiredVIEWSTORESTREAMQUERYpermission.dateRangeobjectRequiredpermission.dateRange.fromstringRequiredpermission.dateRange.tostringRequiredpermission.dataEraseAtstringRequiredpermission.frequencyobjectRequiredpermission.frequency.unitstringRequiredHOURDAYWEEKMONTHYEARpermission.frequency.valuenumberRequiredpermission.frequency.repeatsnumberRequired400errorobjecterror.codestringRequiredABDM-1039) or with a trailing ": " separator (ABDM-1039: ); match on the code itself and tolerate the separator.error.messagestringRequired401codestringmessagestringdescriptionstring404errorobjecterror.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