Receive the consent decision
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.
Notification of consents to health information providers consent request granted, consent revoked, consent expired. Only the GRANTED, REVOKED and EXPIRED status notifications will be sent to HIP. If consent is granted, status=GRANTED, then consentDetail contains the consent artefact details and signature is available. If consent is revoked, then status=REVOKED, and consentId specifes which consent artefact is revoked. If the consent has expired, then status=EXPIRED, and consentId specifies which consent artefact has expired. Note, this is also responsibility of the HIP to keep track of consent expiry. Any data request on expired consent artefact must not be done. 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 provider to which the request was intended 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}$"; 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}$"; Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" 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)$ 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 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 and special characters like "^[a-zA-Z0-9_\\-@,().\"/:| ]{0,255}$" 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-Z0-9_\\-@,. \":/]{0,255}$ 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}$ 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.Allows alpha numeric character and special characters like "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$" 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-HIP-IDstringRequiredBody
notificationobjectRequirednotification.statusstringRequiredGRANTEDEXPIREDDENIEDREQUESTEDREVOKEDnotification.consentIdstringRequirednotification.consentDetailobjectRequirednotification.consentDetail.schemaVersionstringRequirednotification.consentDetail.consentIdstringRequirednotification.consentDetail.createdAtstringRequirednotification.consentDetail.patientobjectRequirednotification.consentDetail.patient.idstringRequirednotification.consentDetail.careContextsobject[]Requirednotification.consentDetail.careContexts.patientReferencestringRequirednotification.consentDetail.careContexts.careContextReferencestringRequirednotification.consentDetail.purposeobjectRequirednotification.consentDetail.purpose.textstringRequiredCare ManagementBreak the GlassPublic HealthHealthcare PaymentDisease Specific Healthcare ResearchSelf Requestednotification.consentDetail.purpose.codestringRequiredCAREMGTBTGPUBHLTHHPAYMTDSRCHPATRQTnotification.consentDetail.purpose.refUristringRequirednotification.consentDetail.hipobjectRequirednotification.consentDetail.hip.idstringRequirednotification.consentDetail.hip.namestringRequirednotification.consentDetail.hip.typestringnotification.consentDetail.hiuobjectRequirednotification.consentDetail.hiu.idstringRequirednotification.consentDetail.hiu.namestringRequirednotification.consentDetail.hiu.typestringnotification.consentDetail.consentManagerobjectRequirednotification.consentDetail.consentManager.idstringRequirednotification.consentDetail.requesterobjectRequirednotification.consentDetail.requester.namestringRequirednotification.consentDetail.requester.identifierobjectRequirednotification.consentDetail.hiTypesstring[]Requirednotification.consentDetail.permissionobjectRequirednotification.consentDetail.permission.accessModestringRequiredVIEWSTORESTREAMQUERYnotification.consentDetail.permission.dateRangeobjectRequirednotification.consentDetail.permission.dataEraseAtstringRequirednotification.consentDetail.permission.frequencyobjectRequirednotification.signaturestringRequirednotification.grantAcknowledgementbooleanRequiredResponses
200400