Annexure

1. Ayushman Bharat Health Account (ABHA) - Overview and pathways for ABHA
Creation & System Integration through ABHA APIs
2. Healthcare Professionals Registry (HPR) - Overview and pathways for HPR
registration
3. Health Facility Registry (HFR) - Overview and pathways for HFR registration
Ayushman Bharat Digital Mission
.
State Adoption
Overview and pathways for ABHA Creation & System Integration through
ABHA APIs
 Objective

● The presentation is a comprehensive repository of all information regarding ABHA (Ayushman Bharat
Health Account), which is a core building block under ABDM (Ayushman Bharat Digital Mission).
It includes an overview on ABHA, its benefits, recommended practices, supporting resources and API
flows.

● The presentation may be utilised as a part of NHA’s capacity building and IEC material, specifically
for the States, to drive ABDM adoption

● The intended audience of this presentation spans across State leadership/ Nodal officer, master
trainers as well as technical partners.

Version 1 (Dated: 15th February, 2023)

2
01 ABHA Overview

3
 ABHA - Overview

ABHA Number is a 14-digit random unique number ABHA profile has the following details:
that acts an identifier in the healthcare ecosystem

Name

Date of Birth
0000-1111-2222-33
Gender
name@abdm
State/ District/ Address

Valid Mobile Number/ Email

ABHA Address* is an easy to remember username
that has links to the longitudinal health records. Aadhaar/ Driving License/ PAN
Only preferred Address is visible on the ABHA Card
*Ayushman Bharat Health Account (ABHA) Address is a unique identifier (self declared
username) that enables you to share and access your health records digitally. 4
 ABHA - Key design principles

ABHA is designed as a patient identifier in the healthcare ecosystem, created with

1 minimum demographic details

ABHA creation or share is completely voluntary for citizens, with opt out/delete
2 functionality

One person can have only one ABHA Number. However, they can have multiple ABHA
3 Addresses

ABHA linkage with patient’s reg. ID at healthcare facilities designed to enable faster
4 exchange of information and help build health history

5 Inclusivity in ABHA sharing: multiple options for both smartphone/non-smartphone users

6 Consent driven access to health data along with capabilities to manage and revoke consent

5
 Benefits of ABHA

Unique & Trustable Identity - Establish unique identity for citizens across different
healthcare providers within the healthcare ecosystem

Unified Benefits - Link all healthcare benefits ranging from public health programmes to
insurance schemes to the citizen’s unique ABHA number

Hassle-free Access - Avoid long lines for registration in healthcare facilities across the
country

Easy PHR Sign Up - Seamless sign up for PHR (Personal Health Records) applications such
as ABDM ABHA application for health data sharing
6
 User Journeys

Self - Aadhaar OTP

Registration/
Enrolment Assisted* -
Aadhaar (OTP, Fingerprint)
DL
PAN
User Journeys

Delete/ Deactivate

Profile
Management
Edit Photo, Mobile,
Email, Re-KYC
*When a user chooses to create an ABHA at a facility participating in the ABDM ecosystem, using ID documents other than Aadhaar,
their identity document is to be uploaded and identity manually verified, and an ABHA will be generated instantaneously.
Integration with Passport and Birth Certificate systems is under process 7
 Pathways for Large
02 Scale ABHA creation
Intended Audience: State/Programme Leadership and
Master Trainers
8
 ABHA Creation Methods
Following are the four methods to engage citizens and create/ capture ABHA

1 2
Self mode using ABHA portal Assisted mode using ABHA portal
● User downloads ABHA app or logs in to the ● State operator/ Front Line Worker (FLW)
ABHA portal to create an ABHA - creates ABHA for the citizen
abha.abdm.gov.in ● This method uses Aadhaar eKYC or physical KYC
● This method uses Aadhaar eKYC by the operator/ FLW through DL

3 4
Programme or HMIS Portal Programme Data
generated ABHA ● Programmes with Aadhaar demographic details
● A program operator creates ABHA for
of citizens can create ABHA through API call
beneficiaries using the program specific
● Integrator who wishes to use the program data
application which is integrated with ABDM
must write to NHA requesting the demo auth
● Programmes or HMIS portals can tailor the
role. After approval, the Integrator can start
ABHA generation experience to synergize
using the demo auth API
with their objective
● The citizen may or may not be present at time of
ABHA creation
9
 Process Flows for ABHA Creation

1
Self mode using ABHA portal

2 Assisted mode using ABHA portal

*Operator refers to personnel of the ABDM registered facility who is equipped with computer system 10
The ABDM registered facility (schools/ colleges/ other institutes) will be provided with login credentials for the operator
 Process Flows for ABHA Creation

3
Programme or HMIS Portal generated ABHA

Operator*/ FLW uses

Operator requests
ABDM enabled Authenticate via Collect patient’s ABHA Created
for patient’s Aadhaar
solution OTP/ demo auth/ consent
number
biometric

4
Programme Data

*Operator refers to personnel of the ABDM registered facility who is equipped with computer system 11
The ABDM registered facility (schools/ colleges/ other institutes) will be provided with login credentials for the operator
 ABHA Creation Pathways
States can select the pathways that best suit their context, and request NHA for the required support
Pathway for the State Method of Citizen Engagement Mode of Authentication Instances#

Awareness Camp - IEC activity Self-mode OTP -

Assisted-mode using ABHA portal/ Govt. of AP, UP,

