Fetch all the consent artefact details of a patient
By invoking this API, users can retrieve comprehensive information about all consent artefacts associated with the patient’s health information. This functionality is essential for maintaining transparency and ensuring that users have access to complete and up-to-date consent artefact information. The API supports efficient tracking and management of consent artefacts, facilitating secure and compliant health information exchange within the healthcare ecosystem. The access token from POST /api/hiecm/gateway/v3/sessions, sent with a The number of items to be returned at a time The number of items to be skipped before starting to collect data Status of the consent Unique UUID for tracking 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 List of consent artefact ids that were created. One of Allows alpha numeric character and special characters like "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$"; One of One of The reference URL. Should be a valid URL 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 _\-@,():/ The type of the health information provider. Allows alpha numeric and special characters like _\-@,. ":/ 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 _\-@,():/ The type of the health information user. Allows alpha numeric and special characters like _\-@,. ":/ 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 Types of health information document. One of The date at which the consent expire. Should be UTC date time in ISO format Bad Request. The request could not be processed because it was malformed or failed validation - a missing mandatory field, a value in the wrong format, or a header that did not match the body. The error code and message, if any occurred. ABDM-1006 - Bad Request, invalid request Body. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator. Short description of the failure. 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.Query parameters
limitintegerRequiredoffsetintegerstatusstringHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-CM-IDstringRequiredX-AUTH-TOKENstringRequiredResponses
200sizeintegerlimitintegeroffsetintegerconsentArtefactsobject[]consentArtefacts.statusstringGRANTEDEXPIREDREVOKEDconsentArtefacts.consentDetailobjectconsentArtefacts.consentDetail.consentIdstringconsentArtefacts.consentDetail.purposeobjectRequiredconsentArtefacts.consentDetail.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf RequestedconsentArtefacts.consentDetail.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTconsentArtefacts.consentDetail.purpose.refUristringRequiredconsentArtefacts.consentDetail.patientobjectRequiredconsentArtefacts.consentDetail.patient.idstringRequiredconsentArtefacts.consentDetail.hipobjectconsentArtefacts.consentDetail.hip.idstringRequiredconsentArtefacts.consentDetail.hip.namestringRequiredconsentArtefacts.consentDetail.hip.typestringconsentArtefacts.consentDetail.hiuobjectRequiredconsentArtefacts.consentDetail.hiu.idstringRequiredconsentArtefacts.consentDetail.hiu.namestringRequiredconsentArtefacts.consentDetail.hiu.typestringconsentArtefacts.consentDetail.careContextsobject[]consentArtefacts.consentDetail.careContexts.patientReferencestringRequiredconsentArtefacts.consentDetail.careContexts.careContextReferencestringRequiredconsentArtefacts.consentDetail.requesterobjectRequiredconsentArtefacts.consentDetail.requester.namestringRequiredconsentArtefacts.consentDetail.requester.identifierobjectRequiredconsentArtefacts.consentDetail.createdAtstringconsentArtefacts.consentDetail.lastUpdatedstringconsentArtefacts.consentDetail.schemaVersionstringconsentArtefacts.consentDetail.consentManagerobjectconsentArtefacts.consentDetail.consentManager.idstringconsentArtefacts.consentDetail.hiTypesstring[]RequiredconsentArtefacts.consentDetail.permissionobjectRequiredconsentArtefacts.consentDetail.permission.accessModestringRequiredVIEWSTORESTREAMQUERYconsentArtefacts.consentDetail.permission.dateRangeobjectRequiredconsentArtefacts.consentDetail.permission.dataEraseAtstringRequiredconsentArtefacts.consentDetail.permission.frequencyobjectRequiredconsentArtefacts.signaturestring400errorobjecterror.codestringRequirederror.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