Receive the provide fetched consent artefact details to HIU
Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.
This API endpoint is part of the Ayushman Bharat Digital Mission (ABDM) Health Information Exchange - Consent Management (HIE-CM) system. It is called by the Consent Management (CM) system to fetch a consent artefact. By invoking this API, the CM system retrieves the detailed information of a specific consent artefact, ensuring that the consent data is accurately and securely accessed. This functionality is essential for maintaining the integrity and synchronization of consent records, supporting secure and compliant health information exchange within the healthcare ecosystem. 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 Identifier of the health information user to which the request was intended One of 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 _\-@,():/ 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 _\-@,. ":/ Types of health information document. The abha address of the patient. allows alpha numeric character and special characters like ^[a-zA-Z0-9][a-zA-Z0-9_.]+[a-zA-Z0-9]@(abdm|sbx)$ 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}$ The name of the requester One of The date at which the consent expire. Should be 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 The frequency unit value. Should be be a integer. Allows numeric character like ^[a-zA-Z0-9_\\-@,. \":/]{0,255}$ Should be be a integer.Allows numeric character like ^[a-zA-Z0-9_\\-@,. \":/]{0,255}$ lastUpdated of the consent. Should be 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$ 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. Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\-@,. "':|()/]{0,255}$ 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). Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\-@,. "':|()/]{0,255}$ The error code and message, if any occurred. The requestId that was passed.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} OK 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.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIU-IDstringRequiredBody
consentobjectRequiredconsent.statusstringRequiredGRANTEDDENIEDEXPIREDREVOKEDconsent.consentDetailobjectRequiredconsent.consentDetail.consentIdstringRequiredconsent.consentDetail.hipobjectconsent.consentDetail.hip.idstringRequiredconsent.consentDetail.hip.namestringRequiredconsent.consentDetail.hip.typestringconsent.consentDetail.hiuobjectRequiredconsent.consentDetail.hiu.idstringRequiredconsent.consentDetail.hiu.namestringRequiredconsent.consentDetail.hiu.typestringconsent.consentDetail.hiTypesstring[]Requiredconsent.consentDetail.patientobjectRequiredconsent.consentDetail.patient.idstringRequiredconsent.consentDetail.purposeobjectRequiredconsent.consentDetail.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requestedconsent.consentDetail.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTconsent.consentDetail.purpose.refUristringRequiredconsent.consentDetail.createdAtstringRequiredconsent.consentDetail.requesterobjectRequiredconsent.consentDetail.requester.namestringRequiredconsent.consentDetail.requester.identifierobjectRequiredconsent.consentDetail.permissionobjectRequiredconsent.consentDetail.permission.accessModestringRequiredVIEWSTORESTREAMQUERYconsent.consentDetail.permission.dateRangeobjectRequiredconsent.consentDetail.dataEraseAtstringRequiredconsent.consentDetail.frequencyobjectRequiredconsent.consentDetail.frequency.unitstringRequiredHOURDAYWEEKMONTHYEARconsent.consentDetail.frequency.valuenumberRequiredconsent.consentDetail.frequency.repeatsnumberRequiredconsent.consentDetail.lastUpdatedstringRequiredconsent.consentDetail.careContextsobject[]Requiredconsent.consentDetail.careContexts.patientReferencestringRequiredconsent.consentDetail.careContexts.careContextReferencestringRequiredconsent.consentDetail.schemaVersionstringRequiredconsent.consentDetail.consentManagerobjectRequiredconsent.consentDetail.consentManager.idstringRequiredconsent.signaturestringRequirederrorobjectRequiredresponseobjectRequiredresponse.requestIdstringRequiredrespstringResponses
200400
Where this fits
hiecm-m3.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.