Enumerations Drives OTP / Biometric*
Programme or HMIS portal Techo+

eHospital, eSushrut
Health Facilities (District hospitals, CHCs, Assisted-mode using ABHA portal/
OTP / Biometric and other state HMIS
etc) Programme or HMIS portal
(eg: Govt. of WB)

Camps (at schools, colleges, community Assisted-mode using ABHA portal/

OTP / Biometric Govt of Meghalaya
centres) Programme or HMIS portal

Self-mode/ Programme or HMIS

Engagement through Telemedicine OTP eSanjeevani
portal

Back-end drives by the programs Using Programme Data Demographic** PMJAY, CoWIN

Self-registration kiosks Self-mode OTP / Biometric Under discussion

#
12
This list is not exhaustive. *Biometric - match against fingerprint or face **Demographic - match against name, DoB and gender
 Recommended Practices

● Use of OTP for individual ABHA generation or enumeration drives, to record explicit user consent

● In case of OTP challenges, use of biometric devices or demo auth for bulk ABHA creation (ensure
appropriate mechanism for capturing citizen’s consent). ABHA integrator must ensure that citizens have
full understanding of the consent language and give willing consent. The integrator should inform
ABDM if the consent was taken.

● Engage citizens at health facilities through ABDM enabled HMIS*. Tangible benefits like faster patient
registration for OPD using QR code, can be leveraged at health facilities to encourage citizens to adopt
and actively use ABHA

● Integration of program portals with ABHA to engage beneficiaries and digitize benefit related health
records. Example* - Sickle Cell, Cowin, NCD, NIKSHAY, RCH, NVHCP

*Complete list of ABDM enabled partners available at https://abdm.gov.in/partners

13
 Lessons from the States

Theme State/UT Actions Taken

● Embedded “ABHA generation” within ongoing NCD surveys by ANMs & ASHAs
● Created ABHA(s) during OPD visits to Public Health Institutions
Andhra ● Used biometric for authentication at public facilities
Pradesh ● Leveraged demo auth for bulk ABHA generation
● Devised unified functionary-based applications like MO AP Health App for Medical Officers, ANM AP
Health App for ANMs, etc. and is getting them integrated with ABDM
● Leveraged PM-JAY architecture to create ABHA
● Used biometric for authentication at facilities
● Used both modes for ABHA creation
ABHA Creation
Karnataka ○ Active mode - assisted mode (front desks at facilities, AB-PMJAY-ArK co-branded cards, other
portals such as RCH, NCD etc)
○ Passive mode - self mode (Pvt/ ABDM enabled systems, EkaCare, Raxa etc.)
● Majority facilities using eHospital (ABDM enabled), which helped in ABHA creation at facilities
● Used State HMIS (WB-IHMS) for ABHA generation through Online OPD ticket booking, IPD admission,
West IPD Diagnostic/ Pharmacy and Online Discharge
● Used State Programs: Swasthya Saathi (State Insurance Scheme) and Swasthya Ingit (State
Bengal Telemedicine Service) for ABHA registration
● Creation of ABHA ID through a camp mode outreach program, Duare Sarkar.
14
Note: This list is not exhaustive.
 Lessons from the States

Theme State/UT Actions Taken

● Leveraged enumeration drives at scale under RCH
● Used offline and facility assisted mode for ABHA creation
Uttar
ABHA Creation ● Leveraged demo auth for bulk ABHA generation
Pradesh ● Meeting held and letter issued to partners to motivate subordinate staff for creation of ABHA ID in all
programmes where there is provision to create ABHA ID.
Andhra
● Conducted campaigns at educational institutes to initiate ABHA creation for younger population
Pradesh
Karnataka ● One-to-One encouragement for value realization by public

IEC Uttar
● Promoted self registration by conducting awareness camps
Pradesh
● Conducted awareness programmes at community level
Andaman ● Placed IEC materials like Banners, Foam boards and Sticker at public places.
● Distributed pamphlets at health institutions and various inter-island ticket counters (Bus & Ship).
● Included ABHA generation as an assessment parameter as part of reviews in the Health Dept of the State
Monitoring Gujarat
to ramp up efforts on the ground
Citizen Andaman &
● Separate registration counters in the OPD area for patients with ABHA to demonstrate faster registration
Engagement Karnataka
15
Note: This list is not exhaustive.
 Tracking Mechanisms
States are recommended to use the ABDM Dashboard (dashboard.abdm.gov.in) for tracking their progress.
Select State

district-wise

overall

date-wise

16
 Tracking Constraints

● ABDM does not record block or village level information. Hence, States can only drill-down ABHA
creation upto district level

● NHA cannot track ABHAs created by each ASHA/ Front-line worker or by each Health Facility
(unless it is created using ABHA portal)

● Number of ABHAs created by a program as reflected on the dashboard may appear fewer than
the authentications conducted on-ground by the partner. This is the case where citizen’s ABHA
has already been created through CoWIN or PMJAY and on-ground authentication returns the
pre-existing ABHA

17
03 Integration & API Flows
Intended Audience: Technical Partners who are looking
to integrate their HMIS/ Programme portal with ABDM
18
 ABDM Integration Milestones

M1 M2 M3
Health Information Health Information
ABDM Provider (HIP) services User (HIU) services to
Integration ABHA creation, to link patient’s health share patient’s health
Milestones capture & verification records with ABHA records between other
(User discovery or HIP entities in the ABDM
initiated) ecosystem

