Skip to main content
Eka Care
Previewv0.1.0
157 actions · 31 events · 3 auth methods

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · Long-Lived Access Token

Long-lived workspace token from the Eka Developer Console. No refresh needed. Bound to a single workspace.

Connector Profile · Client Credentials

Requires an API client from the Eka Developer Console. Tokens are short-lived and renewed automatically. Optional Sharin…

Connector Profile · Eka Sign-In (OIDC)

Delegated access as a signed-in Eka user via OpenID Connect. Requires a client with a registered redirect URI. Untested…
Optionally, configure receiving Events for Eka Care into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · Long-Lived Access Token

Link Account · Client Credentials

Link Account · Eka Sign-In (OIDC)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
157 actions
Action
Description
Discover Unlinked Care-contexts
ABDM allows a user to find their health records from any health facility they have visited via the discovery process.
Confirm Linking
Confirm linking for discovered care context. Confirm Linking operation of the ABDM (Ayushman Bharat Digital Mission) API…
Initialise Linking
Initialise the linking for discovered care context.
Get Linked Providers
Get Linked Providers operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/v1/care-contexts/providers)…
Get Linked CareContexts
Get Linked CareContexts operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/v1/care-contexts/linked)…
Get Status
Fetch the auto approval policy settings. Get Status operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /ab…
Update Auto Approval Policy
Update the auto approval policy settings. Update Auto Approval Policy operation of the ABDM (Ayushman Bharat Digital Mis…
Consent Approve
This endpoint is used to approve the consent. Consent Approve operation of the ABDM (Ayushman Bharat Digital Mission) AP…
Consent Create
Consent Create operation of the ABDM (Ayushman Bharat Digital Mission) API (POST /abdm/v1/consents/create) — creates the…
Consent Deny
This endpoint is used to deny the consent. Consent Deny operation of the ABDM (Ayushman Bharat Digital Mission) API (POS…
Consent Details
Consent Details operation of the ABDM (Ayushman Bharat Digital Mission) API (POST /abdm/v1/consents/details).
Consent List
Consent List operation of the ABDM (Ayushman Bharat Digital Mission) API (POST /abdm/v1/consents/list) — lists the match…
Consent Revoke
This endpoint is used to revoke the consent. Consent Revoke operation of the ABDM (Ayushman Bharat Digital Mission) API…
Search Payers
Lists payers from the NHCX participant registry.
Search Policies
Finds a beneficiary’s policies by mobile number, ABHA number or member ID.
ABHA Card
Please cache these results locally. ABHA Card operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/v1/…
ABHA QR Code
Fetch the data for ABHA qr code display. ABHA QR Code operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /…
Profile Details
Fetches the ABHA profile of the User. Profile Details operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /…
Update Profile
Update Profile Details The API expects all the fields returned by the [Get Profiles API](/api-reference/user-app/abdm-co…
Search ABHA
Search KYCed ABHA profiles using mobile number
Does Abha Address Exist
This API endpoint allows to check whether provided health id is already present in system.
List Requests
API to list all the Subscriptions and Consent requests
Requests Get Details
Requests Get Details operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/v1/request) — retrieves the…
Generate Discharge Summary
This API uses AI to draft a discharge summary for an IPD admission of your workspace, from the patient’s details and the…
Get Admission With Visits
This API returns an IPD admission of your workspace (same as [Get Admission](/api-reference/doc-tool/ipd-api/admissions/…
List Discharge Summaries For Admission
This API returns all discharge summaries of an IPD admission of your workspace, newest first (by creation time).
List Nursing Notes For Admission
This API returns all nursing notes of an IPD admission of your workspace, newest first (by date).
Create An IPD Admission
Creates an IPD admission in your workspace. Create an IPD Admission operation of the IPD (in-patient department) API (PO…
Get An IPD Admission By Id
Fetches an IPD admission of your workspace. Get an IPD Admission by Id operation of the IPD (in-patient department) API…
List IPD Admissions
Lists your workspace’s IPD admissions, optionally filtered.
Update An IPD Admission
Updates the given fields of an admission. Update an IPD Admission operation of the IPD (in-patient department) API (PATC…
Get The Billing Summary
The account’s rollups — charges, invoiced, paid, outstanding, due, balance — also refreshed onto the admissi…
Open The Admission’s Billing Account
Finds or creates the admission’s billing account and links it to the admission.
Record A Payment
Records a payment against the account. Record a Payment operation of the IPD (in-patient department) API (POST /ipd/v1/s…
Initiate A Discharge
Moves the admission to DISCHARGE_INITIATED, records the transition, and notifies every pharmacy the admission ordered fr…
Record An Admission Event
Appends one event to the admission’s audit trail.
Book Appointment Slot
This API is used to book an appointment slot for a patient based on the available slots retrieved from the `get appointm…
Cancel Appointment
This API endpoint is used to cancel an existing appointment.
No-Show Appointment
This API endpoint is used to update an existing appointment to No-Show state.
Complete Appointment
This API endpoint is used to complete an existing appointment.
Confirm Follow-Up Appointment
This API endpoint confirms an existing follow-up appointment by changing its status from INITIATED to BOOKED.
Get Appointment Details
This API endpoint is used to retrieve the details of an appointment using its unique identifier.
Get Appointments
This API endpoint is used to retrieve all the appointments scheduled for a business with flexible filters.
Get Resolved Schedule
Resolves one or more entities’ schedules over a date range into concrete daily availability windows (bounds), any blac…
Parked Appointment
This API endpoint is used to update an existing appointment to parked state.
Reschedule Appointment
This API is used to reschedule an appointment.
Update Appointment V2
This API endpoint is used to update an existing appointment.
Update Appointment
This API endpoint is used to update an existing appointment.
Create Bed
This API creates a new IPD bed for your workspace.
Create Category
This API creates a new IPD category for your workspace.
Add Charges
Adds one or more charges. Add Charges operation of the IPD (in-patient department) API (POST /ipd/v1/sdk/admissions/{adm…
List Charges
The account’s charges. List Charges operation of the IPD (in-patient department) API (GET /ipd/v1/sdk/admissions/{admiss…
Create Claim
Creates the claim (the case every later call hangs off) and sends the auth-requirements check for the listed procedures.
Get Claim
Claim summary: status, payer references, turn-around deadlines, review path, co-payment and the stages with a saved draf…
List Claims
Lists claims with their beneficiary. List Claims operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/…
Submit Claim
Submits the final claim after discharge. Submit Claim operation of the ABDM (Ayushman Bharat Digital Mission) API (POST…
Get Appointment Slots
This API is the first step in booking appointment slot for a patient at a doctor’s clinic
Get Clinic Details
This API endpoint retrieves detailed information about a specific clinic using its unique identifier.
Get Clinic By ID
Retrieve a single clinic’s details using either the Eka ID or the partner-provided ID.
List Clinics
Retrieve a list of all clinics registered for your business.
Create Clinic
The Create Clinic API allows you to register a new clinic for your business, including its name, address, pincode, conta…
Get Service Conf Details
Fetches a single service configuration by id.
Get Service Conf List
Lists the non-archived service configurations (service-conf) for an entity.
Get Doctor By ID
Retrieve a single doctor’s profile using either the Eka ID or the partner-provided ID.
List Doctors
Retrieve a list of all doctors registered for your business.
Create Doctor Profile
Create a new doctor profile for your business.
Get Workspace Information
The Get Workspace Information API retrieves basic information about a business including the business ID and business na…
Get Clinic And Doctor Details
The Get Clinic and Doctor Details API provides a comprehensive list of clinics and doctors associated with those clinics…
Get Doctor Profile
This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier.
Create Or Update Document
Create a new document on a session (omit document_id → 201), or update an existing one (include document_id → `200…
Delete Document
Archive (soft-delete) a document. Delete Document operation of the Eka Care API (DELETE /voice/api/v1/documents/{documen…
Get Document
Fetch a document’s metadata and a presigned GET URL to download its content (markdown).
Parsed Report Result
This API is check the parsing status of the uploaded document
Get Sessions
List past sessions for the authenticated user, newest first.
List An Admission’s Events
Returns every audit event of the admission (status changes, clearances, discharge steps, pharmacy notifications, …), new…
Get Provider Details
Fetches the Providers based on the HIP ID. Get Provider Details operation of the ABDM (Ayushman Bharat Digital Mission)…
Search Providers
Fetches the List of Providers. Search Providers operation of the ABDM (Ayushman Bharat Digital Mission) API (GET /abdm/v…
Create An Invoice
Invoices the given charges (all un-invoiced charges when chargeIds is omitted), with an optional bill-level discount.
List Invoices
The account’s invoices. List Invoices operation of the IPD (in-patient department) API (GET /ipd/v1/sdk/admissions/{admi…
Get IPD Setup Data
This API returns your workspace’s IPD setup data in one call: beds, rooms, categories, rate plans, rate plan inclusions,…
Check Whether A Patient Can Be Admitted
Returns can_admit: false when the patient already has an active (AD) admission in your workspace.
Get Generic (pharmacology) Information
Get Generic (pharmacology) Information operation of the Eka Care API (GET /eka-mcp/pharmacology/v1/search) — retrieves t…
Search Medications
This endpoint returns suggested/similar drugs from the Eka medical database for the given parameters - drug name, generi…
Search Protocols
This endpoint returns pages from the protocols based on the query, publishers and tag.
Search Drugs And Laboratory Tests
This endpoint returns comprehensive information about pharmaceutical drugs and laboratory tests from the Eka medical dat…
Search Symptoms And Diagnoses
This endpoint returns comprehensive information about medical symptoms and diagnoses from the Eka medical database based…
Link Entities (Batch)
Links up to 5 free-text entities in a single call.
Link Entity
Links a single free-text medical entity to candidate codes from the requested ontology.
List Registry
Returns every ontology available for codification, the versions of each ontology, and the active indexes backing them.
Create Nursing Note
This API adds a nursing note to an IPD admission of your workspace.
Update Nursing Note
This API updates a nursing note of your workspace.
Send Notification
This API allows partners to send notifications to users.
Create Order
This API places a medicine order for an IPD admission of your workspace.
Get Order
This API returns a single medicine order of your workspace with its full detail.
List Orders
This API lists the medicine orders of your workspace, newest first.
Update Order Status
This API sets the status of a medicine order of your workspace.
List Admission Advices For Patient
This API lists the admission advices for a patient in your workspace — the times a doctor advised admission in a prescri…
Add Patient To Directory
This functionality enables the addition of new patient records to a business’ directory.
Get Patient Details By Profile Id
This API provides functionality to get details of a patient by their Eka profile id, from a business’ directory.
Search Patient Profiles By Mobile Number
This API provides functionality to get all profiles of patient by their mobile number in business’ directory.
Update Patient Details
Thi API provides functionality to update patient details for the registered patients.
Create A Patient Profile
Allows businesses to add new patient record by capturing personal, contact, and medical information.
Archive Or Permanently Delete Patient Profile
By default, the patient profile is archived (soft delete).
List Patient Profiles
Retrieves a paginated list of patient profiles.
Retrieve EMR User Profile
Retrieves an EMR user profile by OID. Retrieve EMR User Profile operation of the Eka Care API (GET /profiles/v1/emr-user…
Retrieve Patient Profile By Username
Retrieves patient profile using username in a workspace.
Retrieve Patient Profile
Retrieve Patient Profile operation of the Eka Care API (GET /profiles/v1/patient/{oid}) — retrieves the matching records…
Retrieve Patient Profiles By Mobile Number
Retrieves patient profiles using the mobile number in a workspace.
Search Patient Profiles
Global Search is exclusive to specific workspaces only.
Update EMR User Profile
Updates an EMR user profile with validated and normalized data.
Update Patient Profile Details
Payload for updating patient profile. Update Patient Profile Details operation of the Eka Care API (PATCH /profiles/v1/p…
List Payments
The account’s payments. List Payments operation of the IPD (in-patient department) API (GET /ipd/v1/sdk/admissions/{admi…
Get Claim Payments
Every payment notice the payer sent for the claim.
Check Eligibility
Checks the policy is in force and returns the wallet balance, without creating a claim.
Get Prescription Details
This API retrieves comprehensive details of a prescription created by a doctor.
Create Rate Plan
This API creates a new IPD rate plan for your workspace.
Delete Document
This API is used to delete a document using a document ID.
Upload Report
Upload the image or PDF file. Upload Report operation of the Eka Care API (POST /mr/api/v2/docs).
Create Case
This endpoint creates a new medical case. Create Case operation of the Eka Care API (POST /mr/api/v1/cases).
Delete Case
This endpoint allows deleting a case using the case ID.
Describes A Document
Once you retrieve a list of all documents with their corresponding IDs, you can use this endpoint to get more details ab…
List Cases
This endpoint returns a list of all cases. List Cases operation of the Eka Care API (GET /mr/api/v1/cases).
List Documents
To get the list of all the records for a given authenticated user.
Step 1: Upload Record
Generate a presigned URL that allows you to securely upload a document to the server.
Retrieve Health Records
Retrieve a parsed transcibes based on the given identifier
Update Case
This endpoint allows updating details of an existing medical case using the case ID.
Update Document
This API is used to update the document. Update Document operation of the Eka Care API (PATCH /mr/api/v1/docs/{id}).
Create Room
This API creates a new IPD room for your workspace.
Create Schedule
Creates a schedule for an entity_id in a location_id — entity_id is your doctor id, location_id is your clinic i…
Delete Schedule
Tears down a schedule: hard-deletes the schedule head, its config document, every product assignment row, and all v2 tim…
Update Schedule
Edits an existing schedule’s config, name, archive state, and/or its timebounds, in one call.
List Session Documents
Fetch a session’s full record — status, patient details, audio quality matrix and, most importantly, the list of all doc…
Create Session
Create a new scribing session. Create Session operation of the Eka Care API (POST /voice/v1/sessions).
End Session
Finalize the session and start asynchronous processing.
Get Session Audio
Fetch the complete recording of a session as a presigned download URL (single combined MP3).
Get Session
Retrieve the current status of a session and, once processing finishes, its transcript and structured template results.
Update Session
Update a session’s metadata before it is committed.
Upload Audio
Upload audio as a raw binary body. Upload Audio operation of the Eka Care API (POST /voice/v1/sessions/{session_id}/audi…
Exchange MedAssist Token
Exchanges a MedAssist agent ID for a short-lived session token and a refresh token.
Create Session
Creates a new MedAssist session and returns its session_id for WebSocket communication.
Get Session
Retrieves the status of a MedAssist session, optionally with its messages.
Refresh Session Token
Exchanges a MedAssist refresh token for a new sess_token and refresh_token.
Create Discharge Summary
This API saves a discharge summary for an IPD admission of your workspace.
Update Discharge Summary
This API updates the content of a discharge summary of your workspace.
Create Nursing Note Template
This API creates a nursing note template for your workspace.
List Nursing Note Templates
This API returns all nursing note templates of your workspace, newest first.
Process Template
After a session ends, generate another document from it for the given template.
Upload Transcript
Optional. Upload Transcript operation of the Eka Care API (POST /voice/api/v1/transaction/{session_id}/convert-to-templa…
Create Template
Create a custom note template. Create Template operation of the Eka Care API (POST /voice/api/v1/template).
Delete Template
Archive (soft-delete) a custom template. Delete Template operation of the Eka Care API (DELETE /voice/api/v1/template/{t…
List Templates
G. List Templates operation of the Eka Care API (GET /voice/api/v1/template).
Update Template
Update a custom template’s title or description.
Get Transaction Status
Get Transaction Status operation of the Eka Care API (GET /dr/v1/payment/transaction_status/{transaction_id}) — retrieve…
Update Patient Vitals And Link To ABHA
Update the vitals data for a specific patient using the transaction ID.
Delete A Webhook
Deletes an existing webhook based on its ID. Delete a Webhook operation of the Eka Care API (DELETE /notification/v1/con…
Get Webhooks
Retrieves all registered webhooks. Get Webhooks operation of the Eka Care API (GET /notification/v1/connect/webhook/subs…
Register Webhook
Registers a new webhook triggered by specific events.

Events

|
31 events
Event
Description
Tags
Active Check
Responds with 200 OK to any Eka Care delivery that does not carry a recognized event type.
Health Checks
Appointment Created
Fired when an appointment is booked.
Appointments
Appointment Updated
Fired when an appointment is modified.
Appointments
Appointment Status Changed
Fired when an appointment’s status changes.
Appointments
Appointment Assessment Taken
Fired when an assessment is recorded on an appointment.
Appointments
Doctor Joined Video Call
Fired when the doctor joins a video consultation.
Appointments
Appointment Reminder
Fired when an instant appointment reminder is sent.
Appointments
Follow-up Reminder
Fired when an instant follow-up reminder is sent.
Appointments
Vaccination Reminder
Fired when a vaccination reminder is due for a patient.
Appointments
Prescription Created
Fired when a prescription is created.
Prescriptions
Prescription Updated
Fired when a prescription is updated.
Prescriptions
Prescription Shared
Fired when a prescription is shared with the patient.
Prescriptions
Doctor Started Practice
Fired when a doctor starts practice.
Doctors
Doctor Stopped Practice
Fired when a doctor stops practice.
Doctors
Doctor Available for Consultation
Fired when a doctor becomes available for consultation.
Doctors
Google Review Requested
Fired when an automatic Google review request is sent to a patient.
Doctors
Google Review Requested Manually
Fired when a doctor manually sends a Google review request.
Doctors
Consent Form Created
Fired when a consent form or medical certificate is created.
Doctors
Consent Form Updated
Fired when a consent form or medical certificate is updated.
Doctors
Receipt Created
Fired when a receipt is created.
Receipts
Receipt Updated
Fired when a receipt is updated.
Receipts
Receipt Deleted
Fired when a receipt is deleted.
Receipts
Payment Link Requested
Fired when a payment link is requested for an appointment.
Receipts
IPD Admission Created
Fired when an IPD admission is created.
IPD
IPD Admission Updated
Fired when an IPD admission is updated.
IPD
IPD Admission Event Recorded
Fired when an event is recorded on an IPD admission.
IPD
IPD Admission Event Updated
Fired when an IPD admission event is updated.
IPD
IPD Discharge Clearance Created
Fired when a discharge clearance is created on an IPD admission.
IPD
IPD Discharge Clearance Updated
Fired when a discharge clearance is updated.
IPD
IPD Admission Estimate Created
Fired when a cost estimate is added to an IPD admission.
IPD
IPD Admission Estimate Updated
Fired when an IPD admission estimate is updated.
IPD