Support Deep Links

Functionality Overview

Any mobile application that can display a user’s personal health record (ABHA) under the Ayushman Bharat Digital Mission (ABDM) needs to adhere to the deep linking specification outlined in this document.

User Flow:

• Patient visits a health facility and registers by providing Name, DateOfBirth, Gender and Mobile. Patient does not share any ABHA Address with the facility.
• If the Health Facility is participating in ABDM, then it will notify ABDM when there is a new health record for this patient. Only the mobile number and the ID of the facility is notified. Facilities are identified by the facility’s HIPCODE. This can be obtained by registering the facility using the Health Facility Registry and linking the facility to a ABDM approved Health Repository Provider Software.
• ABDM will send an SMS to the user with a deep link.
• The content of the message will be:

• Clicking on the link will show the list of all ABHA Mobile Applications that have cleared functional and security testing in the ABDM sandbox and have been production approved.

Note: The list of apps are presented in a random order each time the link is opened. The list of apps displayed is specific to the OS – Android or IOS

• Selecting an app will launch the app if already installed on the device or take the user to the play store (android) / app store (ios) to download the app. The deep link passed to the app in both scenarios contains the HIPCODE.
• The ABHA Mobile Application will help new users to register and create a ABHA Address using their name, date of birth, gender and mobile.
• The ABHA Mobile Application must recognize that the invocation was via a Deep Link. It must initiate a Discovery request to the HIPCODE that was part of the deep link. The Discovery API is implemented by ABHA Mobile Applications to find health records at a health facility. It is important for the ABHA Mobile Application to guide the user to provide the same Name, DoB, Gender and Mobile number that was provided to the Health Facility. If there is any difference in this information, the record cannot be retrieved correctly.
• ABDM will forward the Discovery request from the ABHA Mobile Application to the participating Health Facility. The Discovery request consists of the ABHA Address (chosen by the user), Name, date of birth, Gender and Mobile Number. The Health facility will search for any health records for this combination. If it finds a record it will respond to the ABHA Mobile Application with the available records listed in the form of care contexts.
• The ABHA Mobile Application should be able to display this to the user, link the care context to the ABHA Address, collect the appropriate consent from the user, fetch the health record(s) from the facility and display it to the user.

Process to enable Deep Link support to your ABHA Mobile Application

The ABHA Mobile Application must submit the following information to ABDM as part of Sandbox exit. Send an email to abdm.sandbox@nha.gov.in with the following details (eg here is AarogyaSetu)

• Name of the App: AarogyaSetu
• Play Store Link
• App Store Link
• Android Intent URI: uhi://discover?hip=‘HIPCODE’
• iOS Intent URI: arogya://discover?hip=‘HIPCODE’
• Logo for your App: Share file as an attachment

Please note that for this version of the deep linking release there is some flexibility provided in the intent URI and each ABHA Mobile Application can define its format. It is mandatory for all intent URIs to accept the HIPCODE. Here’s a tip for implementors:

1. For Android implementors
2. For iOS implementors

Demonstrating your Deep Link support during Sandbox Exit

Get the team to configure your ABHA Mobile Application correctly on the sandbox implementation site at phrsbx.adbm.gov.in. If you are providing your application as an APK for sideloading note that only the “already installed” test case can be verified.

The EMRSBX application available at https://emrsbx.abdm.gov.in/ has been updated to support the deep linking flow.

• Login to EMRSBX.
• Register a new patient without providing a ABHA Address - Just use Name, DateOfBirth, Gender and a Mobile for the registration.
• Add a new Health record to this patient. You will get a notification SMS on the mobile with a deep link.
• The deeplink URI will point to phrsbx.adbm.gov.in/uhi/‘HIPCODE’.
• App should behave correctly as defined in this document for both user cases.
  • New User - who downloads, installs and creates a ABHA Address
  • Already installed App user

When you launch the PHR app, it starts with a log-on page or the home page for a logged in user. ABDM requires the PHR app to start at a different page if invoked with a specific intent. This can be described in 2 scenarios:

Scenario 1

• QR Code at Facility is scanned using third party camera app.
• This triggers a link (PHR | ABDM ) and lists the compatible PHR apps
• On selecting the PHR app, the PHR app is invoked with a specific intent. The App is expected to directly go to the share profile page pre-filled with the facility to share the profile

Scenario 2

• User has not shared the ABHA address at the health facility. Health Facility triggers an SMS notification with a deep link to the user’s mobile number when a new health record is created.
• The link looks like phr.abdm.gov.in/uhi/.
• On clicking the link, a list of compatible PHR applications is displayed.
• On selecting the PHR app, the app is invoked with the specific intent.
• The App is expected to go directly to the discovery and link page and pre-filled with the facility.

Test Cases

Deep Link Flow : Send SMS to patient mobile to initiate record linking and fetching in PHR app

Post clicking on deep link by patient

Use Case 1: In case ABDM compliant PHR application is not installed in PHR app, then user is redirected to download and install it from play store/app store."

Use Case 2: In case ABDM compliant PHR application is already installed in PHR app, then app will directly launch and initiate the User Initiated Linking (Discovery Flow)