● QR code based
fast-tracked ● Electronic Health
● Collation of health
registration at Records for doctors
records in digital
Use Cases hospitals ● Improved diagnosis,
format in PHR apps
● Common identifier analysis and policy
/ health lockers
among government decisions
benefit programs

19
 M1 API Flows

OTP

Aadhaar Biometric

Creation Demographic
(with due consent)*
DL/ Other Documents

M1 API Flows

OTP

Verification

Biometric
*Consent language is provided in the resources 20
Step 1: Call the sessions API -
Sandbox: https://dev.abdm.gov.in/gateway/v0.5/sessions
Production: And https://live.abdm.gov.in/gateway/v0.5/sessions
Request: client id and client secret
Response – authorization token

Creation Aadhaar OTP

S no. API Endpoint Description Request Response
1 /v1/registration/aadhaar/generateOtp Here Aadhaar Number
Aadhaar Txn ID
will be entered

2 v1/registration/aadhaar/verifyOTP Enter OTP and Txn ID OTP, Txn ID Txn ID

Registration
via Aadhaar v1/registration/aadhaar/checkAndGenerat Generate Mobile OTP for Mobile, Txn
2 Txn ID
OTP eMobileOTP verification. ID
Verify Mobile OTP in an
3 v1/registration/aadhaar/verifyMobileOTP OTP, Txn ID Txn ID
existing transaction.
v1/registration/aadhaar/createHealthIdWit Create ABHA Number Txn ID, ABHA ID,
4
hPreVerified and Address Demo X-Token
21
 Creation Aadhaar Biometric

● To use the biometric APIs, the client needs to have a Aadhaar Registered Device (RD Device)
that allows capture and processing of biometrics of the beneficiary. The list of RD device
vendors is provided in the resources slide at the end of the deck.
● This RD Service returns an encrypted PID block containing signed biometrics.
● The PID can be then passed through the aadhaar/verifyBio API mentioned below.

ABHA Team can help the integrators with the code that triggers the RD Device and generates PID

S no. API Endpoint Description Request Response

Aadhaar,
1 Here Aadhaar Number
/v1/registration/aadhaar/verifyBio biotype, Txn ID
and PID will be entered
PID
Registration v1/registration/aadhaar/generateMobileOT Generate Mobile OTP for Mobile, Txn
2 Txn ID
via Aadhaar P verification. ID
Biometric Verify Mobile OTP in an
3 v1/registration/aadhaar/verifyMobileOTP OTP, Txn ID Txn ID
existing transaction.
v1/registration/aadhaar/createHealthIdWit Create ABHA Number Txn ID, ABHA ID,
4
hPreVerified and Address Demo X-Token
22
 Creation Aadhaar Demographic

● At present, the API is only available to benefit programmes - Government programmes and
Government HMIS solutions
● The integrator must collect user consent before creating ABHA through demo auth

S no. API Endpoint Description Request Response

Aadhaar,
Here Aadhaar
demographic
1 /v1/hid/benefit/createHealthId/demo/auth Number and ABHA
Registration details and
demographic details profile
via Aadhaar profile
will be entered
Demographic details
2 v1/hid /benefit/update/phr-address Creates an ABHA ABHA ABHA
Address Number Address

23
 Verification Biometric

Type of API S no. API Endpoint Description Request Response

Initiate authentication process Auth Method,

1 v1/auth/init Txn ID
for Given ABHA Number ABHA Number

Login/
v1/auth/confirmWithAad
Verification 2 Authentication using Biometrics PID, Txn ID X-Token
haarBio

ABHA
3 v1/account/profile Get Account Information X-Token
profile

24
 Verification Mobile OTP / Aadhaar OTP

Type of API S no. API Endpoint Description Request Response

Initiate authentication process Auth Method,

1 v1/auth/init Txn ID
for Given ABHA Number ABHA Number

/v1/auth/confirmWithMobil
2a eOTP Authentication with OTP OTP, Txn ID X- Token
Login/
Verification
/v1/auth/confirmWithAadh
2b aarOtp Authentication with OTP OTP, Txn ID X-Token

ABHA
3 v1/account/profile Get Account Information X-Token
profile

25
04 Supporting Resources
Intended Audience: Technical Partners who are looking
to integrate their HMIS/ Programme portal with ABDM
26
 Common M1 Integration Issues

S.No Issue Resolution/ Common Cause

When to use v1 and when to use v2 Integrators can use either v1 or v2 APIs or a combination of both. If a partner has already
1
APIs integrated with v1, they can add functionalities using v2 without changing v1 APIs

2 Difference between v1 and v2 OTP, Aadhaar number and other sensitive data must be encrypted in v2 APIs

3 Integrators using .ndhm domain ABMD is closing all .ndhm domains and integrators should only use .abdm domains

Role was missing in the Authorization Token.

Facing issue with most of the API
4 1."healthId" role is mandatory in every HID API
call getting 401 ERROR
2. "HidIntegratedProgram" role only for integrated benefit program
a. Get the device from registered vendor and have the device registered/certificates
updated
b. All the necessary parameters should be present in the PID block.
Not able to create ABHA using
5 For example.
Biometric flow
<PidOptions ver="1.0"> <Opts fCount="1" fType="2" pCount="0" format="0" pidVer="2.0"
wadh="E0jzJ/P8UopUHAieZn8CKqS4WPMi5ZSYXgfnlfkWjrc=" timeout="20000"
posh="UNKNOWN" env="P" /> </PidOptions>

