> For the complete documentation index, see [llms.txt](https://docs.coronasafe.network/abdm-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coronasafe.network/abdm-documentation/implementers-guide/abdm-sandbox-integration-and-exit-process.md).
# ABDM Sandbox Integration and Exit process
The Ayushman Bharat Digital Mission has developed building blocks and APIs to offer a seamless digital healthcare experience for all stakeholders – health facilities, patients and healthcare workers. The digital infrastructure developed is now accessible to health facilities and health tech players for integration.
This section offers step-by-step guidance on the following for interested stakeholders:
* Guidelines to integrate ABDM-powered services (ABHA Number capture & verification, HIP services, HIU application) in the testing environment called Sandbox
* More details are provided in the given document
* Process to exit sandbox and deploy application in facilities located across all States and UTs.
Kindly note that the functional requirements and process steps are intended for the ABDM integrations across all States and UTs.
#### A. End-state Patient experience
Integrations with ABDM infrastructure can be leveraged to achieve the following patient experience:
We recommend developing this experience in three milestones, each building over the previous:
* **Milestone 1:** ABHA Number creation and capture & verification for seamless patient registration.[ excel](https://sandbox.abdm.gov.in/documents/ABHA_APIs.xlsx)
* **Milestone 2:** Building Health Information Provider (HIP) services to share digital records via Personal Health Records (ABHA) app.[ excel](https://sandbox.abdm.gov.in/documents/Milestone_M2_APIs.xlsx)
* **Milestone 3:** Developing Health Information User (HIU) services to provide view of patient’s medical history to authorized healthcare workers with complete consent
Guidance on milestone-wise functional requirements has been shared in Section C. Sandbox exit requirements & process has been detailed in Section D.
#### B. Getting started – Sandbox registration
The first step to integrate with ABDM ecosystem is to [register](https://sandbox.abdm.gov.in/applications/Home/signup_form) on Sandbox – kindly fill out a short form providing details about your organization and your motivation to join.
Post internal approval, you will receive credentials to access ABDM APIs. Kindly expect a revert by the Sandbox support team within a timeline of 3-4 days post application.
#### C. Milestone-wise functional requirements
Before you begin with integrations in Sandbox environment, kindly ensure you have the client bridge ID and secret to access ABDM APIs. Please refer to Section B to understand the registration process.
Also, please refer to the functional test cases in Section D (Step 1) to understand mandatory/optional workflow features.
For any technical concerns regarding integration, kindly post query on the [devforum](https://devforum.ndhm.gov.in/).
**C.1 ABHA Number creation and capture & verification**
The steps involved and recommended workflow are as follows:
1. Register partnering facility (HIP) in ABDM Sandbox Health Facility Registry
2. Collaborate with HIP staff to provide patients with information regarding ABHA Number and ways to create one on their own
* Patients with a smartphone can download ABDM Health Records app/any other ABHA Mobile Application to register their ABHA Number. Suggested collateral you can install in facilities to promote ABHA Number benefits can be found in link ([English version](https://sandbox.abdm.gov.in/documents/Abha_Number_poster_English_open.pptx) and [Hindi version](https://sandbox.abdm.gov.in/documents/Abha_Number_poster_Hindi_open.pptx))
* Those without a mobile phone can avail assistance at facility registration desk to create an ID using Aadhaar biometric Kindly leverage the existing ABDM [Assisted ABHA Number](https://healthid.ndhm.gov.in/facility) creation portal and consider distributing registration cards with ABHA Number QR code for future capture
3. Develop workflows to capture and verify ABHA Number during registration, if provided by the patient.
**Note:** OTP authentication will be required only if ABHA Number is shared verbally by patient. Other modes like ABHA Number QR code sharing, HIP QR code scanning will not need OTP step.
* Patients with a smartphone can share details via ABHA Number QR code/scan HIP QR code with their ABHA Mobile Application. Those without a smartphone can use their ABHA Number QR code- enabled registration card to share information. This method does not require OTP authentication.
* Incorporate flows to link ABHA Number with patient information for two use-cases:
* For new patients, capture ABHA Number details to obtain basic demographic details with consent.\
Kindly note fields like name, gender & year of birth should be frozen for edits in the patient registration page. We recommend providing both Mobile & Aadhaar OTP modes of ABHA Number authentication as part of the workflow
* For existing patients, provide option to link ABHA Number with the patient registration ID – use fuzzy match ABDM demographic verification APIs for the mapping. Ensure demographic information (name, gender, year of birth) obtained from the ABHA Number system serves as the master for patient information in the HMIS/LIMS
* Ensure you save the linking token at the time of ABHA Number capture and verification – use [Gateway API](https://sandbox.ndhm.gov.in/swagger/ndhm-hip.yaml) to receive the right linking token.
Please refer to the [ABHA Number service section](https://sandbox.abdm.gov.in/docs/healthid) and [Sandbox Webinar 1](https://www.youtube.com/watch?v=5FjnZmhYFkA\&feature=youtu.be) for additional details.
**C.2 Share consented digital health record via ABHA Mobile Application**
The recommended features/steps proposed as part of this milestone are as follows:
1. Create a care context associated with the patient post consultation/investigation
* Ensure you can support sharing of all five major types of reports: Diagnostic reports, discharge summaries, OPD notes, Prescription report and Immunization Record
2. Integrate HIP services to include the following features-
* Ability to respond to discovery requests from Consent Manager against ABHA Number
* Support patient-initiated linking of old medical reports by linking with Consent Manager
* Acknowledge Consent Manager requests for health data and save the consent artifact
* Facilitate flow of medical data against consent artifact as per specified format (FHIR, encrypted) – check [page](https://sandbox.abdm.gov.in/docs/data_preparation) for additional details on data preparation
3. When the record is ready, share notification with patient to help access reports
* Ensure SMS goes to all patients who provide a mobile number – SMS to contain a deep link with patient ABHA Number (if available), HIP ID and with a trigger to ABHA Mobile Application. API documentation is available[ here](https://sandbox.abdm.gov.in/docs/build_hip) in Section **6. Send SMS to Patient**.
Kindly refer to the [Building HIP section](https://sandbox.abdm.gov.in/docs/build_hip), [Sandbox Webinar 2](https://www.youtube.com/watch?v=72SRn0wevfY\&feature=youtu.be) and [Webinar 3](https://www.youtube.com/watch?v=l8TiGXX8E34\&feature=youtu.be) for additional details.
**C.3 Share patient’s longitudinal history with healthcare workers with consent**
The milestone includes incorporating the following features:
1. Create a consent request as an HIU and post it to patient's ABHA Mobile Application - The HIU should honor the consent artifact (duration for which consent is active)
2. Integrate services to receive medical data from facilities that have care contexts linked to the patient's ABHA Number
3. Parse & organize medical data to share with consulting doctor/technician on their respective systems
The [Building HIU services](https://sandbox.abdm.gov.in/docs/build_hiu) section of the Sandbox documentation and [Webinar 4](https://www.youtube.com/watch?v=oZ9Z2JtO21Q\&feature=youtu.be) can be referred for further information.
#### D. Sandbox exit process
Post integrations, the following 4-step process will apply for any integrator to exit from the Sandbox. Kindly fill the form in your sandbox user account to initiate exit.
**Step 1**: Functional & non-functional Testing of the application by an internal NHA team Draft test cases for functional evaluation can be found in [link](https://sandbox.abdm.gov.in/documents/M1_M2_test_cases_API_sequence_version3_05Feb2022.xlsx)\
**Note :** From 5th August 2022 onwards, the functional & non-functional testing of the application will be conducted by NHA empaneled agencies which are as below:
1. M/s FIME India Pvt. Ltd.
2. M/s Suma Soft Pvt. Ltd.
3. M/s Tata Communications
The interested integrators are requested to connect with any one of the above agencies for functional and non-functional testing/certification on chargeable basis. The integrators (new and the existing ones) who are not able to get themselves certified by the cut off date will be required to get the testing conducted by any of these agencies only. Please [click here](https://sandbox.abdm.gov.in/docs/testing_agencies_contact) for contact details of the above agencies.
**Step 2**: Security testing of the web/mobile application from any STQC or CERT-IN empaneled agency. Applicants are requested to engage with relevant agencies and submit the “Safe-to-Host” certificate to NHA
* Suggestive pointers on infrastructural requirements for security testing clearance can be found in [document](https://sandbox.abdm.gov.in/documents/NDHM_Secure_Application_Development-Reference_Document.pdf).
* To view List of CERT-IN empaneled agencies for Safe-to-Host certification please follow below steps
1. Please go to the [link](https://www.cert-in.org.in/).
2. Navigate to Cyber Security Assurance tab and select Empanelment by CERT-in from dropdown.
STQC may also reach out to perform validation testing on a few sample applications.
**Step 3**: A final round of approval for application go-live will be sought from the internal team at NHA. Applicants will be required to share the following before the committee:
* Functional testing report for integrations completed
* Safe-to-Host certificate for the application
* Summary details of the application duly filled in [excel](https://sandbox.abdm.gov.in/documents/Details_required_for_Production_Keys_template.xlsx)
**Step 4**: Once approved, access will be shared for integration in the production environment.
Kindly ensure the partnering HIP is registered on [Health Facility Registry](https://facility.ndhm.gov.in/) in order to interface with the ABDM infrastructure.
Detailed walkthrough on facility registration steps can be found in [video link](https://www.youtube.com/watch?v=lqe-dlQcLIo\&feature=youtu.be). Once registered, the HIP will be required to update production access bridge ID in their Health Facility Registry profile – please find all steps demonstrated in [document](https://sandbox.abdm.gov.in/documents/Steps_for_linkage_of_a_Verified_Health_Facility.pdf)
The application is now expected to be prepared for go-live in respective healthcare facilities.
Please ensure facility staff is well-versed with the new software and is briefed on ABDM building blocks well in advance to assist patients.
