Skip to main content
This guide explains how to integrate with the National Health Provider Registry (NHPR) under the ABDM ecosystem. The integration is divided into three parts:
  1. HPR APIs — Create and manage Healthcare Professional IDs directly from your portal
  2. HFR APIs — Search, register, and link Health Facilities directly from your portal
  3. Onboarding — Register your HPR & HFR with ABDM and onboard them to the Eka system

​
1. Healthcare Professional Registry (HPR)

These APIs let you integrate HPR ID creation directly into your application, so healthcare professionals can register their digital identity without leaving your portal.
1

Aadhaar Authentication

Initiate the process by sending an OTP to the professional’s Aadhaar-linked mobile number. Verify the OTP to establish identity.
2

Verify Linked Mobile

Verify that the mobile number provided by the user matches the one linked with their Aadhaar record. This ensures the contact details are authentic.
3

Check Existing HPR ID

Check if an HPR ID already exists for the current transaction or Aadhaar profile. If it exists, you may skip creation; otherwise, proceed to generate a new ID.
4

Get ID Suggestions

If no ID exists, retrieve a list of system-suggested HPR IDs (e.g., dr.name@hpr) based on the user’s profile to help them choose a valid handle.
5

Create HPR ID

Finalize the registration by creating the HPR ID using a chosen or available handle. This generates the professional’s digital profile in the ABDM network.
HPR APIs →

​
2. Health Facility Registry (HFR)

These APIs let you integrate facility management directly into your application, so you can search, register, and link health facilities from your portal.
1

Search Facility

Check if the facility already exists in the registry before attempting to create a new one.
2

Onboard Facility

Register a new facility in the ABDM registry. This requires submitting official details such as the facility name, physical address, and the authorizing doctor’s OID.
3

Link Facility

Once a facility is identified or onboarded, connect it to the ABDM Bridge software. This linkage allows the facility to exchange health data and participate in the digital health network securely.
HFR APIs →

​
3. Onboarding to Eka

Once the HPR ID and HFR ID have been created and registered on the ABDM portal, the final step is to onboard the facility into the Eka system. This connects your ABDM-registered facility to the Eka Bridge, enabling health data exchange through EKA’s ABDM Connect.
1

Create HPR ID

Register as a Facility Manager or Healthcare Professional on the ABDM portal.
2

Register Facility (HFR ID)

Log in with your HPR ID, add facility details, upload documents, and submit for approval. Once approved, you receive the HFR ID.
3

Software Linkage

From the facility dashboard, select Software Linkage and use the Eka Bridge ID to register your facility under Eka Bridge.
4

Onboard to Eka

Call the onboard API to register the facility in the Eka system, completing the integration.
Onboarding Guide →