6 Aadhaar OTP not receiving Aadhaar services down 27

 Consent Language for Aadhaar based ABHA Creation

I, hereby declare that I am voluntarily sharing my Aadhaar Number and demographic information issued by
UIDAI, with National Health Authority (NHA) for the sole purpose of creation of ABHA number . I understand
that my ABHA number can be used and shared for purposes as may be notified by ABDM from time to time
including provision of healthcare services. Further, I am aware that my personal identifiable information (Name,
Address, Age, Date of Birth, Gender and Photograph) may be made available to the entities working in the
National Digital Health Ecosystem (NDHE) which inter alia includes stakeholders and entities such as
healthcare professionals (e.g. doctors), facilities (e.g. hospitals, laboratories) and data fiduciaries (e.g. health
programmes), which are registered with or linked to the Ayushman Bharat Digital Mission (ABDM), and various
processes there under. I authorize NHA to use my Aadhaar number for performing Aadhaar based
authentication with UIDAI as per the provisions of the Aadhaar (Targeted Delivery of Financial and other
Subsidies, Benefits and Services) Act, 2016 for the aforesaid purpose. I understand that UIDAI will share my
e-KYC details, or response of “Yes” with NHA upon successful authentication. I have been duly informed about
the option of using other IDs apart from Aadhaar; however, I consciously choose to use Aadhaar number for
the purpose of availing benefits across the NDHE. I am aware that my personal identifiable information
excluding Aadhaar number / VID number can be used and shared for purposes as mentioned above. I reserve
the right to revoke the given consent at any point of time as per provisions of Aadhaar Act and Regulations.

28
 Frequently Asked Questions
● Does ABDM store citizens’ health records?
ABDM does not store any health records. Citizens’ health records are stored with their healthcare information providers as per
their retention policies and are shared over the ABDM network with encryption mechanisms only after the express consent of the
citizen.

● Why can’t Aadhaar be used as ABHA number, why is an independent identification number required?
The Aadhaar Act provides for the use of Aadhaar number as proof of identity of a person, subject to authentication. However, the
mandate of mandatory linkage of Aadhaar is restricted. Therefore, a distinct, independent, unique identifier is required to be
identified as ABHA number.

The concept of ABHA Number in the digital health ecosystem is similar to the concept of the bank account number in the financial
sector. Just like a bank account linked to Aadhaar KYC, is used for financial transactions, similarly, an ABHA linked to Aadhaar or
any other KYC document is used for digital health transactions. Hence, Aadhaar cannot be used in place of ABHA Number.

● Can more than one family member link the same mobile number to their respective ABHA numbers?
Yes. One mobile number can be linked with up to 6 ABHA Numbers.

● How can the citizen retrieve their ABHA number if they have misplaced the ABHA card?
Users can login to their Ayushman Bharat Health Account at abha.abdm.gov.in using mobile number and retrieve ABHA number.
The portal also gives users the option to download and print their ABHA card.

29
 Frequently Asked Questions
● How can ABHA be created in areas where there is limited or no connectivity?
In order to accommodate areas with limited or no internet/mobile connectivity, NHA has made the provision of an offline mode
of ABHA creation. For this, the demographic details of the citizens are noted down either through paper-based forms or digital
devices, and later uploaded at centres with IT infrastructure and internet connectivity through the ABHA portal,
HMIS/programme portal, or other digital solutions that are ABDM enabled. The provision to create ABHA Number in offline mode
is only enabled for select Center/s. The permission-based access is provided by ABDM upon request.

● Does a citizen need an ABHA card if they already have an Ayushman Card?
The ABHA Card is not to be confused with the Ayushman Card. ABHA is the identity of the individual in the digital health
ecosystem established by the Ayushman Bharat Digital Mission whereas the Ayushman Card is issued under the AB-Pradhan
Mantri Jan Arogya Yojana and enables its beneficiaries to avail health insurance.

● Are there any free or subsidized treatment/healthcare services available if a citizen has an ABHA number?
No. ABHA Number only provides the digital identity of the person in the digital health ecosystem. The cost of the treatment, free
or otherwise, is decided by the policies of respective healthcare providers and schemes. ABHA Number can be used to check the
citizen’s identity and eligibility in the digital system of that scheme.

● More FAQs can be found under the support section on the ABDM and ABHA websites.

30
 Resources

● For biometric (fingerprint) authentication, the States need to procure RD devices. List of RD device vendors
as approved by UIDAI, is provided here:

Mantra ACPL ArMee Oasys Bioenable Secugen

Idemia Evolute Precision Matrixcomsec Linkwell Integra

Aratek NextBiometrics Syncbyte Tatvik

The list is updated by UIDAI from time to time

● Sandbox link for Benefit Programs and HMIS portals to start integration with ABHA:
Sandbox.abdm.gov.in

● Documentation of APIs for integration with ABHA:

https://app.swaggerhub.com/apis-docs/abdm.abha/abha-service/1.0

● Grievance Portal : https://grievance.abdm.gov.in/

● Call Center : 1800-11-4477

31
 .
Thank You
Ayushman Bharat Digital Mission
.
State Adoption
Overview and Pathways for HPR Registration
 Objective

● The presentation is a comprehensive repository of all information regarding Healthcare Professionals

Registry (HPR), which is a core building block under ABDM (Ayushman Bharat Digital Mission)

