ABDM HIP Initiated Linking

Overview

HIP (Health Information Provider) Initiated Linking happens automatically in NICE HMS. There is no manual button to click — whenever a doctor finalizes a clinical document, the system registers the care context with ABDM and the data flows immediately to the patient's PHR app.

In plain terms: every time you finalize an OPD consultation, prescription, discharge summary, or diagnostic report, NICE HMS quietly links that encounter to the patient's ABHA in the background. No extra steps needed.

How It Works

HIP-initiated linking runs automatically inside the clinical document finalization flow:

1. Doctor finalizes a clinical document (OPD consultation, prescription, discharge summary, etc.).
2. NICE HMS checks if the patient has an ABHA address — if not, nothing happens.
3. NICE HMS checks if the facility has ABDM integration enabled (ABDMFacilityId) — if not, nothing happens.
4. A link token is generated (or reused if one already exists for the patient).
5. For new documents: the encounter is registered as a care context with ABDM (addCareContext).
6. A notification is sent to ABDM (notify) — the data flows to the patient's PHR app automatically and immediately.

No manual intervention. No patient approval step. Data flows directly.

When It Triggers

HIP-initiated linking fires automatically when these clinical documents are finalized (both create and edit). Each triggers addCareContext + notify — the ABDM API is idempotent, so re-registering is safe.

• OPD Consultation Record
• Prescription Record
• Discharge Summary
• OP Procedure Record
• Letter Consultation
• Diagnostic Report
• Wellness Record
• Health Document
• Immunization Record

Invoice is the exception — it requires the user to explicitly press Send to ABDM from the invoice page. It uses a dedicated endpoint (ndhm/invoice-record/create) rather than the automatic document finalization flow.

Prerequisites

For HIP-initiated linking to work automatically:

• The patient must have an ABHA address linked to their NICE HMS record. See ABDM Health ID.
• Your facility must be registered with ABDM and configured with an ABDMFacilityId. See ABDM Setup.

If either is missing, the linking is silently skipped — no errors, no interruptions to the clinical workflow.

What Is a Care Context?

A care context is a patient interaction at your facility that becomes discoverable on the ABDM network:

• OPD visits (each encounter is a care context)
• IPD admissions
• Prescriptions
• Discharge summaries
• Diagnostic reports
• Procedure records

Each finalized clinical document creates or updates a care context tied to the patient's ABHA.

Discovery (Patient-Initiated) Linking

This is the reverse flow — the patient initiates linking from their PHR app:

1. Patient opens their ABHA/PHR app and searches for their records at your facility.
2. ABDM sends a discovery request to NICE HMS.
3. NICE HMS matches the patient and returns available care contexts.
4. Patient approves the linking from their PHR app.
5. Data flows automatically to the PHR app.

This flow does not require any action from the hospital. NICE HMS handles the discovery callback automatically.

FAQ

Q: Do I need to do anything to enable HIP-initiated linking? A: No. It happens automatically when clinical documents are finalized, as long as the patient has an ABHA address and your facility has ABDM configured.

Q: What if linking fails? A: The clinical workflow continues uninterrupted. The document is still saved. Linking failures are logged for troubleshooting.

Q: Does the patient need to approve anything? A: No. With HIP-initiated linking, data flows directly and immediately to the patient's PHR app.

Q: Can a patient link from their PHR app instead? A: Yes. This is called discovery (patient-initiated) linking. The patient searches for your facility in their ABHA app and approves the linking from their side. NICE HMS handles this automatically.