Skip to main content

​
In short

  • Search HFR, register the facility if absent, link it to the Eka Bridge, then onboard it to Eka.
  • The onboarding call returns the HIP ID your HMS uses on every later HIP call.
  • It is a one-time setup per facility.

​
When to use this

A facility needs to act as a Health Information Provider (HIP) through Eka. You take four steps:
  • Search the Health Facility Registry (HFR) for it.
  • Register it if it is not there.
  • Link it to the Eka Bridge.
  • Onboard it to Eka.
The last call returns the HIP ID your HMS uses on every later HIP call. This is a one-time setup per facility. If the facility was registered on the ABDM portal and linked there under Software Linkage with the Eka Bridge ID, skip to the last step.

​
Before you start

  • A bearer token for the Eka API. See Authorization.
  • The headers your integration sends on ABDM Connect calls. The three HFR operations accept X-Pt-Id, X-Partner-Pt-Id and X-Hip-Id.
  • At least one professional at the facility with an HPR ID, from Create an HPR ID with Aadhaar OTP. Registering a facility needs the authorizing doctor’s OID.
  • The facility’s HFR ID if it has one, and your own clinic_id for it.
  • The facility’s name, for the onboarding call.

​
Sequence

​
Steps

1

Search for the facility

Call Search HFR with the HFR ID in the path as hfrId. If the facility exists, the response data carries facilityId, facilityName, facilityStatus, facilityType, ownership and the address fields. Check facilityName and the address with the admin before you go on. If it exists, skip to Link.
2

Register the facility if it is absent

Call Onboard HFR. The spec gives this body only clinic_id and hfr_id. The response data carries facility_id. Keep it as the facility’s HFR ID.
3

Link the facility to the Eka Bridge

Send hfr_id and clinic_id to Link HFR. Use facilityId from Search, or facility_id from Onboard HFR, as hfr_id. The response data echoes hfr_id and clinic_id; check success is true. This connects the facility to the Eka Bridge so it can exchange health data.
4

Onboard the facility to Eka

Send hip_id and name, both required, and your clinic_id to Onboard facility. The response carries hip_id, hip_code, hip_name and scan_share_url. Save them on the facility record.

​
State you must persist

​
When it fails

Which of these codes each call returns is not yet confirmed. The codes come from the errors page, matched by meaning. Log the code you actually receive.
Errors come back as 4XX or 5XX with a body carrying code, error and source_error (code, message). Read source_error.code and look it up on the errors page.

​
Test it

The testing page has the sandbox base URL, credentials and the happy path for every journey. Run against the sandbox base URL https://api.dev.eka.care.
  • Existing facility: Search HFR returns it, Link HFR returns success true, Onboard facility returns hip_id and scan_share_url
  • New facility: Search HFR finds nothing, Onboard HFR returns facility_id, then Link and Onboard facility
  • Onboard facility without name: the call fails and your app shows the error
  • Run Onboard facility twice for the same facility