● The presentation may be utilised as parts of NHA’s capacity building and IEC material, specifically for
the States, to drive ABDM adoption

● The intended audience of this presentation spans across State leadership/ Nodal officer, master
trainers as well as technical partners.

Version 1 (Dated: 15th February, 2023)

2
01 HPR Overview

3
 Understanding HPR

● Healthcare Professionals Registry (HPR) is a comprehensive repository of registered and verified

practitioners delivering modern as well as traditional healthcare services across India

● HPR is envisaged to evolve into a citizen-centric and practitioner-centric platform in compliance with
global healthcare standards

● The healthcare professional gets a unique 14 digit HP ID, giving them an identifier in the healthcare
ecosystem

● Benefits include:
○ Unique & Trustable Identity - Provision of unique Healthcare Professional ID to connect with all
stakeholders of healthcare ecosystem
○ Online Presence & Discoverability - Ease of discovering verified healthcare professionals and
better access to quality healthcare
○ Telemedicine - Verified healthcare professionals can treat patient remotely through telemedicine
and review digital health records
○ Unified Digital Services - Host of online benefits such as license renewal, obtaining no-objection
certificate, digital signature, and access to clinical decision support systems 4
 Pathways for
02 registration on HPR
Intended Audience: State/Programme Leadership and
Master Trainers
5
 HPR - Registration Methods
Following are the three methods to register in HPR

1 Self registration using HPR portal 3

Bulk Upload (Under development)
● User can register for a HP ID via the council ● Bulk Upload functionality in State/UT
search feature on the HPR Portal Admin dashboard - the state
● User can also register in HPR by creating administration can download the excel
the HP ID on https://hprid.abdm.gov.in/ template from the HPR Portal and collect
and then continue to the HPR Portal data according to the requirements
● They can bulk upload the data of
healthcare professionals collected in this
2 manner
HMIS/LMIS Portal generated HPR
● ABDM Compliant and HPR linked
HMIS/LMIS can be used by a healthcare
professional to create HP ID and then
register in the Healthcare Professional
Registry (via API).
● The relevant API is available here:
https://hpr.abdm.gov.in/en/apidocuments

6
 Registration Process (via Council Search feature)

Generate Healthcare Complete Profile to

Verification
Professional ID register on HPR Portal

Visit HPR Portal and click on Click Healthcare Professional can verify Upon submission of the registration
here for Login or Registration the pre-populated information and request, verification is done by the
populate missing fields in the respective council and the state
Go to ‘For New User’ section. Select following three sections to complete (work) verifier.
your registration council and enter the profile:
registration number along with
category and sub-category. 1. Personal Details
2. Registration and Academic
Upon submission, verify the Details
information displayed and enter 3. Work Details
Aadhaar number. User will be
redirected to their profile, upon User can then move to Preview
successful verification of Aadhaar Profile section. After verifying all
number information, Healthcare professional
can then click on E-Sign HPR Profile
and submit the profile for
verification

A step-by-step demonstration of the registration process is provided in the user manual. 7

 Registration Process (via HP ID)

Generate Healthcare Complete Profile to

Verification
Professional ID register on HPR Portal

Visit https://hprid.abdm.gov.in/ Click on Click here for Login or Upon submission of the registration
and click on Create your Healthcare Registration on the HPR Portal and request, verification is done by the
Professional ID now login using the HP ID/username and respective council and the state (work)
password (or Aadhaar/Mobile OTP). verifier.
Click on I am Healthcare Professional
and generate HP ID using Aadhaar OTP In order to complete the profile,
or Driving License. Applicants healthcare professional needs to fill
registering using Driving Licence are the following three sections:
required visit respective 1. Personal Details
National/State Council for due 2. Registration and Academic
verification. Details
3. Work Details
User can then complete the
registration form and click on Click User can then move to Preview Profile
Here to redirect to the HPR Portal section. After verifying all information,
Healthcare professional can then click
on E-Sign HPR Profile and submit the
profile for verification

A step-by-step demonstration of the registration process is provided in the user manual. 8

 HPR - Overall Process Flow

Healthcare Professional

Self reported demographic,

Enrollment on HPR
registration and work
information.
HPR-HFR Linkage

Healthcare Professional ID Active, approved HPID given post verification

Healthcare Professional Registry Health Facility
(HPID) Enrollment via KYC and receipt of HPID

Professionals and facilities can be declared,

Details stored confirmed and linked with each other.
updated in
HPR
Structured and
Registration Council/Registry
Registration council/ education verified data
institute can use the HPR web portal/ National Institutions and
council software or the HPR compliant
Authorized Entities
software to verify submitted
registration, education records
National institutions and authorized entities
against their own records.
can access HPR to update their own datasets.
Education Institution

9
 HPR Onboarding Pathways
States can select the pathways that best suit their context, and request NHA for the required support

Pathway for the State Method of Healthcare Professional Engagement Instances#

Awareness Camp - IEC activity Self enrollment Govt. of AP

API Integration Assisted-mode using Production APIs Govt. of UP

Bulk Upload via HPR Portal under development -

#
10
This list is not exhaustive.
03 Supporting Resources
Intended Audience: State/Programme Leadership and
Master Trainers
11
 Recommended Practices

● In case of OTP challenges, use of password or Aadhar OTP Services for smooth and securely
logging into HPR portal.

● Integration of HMIS/LMIS systems with HPR via registered professional API for creation of HPR ID
and enrollment in HPR. The list of partners is available at https://abdm.gov.in/partners

