Notify subscription requests 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 serves as a callback for when a subscription request is approved or denied. By invoking this API, the Health Information User (HIU) is notified about the outcome of their subscription request, whether it has been approved or denied. This functionality is essential for maintaining transparency and ensuring that the HIU is informed about the status of their subscription requests. 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 subscriptionRequestId .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]$ One of The abha address of the patient. Must start with Alphanumeric . and _ in the middle and must be ending with @abdm or @sbx.Allows alpha numeric character and special characters like ^[a-zA-Z0-9][a-zA-Z0-9_.\\-!]+[a-zA-Z0-9]@(abdm|sbx)$ 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}$ Types of health information document. Identifier and name of the health information provider. The date range between when the subscription will be active The status of the subscription approval. Allows alpha numeric character and special characters like ^[a-zA-Z0-9_\-@,. ":]{0,255}$ OK Internal Server Error -> It is just one example, for every api the path will be changed.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIU-IDstringRequiredBody
notificationobjectRequirednotification.subscriptionRequestIdstringRequirednotification.reasonstringRequirednotification.statusstringRequiredGRANTEDDENIEDnotification.subscriptionobjectRequirednotification.subscription.idstringnotification.subscription.patientobjectnotification.subscription.patient.idstringRequirednotification.subscription.hiuobjectnotification.subscription.hiu.idstringRequirednotification.subscription.hiu.namestringnotification.subscription.hiu.typestringnotification.subscription.sourcesobject[]notification.subscription.sources.hiTypesstring[]Requirednotification.subscription.sources.purposeobjectRequirednotification.subscription.sources.hipobjectRequirednotification.subscription.sources.categoriesstring[]Requirednotification.subscription.sources.periodobjectRequirednotification.subscription.sources.statusstringResponses
200500
Where this fits
hiecm-subscription.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.