Skip to main content

Milestones

ABDM integration is divided into milestones. These cover creation and verification of ABHA, linking of health records with an ABHA Address, consent-based exchange of health records, and native registration through the National Healthcare Professionals Registry. Integrators should implement the milestones applicable to their software.

In short​

Three workflows sit on top of the milestones and start at your counter QR code. Scan and Register belongs to M1, Patient record share to M3 and Scan and Pay to M2. All are under Use cases.

M2 needs a facility ID and registration in the HIP role before it can share a record. That ID does not have to come from M4. A facility can be registered by hand on the NHPR portal, and many products do exactly that and never build M4. Build M4 when you want to register facilities or professionals from your own software instead. Either way, get the facility ID early, because M2 cannot be tested end to end without one.

One patient, four milestones​

Meera arrives at your clinic. Each card below is one thing your system has to be able to do for her, and one milestone that gives you it.

  1. Milestone 1 · IdentityRegister Meera's ABHA

    Meera walks in without a health ID. Create her ABHA so every record from today onwards links to one identity.

    Build M1
  2. Milestone 2 · Health Information ProviderAttach today's visit to her ABHA

    Her consultation note and her blood test are yours to hold. Group them into care contexts, link them to her ABHA address, and answer when her app comes looking.

    Build M2
  3. Milestone 3 · Health Information UserRetrieve the scan from another hospital

    Meera mentions a scan done last year, somewhere else. Ask her for consent, wait for her answer, then fetch and decrypt what she granted.

    Build M3
  4. Milestone 4 · Registry IntegrationEnrol the clinic and its doctors

    None of the above leaves sandbox until the clinic is a registered facility and its doctors hold professional IDs. Enrol both, then link your software to the facility.

    Build M4

The same story from Meera's own app​

Building the patient's app (PHR)? Implement the applicable ABHA and PHR services to allow individuals to manage their ABHA details, discover and link health records, and manage consent for sharing health information. The work splits into three, and each part mirrors a milestone on the provider side.

  1. PHR 1 · Identity and profileMeera signs up and holds her own profile

    She registers with a mobile number or an existing ABHA number, logs in four different ways, and manages her card, her QR code and her family members.

    Build P1
  2. PHR 2 · Linking and recordsShe finds records she never linked

    She searches for the hospital she visited last year, sees what it holds, verifies by one time password, and pulls those care contexts onto her ABHA address.

    Build P2
  3. PHR 3 · Consent and notificationsShe decides who sees what

    A clinic asks for her records. She reads the request, narrows it, grants or denies it, and revokes it later. Your app tells her each time.

    Build P3

Select milestones based on the requirement of your software​

The milestones required for integration depend on the role of the software. A Health Information Provider holds health records and makes them available for consent-based sharing. A Health Information User requests access to health records after obtaining the individual's consent. A software application may perform one or both roles. Applicable milestones depend on the functions and services offered.

Who you build forM1M2M3M4
Health Facility or Health Facility Software. May create and verify ABHA, link and share health records, access records with consent, and support NHPR registration.RequiredThe bulk of your buildWhere it also reads records it did not createRequired
Health Information User, such as an insurer, a referral service or an analytics service. May request and view health records held by another entity after receiving the individual's consent.RequiredNot neededThe bulk of your buildConfirm at onboarding
Personal Health Record Application. Enables individuals to manage their ABHA details, discover and link health records, and control consent for sharing them.P1, the patient sideP2, the patient sideP3, the patient sideNot needed

What each milestone gets you​

MilestoneWhat you getWho needs it
M1 Identity: ABHA Creation and VerificationIdentity and the session tokenEveryone
M2 Health Information Provider: Health Information Provider ServicesLinking and sharing recordsA facility publishing records, and a citizen pushing their own
M3 Health Information User: Health Information User ServicesConsent and record fetchingAnyone reading records they did not create, and every PHR app
M4 Registry Integration: National Healthcare Providers RegistryA facility ID and professional registrationAnyone going live as a facility

These pages give the steps, the order to build them in and the failure modes. Every request URL, header and body sits on the API reference pages, one page per call.

Next​

Start with M1 Identity, or read Go live for what happens after the fourth certificate.