● Integration of council software (NMC, Dental Council, Homeopathy Council, etc) with HPR

12
 Lessons from the States

State/UT Actions Taken

● Official order issued to govt professionals to register themselves under HPR
Arunachal ● Official circulars issued to DMOs to oversee and ensure registration under HPR
Pradesh ● Monthly review of HPR saturation status
● Registering private professionals by engaging heads of private facilities
● Encouraging health professionals to register on HPR by themselves. This approach nudges behavior change
of health professionals in the long term
● Thinking beyond HPR registration - the benefits of ABDM were communicated to healthcare professionals to
create long-term buy-in
● List of prerequisites i.e Academic Certificates, Active Council Membership & Appointment Orders were
communicated in advance
● Difference between HPR, HPR Address/Alias, HFR Address/Alias & ABHA Address was explained in detail
Andhra Pradesh
● Forum for Grievance Redressal with all Medical Councils in the state was created for ease of coordination
● 3-4 virtual Training Sessions were conducted with all Doctors in the State and daily virtual queries sessions
were conducted at District Level
● In case of Knowledge gap issues, the issues are addressed at District or State level.In case of technical
issues they were sent to ABDM-HPR Team
● Weekly review meetings were conducted by MD-ABDM with State Nodal Officer, State Level IT Team &
Registrars/Verifiers of State Medical Councils (All Systems of Medicine)
13
Note: This list is not exhaustive.
 Lessons from the States

State/UT Actions Taken

● Established a repository (Manav Sampda) of all the regular and contractual staff working in UP Health
system
Uttar Pradesh ● Integrated Manav Sampda with HPR to generate HP ID for healthcare professionals
● In cases where Doctors and other staff did not have the digital literacy to upload data, they were asked to
enter data offline (on paper) which was later entered online
● Regular awareness and drives maintain a regular flow of HP registering in HPR
Maharashtra ● Continuously reaching out to central team for any recent updates and training to be provided for recent
updates if any

14
Note: This list is not exhaustive.
 Tracking Mechanisms
States are recommended to use the ABDM Dashboard (dashboard.abdm.gov.in) for tracking their progress.
Select State

district-wise

overall

date-wise

15
 Frequently Asked Questions
● Is there a fee involved for registration in Healthcare Professional Registry?
There is no fee for registration in the Healthcare Professionals Registry or for generating a Healthcare Professional ID.

● If a user is not currently working can they enrol in the Healthcare Professionals Registry?
Yes, healthcare professionals who are registered with their respective councils but are not practicing can also enrol.

● A healthcare professional works in more than one hospital, can all hospitals be listed?
Yes. Healthcare Professionals Registry allows healthcare professionals to declare one or more health facilities they
work in. Applicants are encouraged to list all the facilities they work in.

● What personal information is gathered in the Healthcare Professionals Registry?

The Healthcare Professionals Registry follows a minimalistic approach to data collection and only seeks information
which is necessary to verify the identity and credentials of a healthcare professional. This includes demographic,
contact, registration, academic, and place of work details.

● Once the account is created, will the healthcare professional’s given information be visible to everyone?
The healthcare professional will be able to choose if they want their profile to be public. In public profiles, some
information would be made visible to all - name, educational qualification and experience. The visibility of other
additional information (address, contact information, photo) is changed from profile settings.

16
 Frequently Asked Questions
● How will the data in Healthcare Professionals Registry be used?
Basic minimal data has been requested to ensure that the healthcare professional can be verified and on boarded by
respective authorities. The collected data shall only be used for analysis from a public health point of view. Select
data will also be provided to digital health solution providers who integrate with ABDM so that they can display the
list of healthcare professionals with suitable attributes for the prospective patients.

● Is there a mobile application to register on Healthcare Professionals Registry?

Presently, there is no mobile application for Healthcare Professionals Registry. However, the website for HPR is mobile
responsive.

● How can the user change their password?

To change the password, the user can login at https://hprid.ndhm.gov.in/login and select the ‘Change Password’
option from their profile. They have to enter their new password, choose a confirmation mechanism such as via
mobile OTP, Aadhaar OTP, or old password.

● If having issues with the application who needs to be contacted?

The user can register their grievance on https://grievance.ndhm.gov.in or call 1800 11 4477

● More FAQs can be found on the HPR and ABDM websites.

17
 Resources

● Sandbox Link for HPR : Sandbox.abdm.gov.in

● Documentation of APIs for integration with HPR: https://hpr.abdm.gov.in/en/apidocuments

● HPR User manual : https://hpr.abdm.gov.in/en/usermanual

● Grievance Portal : https://grievance.abdm.gov.in/

● Call Center : 1800-11-4477

18
 .

Thank You
Ayushman Bharat Digital Mission
.

State Adoption
Overview and Pathways for HFR Registration
 Objective

● The presentation is a comprehensive repository of all information regarding Health Facility Registry
(HFR), which is a core building block under ABDM (Ayushman Bharat Digital Mission). It includes an
overview on HFR, its benefits, pathways for registration on HFR, recommended practices and
supporting resources.

● The presentation may be utilised as part of NHA’s capacity building and IEC material, specifically for
the States, to drive ABDM adoption

● The intended audience of this presentation spans across State leadership/ Nodal officer, master
trainers as well as technical partners.

Version 1 (Dated: 15th February, 2023)

2
01 HFR Overview

3
 Understanding HFR

