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 two main workflows: registering Healthcare Professionals (HPR) and managing Health Facilities (HFR) .

​
1. Healthcare Professional Registry (HPR)

This workflow guides a doctor or nurse through creating their unique HPR ID via Aadhaar-based verification.
1

Aadhaar Authentication

Initiate the process by sending an OTP to the professional’s Aadhaar-linked mobile number. Verify the OTP to establish identity. APIs: nhpr/v1/hpr/aadhaar/init & nhpr/v1/hpr/aadhaar/verify
2

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. API: nhpr/v1/hpr/aadhaar/demo/verify
3

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. API: nhpr/v1/hpr/aadhaar/check/exist
4

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. API: nhpr/v1/hpr/aadhaar/suggest
5

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. API: nhpr/v1/hpr/aadhaar/create

​
2. Health Facility Registry (HFR)

This workflow focuses on managing physical institutions. You must follow this sequence to ensure data integrity. It checks if the facility already exists in the registry.

Search Facility API

GET /nhpr/v1/hfr/search/{hfrId}

​
2. Onboard Facility

This endpoint is used to onboard the Facility. This requires submitting official details such as the facility name, physical address, and the authorizing doctor’s OID.

Onboard Facility API

POST /nhpr/v1/hfr/onboard
 Once a facility is identified or onboarded, it must be connected to the ABDM Bridge software. This linkage allows the facility to exchange health data and participate in the digital health network securely.

Link Facility API

POST /nhpr/v1/hfr/link