> 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/abha-mobile-phr-application.md).

# ABHA Mobile (PHR) Application

ABHA Mobile (PHR) Application is a reference PHR application available on Android platform. The application can help in creation of an ABHA address, linking & viewing of health records and managing user consents. ABDM has revamped the Ayushman Bharat Health Account (ABHA) mobile application on Android platform with a new User Interface (UI) and new functionalities. The all new ABHA app in sandbox environment can be downloaded from below link:\
[https://sandbox.abdm.gov.in/docs/phr\_app![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAIDSURBVHgB7dpBUsIwFAbgPxH3HkFvoCeQDc648wbgQRBwvIf1BrpidFzUG3gEjsBeJPbBMCIgCSVJX8r7Zlyohen/Q9KmLSCEEEKIQ6Wct+wPmzhq9IqXnAPmBL50W+v7MHjNoHUbPmx6/yUNuHh4b8OYbP6LQZ1o6xb94elv+PqxF9A47qHG7AUYc4Mac5kD1ic8pTJMpx8IReusKD7fuo1SNEk2sSe3SXAVhb+7yhBKt5Vv/f98Um7CA/sQ4ObPEWl/aRXgOTxJpwB7+GeUkEYBtvDG3BY/LyiBfwEu4feYkHkXEDg84VtAhPCEZwGRwhN+BUQMT3gVEDk84VNABeFJubWAbz7CKzWaLdJ2VH0Bvj75+QIqx46qHQIVfe2XVVcAg/CkmgKYhCfxC2AUnsSdBEOGv3/rFEeBx7W/W+4LxPsGMPvkF+IUwDQ8CV8A4/AkbAHMw5NwBSQQnoQpIJHwxH8BtpupjMKTAAVcj2YhN2EWnoQZAhRytQSG4Um4SXC5BKbhSdjDIIX+npxxDU/CnwjRnMBYeneHPZMCcOCkABy4cleEtL4srsCAFdons/tDnC4FjLH6pJgxdPmpA042hx9bXuU0BD6RKqWsj824FDBAqiZf1n23F0C3nP5b3XFG++xwFup2FFic08M8wWFcVYj2LYc2F5zXH0IIIYTg4Qf5mSgwxEiacwAAAABJRU5ErkJggg==)](https://sandbox.abdm.gov.in/docs/phr_app)

#### Registration & Login (as per revised architecture)

The mobile app an individual can register for a ABHA Address in one of the following ways

| S.No. | Features                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ----- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1     | ABHA Address Registration with self-declared information     | <ol><li>• Create an ABHA address of the format abc\@abdm via mobile no / email ID using self-declared profile information filled in by an individual, such as photo, name, date of birth, gender, address. Mobile number is entered in profile info, in case a user is registering through mobile number and email ID is entered in profile info, in case a user is registering through email ID.</li><li>• Individual creates an easy to remember ABHA Address along with its password to login</li><li>• Profile is completed with an ABHA Address and a QR Code (with self-declared information filled in)</li></ol>       |
| 2     | ABHA Registration with 14-Digit ABHA Number\* (KYC verified) | <ol><li>• In this flow Individual is given an option of creating ‘ABHA address through ABHA (Number) via KYC document. Please note, the list of KYC documents may be revised from time to time.</li><li>• Create an ABHA address of the format abc\@abdm via 14-digit ABHA (Number). In this case, profile details like photo, name, date of birth, gender, mobile no, email ID, and address are fetched from the ABHA system.</li><li>• Individual creates an easy to remember ABHA Address along with its password to login<br>- Individuals may link/unlink ABHA (Number) with ABHA address as per their choice.</li></ol> |

An individual can now login on the ABHA Mobile Application in one of the following ways:

| S.No. | Features                            | Description                                                                                                                                                                          |
| ----- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1     | Login with mobile number / email ID | <ol><li>Individual enters mobile number/email ID, and it is validated via the added mode of validation.</li></ol>                                                                    |
| 2     | Login with ABHA Address             | <ol><li>Individual enters ABHA address (xyz\@abdm), and it is validated depending on auth mode of validation such as mobile OTP/aadhar OTP/email OTP or Password to Login.</li></ol> |
| 3     | Login with ABHA (Number)            | <ol><li>Individual enters 14-Digit ABHA (Number) and validates it via auth modes for the respective KYC document.</li></ol>                                                          |

#### ABHA ADDRESS POLICY

**1.ABHA Address Policy:**

“Minimum length 4 including alphabet, number & dot(.) are allowed. Number cannot be in beginning and dot(.) cannot be in beginning & end.” As a policy we allow creation of all numeric Abha addresses for Abha Number only: 14digit\@abdm.

**2. 10-digit Mobile number as ABHA Address:**

For now, we have restricted the creation of (10 digit) Mobile.No\@ABDM

**3.Creation of (14 digit\@abdm):**

ABHA Address is not allowed however we have the provision for the user to login with same 14digit\@abdm both in web PHR and mobile PHR

**4.Password validation :**

has been made optional. You may kindly check the below APIs at your end and reach out to us in case of any issues:

1. • Registration via ABHA:/api/v1/phr/registration/hid/create-phr-address
2. • Registration via Mobile and Email: /api/v1/phr/registration/create/phr

#### Transition from NDHM to ABDM

All ABHA Addresses (PHR Addresses) ending (username\@ndhm) stored at respective integrator databases have now been changed to username\@abdm. and going forward @ndhm will not be available for creating any ABHA address.

The integrators are requested to only pass ABHA addresses ending with domain @abdm to the ABDM systems.

Integrators should check all endpoints and modify accordingly as this change may disrupt their current flows. For example, healthid.ndhm.gov.in is now at abha.abdm.gov.in

**APIs & Documentation**

#### ABHA MOBILE APPLICATION API’s

In order to build the PHR apps Integrators should use following API’s:

**1-Login and Registration API’s**

[https://sandbox.abdm.gov.in/swagger/ndhm-phr-app2.yaml![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAIDSURBVHgB7dpBUsIwFAbgPxH3HkFvoCeQDc648wbgQRBwvIf1BrpidFzUG3gEjsBeJPbBMCIgCSVJX8r7Zlyohen/Q9KmLSCEEEKIQ6Wct+wPmzhq9IqXnAPmBL50W+v7MHjNoHUbPmx6/yUNuHh4b8OYbP6LQZ1o6xb94elv+PqxF9A47qHG7AUYc4Mac5kD1ic8pTJMpx8IReusKD7fuo1SNEk2sSe3SXAVhb+7yhBKt5Vv/f98Um7CA/sQ4ObPEWl/aRXgOTxJpwB7+GeUkEYBtvDG3BY/LyiBfwEu4feYkHkXEDg84VtAhPCEZwGRwhN+BUQMT3gVEDk84VNABeFJubWAbz7CKzWaLdJ2VH0Bvj75+QIqx46qHQIVfe2XVVcAg/CkmgKYhCfxC2AUnsSdBEOGv3/rFEeBx7W/W+4LxPsGMPvkF+IUwDQ8CV8A4/AkbAHMw5NwBSQQnoQpIJHwxH8BtpupjMKTAAVcj2YhN2EWnoQZAhRytQSG4Um4SXC5BKbhSdjDIIX+npxxDU/CnwjRnMBYeneHPZMCcOCkABy4cleEtL4srsCAFdons/tDnC4FjLH6pJgxdPmpA042hx9bXuU0BD6RKqWsj824FDBAqiZf1n23F0C3nP5b3XFG++xwFup2FFic08M8wWFcVYj2LYc2F5zXH0IIIYTg4Qf5mSgwxEiacwAAAABJRU5ErkJggg==)](https://sandbox.abdm.gov.in/swagger/ndhm-phr-app2.yaml)

**2-Consent Manager API’s**

Following app facing APIs of Consent Manager to be used for linking, fetching, and sharing

[https://sandbox.abdm.gov.in/swagger/ndhm-phr-app.yaml![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAIDSURBVHgB7dpBUsIwFAbgPxH3HkFvoCeQDc648wbgQRBwvIf1BrpidFzUG3gEjsBeJPbBMCIgCSVJX8r7Zlyohen/Q9KmLSCEEEKIQ6Wct+wPmzhq9IqXnAPmBL50W+v7MHjNoHUbPmx6/yUNuHh4b8OYbP6LQZ1o6xb94elv+PqxF9A47qHG7AUYc4Mac5kD1ic8pTJMpx8IReusKD7fuo1SNEk2sSe3SXAVhb+7yhBKt5Vv/f98Um7CA/sQ4ObPEWl/aRXgOTxJpwB7+GeUkEYBtvDG3BY/LyiBfwEu4feYkHkXEDg84VtAhPCEZwGRwhN+BUQMT3gVEDk84VNABeFJubWAbz7CKzWaLdJ2VH0Bvj75+QIqx46qHQIVfe2XVVcAg/CkmgKYhCfxC2AUnsSdBEOGv3/rFEeBx7W/W+4LxPsGMPvkF+IUwDQ8CV8A4/AkbAHMw5NwBSQQnoQpIJHwxH8BtpupjMKTAAVcj2YhN2EWnoQZAhRytQSG4Um4SXC5BKbhSdjDIIX+npxxDU/CnwjRnMBYeneHPZMCcOCkABy4cleEtL4srsCAFdons/tDnC4FjLH6pJgxdPmpA042hx9bXuU0BD6RKqWsj824FDBAqiZf1n23F0C3nP5b3XFG++xwFup2FFic08M8wWFcVYj2LYc2F5zXH0IIIYTg4Qf5mSgwxEiacwAAAABJRU5ErkJggg==)](https://sandbox.abdm.gov.in/swagger/ndhm-phr-app.yaml)

**After Login patient can do following:**

* Request Management
* Discover and Link Care Contexts
* View Health Records

#### Request Management and Discover/Link Care Contexts

This can be done using the Consent Manager APIs shared above

#### View Health Records

In order to view the health data on ABHA Mobile Application their needs be an HIU in backend which can create consent requests and get data on approval of consent request.

**Suggested steps for setup are:**

1. A. Patient logs into ABHA Mobile Application for the first time.
2. B. HIU behind ABHA Mobile Application to create a subscription request for the patient.
3. C. Patient approves the subscription request using ABHA Mobile Application.
4. D. Auto approval policy to be setup with the consent of the user.

**Post setup PHR HIU can start fetching data by:**

1. Creating consent request for patient based on subscription notification.
   * Whenever new data is available the HIU will be notified if there is an active subscription.
2. The consent request should be approved
   * If the auto approval policy is setup properly then consent request should be auto approved.
   * If not, then consent request can be manually approved by patient.
3. ABHA HIU should act a general HIU to fetch data from HIPs. Please refer to Building HIU. [https://sandbox.abdm.gov.in/docs/build\_hiu](https://sandbox.abdm.gov.in/docs/https://sandbox.abdm.gov.in/docs/build_hiu)