● Health Facility Registry (HFR) is a comprehensive repository of health facilities of the country across
modern and traditional systems of medicine.

● HFR includes both public and private health facilities, including hospitals, clinics, diagnostic laboratories and
imaging centers, pharmacies, etc.

● The facility gets a unique 12 digit Facility ID, giving the facility an identifier in the healthcare ecosystem

● Benefits include:
○ Unique & Trustable Identity - Facility ID for identification of health facilities across the ABDM
ecosystem
○ Online Presence & Discoverability - Listing of health facilities on a national platform and availability in
search results
○ Ease of doing business - Digitisation of services reduces efforts for registration & renewal of various
licenses, and empanelment with insurance agencies, TPAs
○ Unified Digital Services - Access to telemedicine, digital health records and HMIS solutions

4
 Pathways for
02 registration on HFR
Intended Audience: State/Programme Leadership and
Master Trainers
5
 HFR - Registration Methods

Following are the two methods for HFR Registration

1 2

Self mode using HFR website Through API Integration

● User logs into the HFR ● Integrators/Technical Partners can

website leverage HFR Onboarding APIs to
register facilities in bulk
● This method uses Aadhaar
eKYC ● The relevant API is available here:
https://facilitysbx.abdm.gov.in/swagge
● User creates and registers r-ui.html
their facility on HFR

6
 Registration Process for Facilities

Generate Healthcare
Role Selection Search and Register Verification
Professional ID

Visit https://facility.abdm.gov.in/ The user dashboard will show 2 The Facility manager will get four Upon submission of the
and click on Click Here for Login different roles if the user is not options here: registration request, verification
or Registration mapped to any role OR is logging 1. Search using health of existence of health facility is
into HFR for the first time: facility’s name done by the State government
User can login using their 2. Search using the ID of and UT administration
1. Facility Manager your health facility
Healthcare Professional ID (HP
2. Nodal Officer/Verifier registered in AB-PMJAY,
ID) and password (or Mobile/
NIN etc.
Aadhaar OTP) or can click on Click To Add/Register facilities, click on
3. Register New Facility
here to Register to generate an Facility Manager button
4. Add Facilities in Bulk
HP ID before registration of a On the next page, click on Search
health facility. and Register Facility Button Upon selecting the appropriate
search/register option, the
facility manager will be asked to
verify/fill information for
registration - facility name,
address, geo-location, contact
details, etc and submit the same.
Registration via API
APIs and documentation have been published which allow health For bulk upload, the facility
facility registration by respective HRPs and state governments manager will have to upload the 7
respective details as a csv file.
 Registration for Verifiers

Generate Healthcare
Role Selection Register Verification
Professional ID

Visit https://facility.abdm.gov.in/ The user dashboard will show 2 On the ‘Nodal Officer & Verifier Upon submission of the
and click on Click Here for Login different roles if the user is not Registration Form’: registration request, verification
or Registration mapped to any role OR is logging and approval of role request is
into HFR for the first time: 1. Request Assignment of done by officials per the system
User can login using their Role as hierarchy
1. Facility Manager
Healthcare Professional ID and - State Mission Director
2. Nodal Officer/Verifier
password (or Mobile/ Aadhaar - District Nodal Officer
OTP) or can click on Click here to To Add/Register facilities, click on - District Verifier
Register to generate an HP ID Nodal Officer/Verifier button 2. Select State/UT
before registration of a health
facility. Click on Initiate Request

8
 Process Flows Software Linkage & Healthcare Professional Linkage

Software Linkage

From the Verify the details,

Add HRP*
Login using dashboard, check the
Visit HFR Bridge Id &
HPID & select ‘Software acknowledgement
website click on ‘Get
password Linkage’ on your checkbox and click
Details’
facility card on ‘Register HIP’

Healthcare Professional Linkage

From the Add & search Click on “Declare”

dashboard, to declare the
Login using Healthcare
Visit HFR select ‘Add
HPID & Professional & association of the
website Healthcare
password Professional’ on click get Healthcare
your facility card details Professional.

*HRP (Health Repository Providers): They are software service providers who offer ABDM compliant software and long-term digital storage of health records to Health Information
Providers (HIPs) like hospitals, labs, clinics, etc. Their primary role is to enable HIPs to meet their obligations of sharing and securely maintaining the health records of 9patients
digitally.
 HFR Onboarding Pathways
States can select the pathways that best suit their context, and request NHA for the required support

Pathway for the State Method of Engagement Instances#

Self-mode Awareness Camp - IEC activity

Govt. of AP, UP, HMIS

API Integration Assisted-mode using Production APIs
Providers

eHospital, eSushrut
Health Facilities (District hospitals, CHCs, etc) Assisted-mode using HFR website
and other state HMIS

Back-end drives by the programs Using Programme Data PMJAY, PMNDP

#
10
This list is not exhaustive.
03 Supporting Resources
Intended Audience: State/Programme Leadership and
Master Trainers
11
 Recommended Practices

● Use of https://facility.abdm.gov.in/ for individual facility registration or enumeration drives, to

increase registration

● HFR integrator* must ensure that the state, health programs and private entities have full
understanding of the HFR registration process and features.

● Engage officials at health facilities through ABDM enabled HMIS**. Tangible benefits like Unique &
Trustable Identity, Online Presence & Discoverability, Ease of doing Business, and Unified Digital
Services of health facilities can be demonstrated to encourage public and private entities to
register on HFR

