Frequently Asked Questions (FAQs) - NHA-ABDM/ABDM-wrapper GitHub Wiki

1. What is the unique identifier to be passed in the care context reference ID? This could be the unique reference ID in your internal system, preferably the appointment ID, record ID or so on 2. How do we set the callback URL? The callback URL has to be set in the abdm bridge API https://dev.abdm.gov.in/devservice/v1/bridges. While testing on local, you could set up a static URL on Ngrok and test out the flows. Later you need to replace it with your servers URL 3. If I am setting up my own callback URL, how does the wrapper work? You will have to write a script in your system, which routes the callbacks from the firewall into the local host where the docker is running. The wrapper will then take care of making the API calls to ABDM system and handling the asnychronous calls. 4. Do we need to implement the status APIs? Yes, the status APIs needs to be implemented. This will give you the status of record linking and also help you fetch the records in M3 workflows 5. Can a PHR App use this wrapper? Yes a PHR app can also use this service. They have to implement the M1 flows: ABHA creation and login flows on their own. The HIU functionality can be implemented using the wrapper. 6. What is the use of mock gateway and how can I test it? The mock gateway can be run using JDK on 8090 port. This will respond to the callback URL, just like ABDM gateway would do. This is built to simplify the integration process. Record fetching will still have to be shown with the ABDM gateway. 7. Can this work on both cloud based systems or on-premise deployments? Yes, it can work on all kinds of systems 8. Will a wrapper be built for M1 workflows? No, at this point we only support HIP and HIU workflows (M2 and M3). You can find documentation however on https://sandbox.abdm.gov.in/sandbox/v3/. We recommend using the V3 APIs to streamline development 9. Do we have to upgrade to new APIs everytime ABDM releases a new version? No, the wrapper will take care of it. You will have to just pull the latest code and run it on your system 10. Where can I find the most updated version of docker? Yes, we will update and maintain various versions. 11. Who handles the storage? Is my data secure? The docker is deployed locally on your system/ server. So, the data is secure and is stored on your system 12. I am facing issues with the docker installation. Is there any alternate method? You can install the components individually. You can read about them here. https://github.com/NHA-ABDM/ABDM-wrapper/wiki/ABDM-Wrapper#3-system-requirements-and-installations 13. Can I implement them for a multi tenant model? Yes, you can. As long as the data in your system, has a unique reference ID for the patient and care context, it should be fine. 14. Is there a video link to how this works? https://drive.google.com/file/d/1Dp1WClDfJzf6vfU_D6SmC1XnNiJwlNwQ/view?usp=drive_link