● Integration of program portals with HFR to engage beneficiaries and create “Single Source Of
Truth”

*Any party leveraging API integration to onboard facilities to HFR

**List of existing partners is available at https://abdm.gov.in/partners
12
 Lessons from the States

State/UT Actions Taken

● Geo-tagged all public health facilities to create a repository (UP ke Swasthya Kendra) which was
leveraged for registration on HFR
Uttar Pradesh ● Leveraged API based bulk upload approach to generate Health Facility ID for all public health
facilities
● Conducted Alternate day virtual training cum meeting sessions with district team
● Created a sense of competition among districts for registration on HFR
● Mapped transferred verifiers to the new location through login of District Nodal officer in cases of
posting transfer of District verifiers and nodal officers
Bihar
● Used mapping feature available in the District Nodal officer login to map multiple health facilities
to respective facility manager (Facility manager of a PHC (block) mapped to all lower level health
facilities i.e. APHC and HSC in that block)
● Conducted training at the state level for all District nodal officers and District verifiers
West Bengal
● Conducted Follow-up training of all facility managers (both government and private facilities)

Sikkim ● Renewal of Private health facilities’ licence conditional on HFR registration.

Puducherry &
Arunachal ● Leveraged the Clinical establishment Act to mandatorily get facilities to register on HFR
Pradesh
13
Note: This list is not exhaustive.
 Tracking Mechanisms
States are recommended to use the ABDM Dashboard (dashboard.abdm.gov.in) for tracking their progress.
Select State

district-wise

overall

date-wise

14
 Common Challenges

S.No Issue Resolution/ Common Cause

The existing construct in ABDM allows linkage of one facility to a single HRP (HMIS/LMIS
etc) only. However, a facility can have multiple softwares such as HMIS, LMIS as well as
government programs and applications like e-Sanjeevani, RCH, UWIN etc.

1 Multiple HRP linkages To enable adoption and scaling up, and building longitudinal health records, it is essential
to enable linkage of 1 Facility to multiple HRPs

Solution: NHA is aware of this challenge and will work on revision of architecture with
changes in both HFR and Gateway, to enable linkage to multiple HRPs
The existing application has been built with changing requirements, and the processes
have been refined since the launch of National Digital Health Mission (NDHM) in 2020.
Database structure, User Some of the workflows and entity attributes are hard-coded affecting user experience.
2 experience – Need for Application
Redevelopment Solution: NHA has taken note of the issues related to user experience and will work on
revamping application UI/UX and updating the database architecture to allow dynamic
updates

15
 Frequently Asked Questions
● Why is there a need to have a healthcare professional ID to register in the Health Facility Registry?
The Healthcare Professional ID is an authentication mechanism that allows users to access Health Facility
Registry and various services in the Ayushman Bharat Digital Mission, without having the need to enter user
credentials at multiple places. It essentially ensures that no unauthorised person can access the health facility
details.
● Who can access the data on the Health Facility Registry?
Only publicly visible information can be accessed by third parties. The administration/ verifiers/ governing body
under which the health facility comes also have access to the data.
● How can the data in Health Facility Registry be used?
Basic minimal data has been requested to ensure that the health facility which is applying on the ABDM platform
can be verified and onboarded by respective authorities. It is also essential to ensure that even if healthcare
facilities are authentic, the claims that they make regarding various attributes such as, facilities/services
available are also cross verified. This information shall only be used for analysis from a public health point of
view. Select data will also be provided to digital health solution providers who integrate with ABDM so they can
display the list of healthcare facilities with suitable attributes for the prospective patients.
● How much time it will take to complete the application?
Time taken to enter the information depends on information being readily available in the form of supporting
address proof documents, internet speed. However, if you have all information and supporting documents are
available, registration can be completed within 20-30 minutes. The time required for a small facility will be less as
compared to the time required for a large hospital. Facility will be required to upload two photographs (one of the
facility and the other showing the board) during application. 16
 Frequently Asked Questions

● A facility has not yet started digitalization completely. Can they join ABDM?
Yes they can. Joining ABDM is just first step to enter the digital health ecosystem of India. It is understood that
digitization of health records is difficult and at times time-consuming, particularly for older records. Therefore, the
ABDM does not insist that from the day of joining, there will be digitization of every health record within the facility.
However, ABDM does encourage the facility to shift to digital health systems in a gradual and phased manner.
● A facility wants to update the details in the Health Facility Registry. What is the procedure for the same?
Once a facility has been approved for listing in the HFR, a facility manager can update basic details about the facility
by logging in at https://facility.abdm.gov.in using Healthcare Professional ID. However, any change in facility name,
address and other essential information will be shown as self-declared until it is verified again by the appropriate
authorities.
● If having issues with the application, whom should the facility contact?
The facility should register their grievance on https://grievance.abdm.gov.in/ or call 1800 11 4477.
● More FAQs can be found under the support section on the HFR and ABDM websites.

17
 Resources

● Sandbox link for Benefit Programs and HMIS portals to start integration with HFR:
Sandbox.abdm.gov.in

● Documentation of APIs for integration with HFR:

https://sandbox.abdm.gov.in/static/media/HFR%20Registration%20APIs.b5be38c8.pdf

● Swagger link for Benefit Programs and HMIS portals to start integration with HFR:
https://facilitysbx.abdm.gov.in/swagger-ui.html

● Grievance Portal : https://grievance.abdm.gov.in/

● Call Center : 1800-11-4477

18
 .
Thank You