Developer Portal
Build integrations, automate workflows, and manage tenant-aware healthcare data with the IdeaDunes API suite.
Module surface reachable via integrations
Role journeys supported by APIs
Commercial and partner motions
Cloud, on-prem, and rollout models
Integration Readiness
Beyond the public reference examples, the connected product ecosystem already maps APIs and standards for claims, government programs, interoperability, automation, and partner-led deployment across 17 market tracks.
Clinical interoperability for patient, encounter, lab, imaging, and document flows.
Supports claim automation, eligibility, reimbursement, and revenue-cycle connectivity.
ABDM, DHIS2, NHS, GCC payer rails, and public-health reporting pathways.
Role-aware access, audit trails, privacy controls, and policy-ready evidence.
Reseller, embedded, multi-tenant, and ecosystem rollout capabilities.
Webhook, workflow, communications, and event-driven operational integrations.
The IdeaDunes Healthcare API is a RESTful JSON API that enables programmatic access to all platform capabilities. Use it to integrate IdeaDunes with your existing systems, build custom workflows, or create third-party applications.
https://api.ideadunes.com/v1All API requests must be authenticated using Bearer tokens (JWT). Obtain tokens via the OAuth 2.0 flow or API key authentication.
X-Tenant-Id, X-Branch-Id, and for write operations an Idempotency-Key. Role-sensitive flows may also include X-Actor-Role and X-Device-Id for audit-safe traceability.// Request
POST /auth/token
Content-Type: application/json
{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"grant_type": "client_credentials"
}
// Response
{
"access_token": "eyJhbGciOiJSUzI1Ni...",
"token_type": "Bearer",
"expires_in": 3600
}
// Using the token
GET /v1/patients
Authorization: Bearer eyJhbGciOiJSUzI1Ni...
X-Tenant-Id: paras-hospital
X-Branch-Id: main-campus
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/patients | List patients (paginated, filterable) |
| GET | /v1/patients/{id} | Get patient by ID |
| POST | /v1/patients | Create new patient |
| PUT | /v1/patients/{id} | Update patient record |
| GET | /v1/patients/{id}/encounters | Patient encounter history |
| GET | /v1/patients/{id}/billing | Patient billing history |
| GET | /v1/patients/search | Search patients (name, MRN, phone) |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/appointments | List appointments (date range, provider, status) |
| POST | /v1/appointments | Book appointment |
| PUT | /v1/appointments/{id} | Reschedule / update |
| DELETE | /v1/appointments/{id} | Cancel appointment |
| GET | /v1/appointments/slots | Available time slots for provider |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/encounters | List OPD, IPD, emergency, and telehealth encounters |
| POST | /v1/encounters | Create a new visit or admit workflow event |
| PUT | /v1/encounters/{id} | Update diagnosis, notes, disposition, and care stage |
| GET | /v1/encounters/{id}/timeline | View full patient journey, orders, documents, and audit events |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/invoices | List invoices |
| POST | /v1/invoices | Create invoice |
| POST | /v1/payments | Record payment |
| POST | /v1/claims | Submit insurance claim |
| GET | /v1/revenue/summary | Revenue summary & analytics |
The platform supports document capture, printer queues, barcode workflows, scanner ingestion, kiosk sync, device registration, and hybrid offline-first operational patterns.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/documents/upload | Upload patient, consent, MRD, invoice, or identity documents |
| GET | /v1/documents/{id} | Fetch document metadata and signed access URL |
| POST | /v1/devices/register | Register printers, barcode devices, scanners, kiosks, or bedside tablets |
| GET | /v1/devices | List connected devices by tenant, branch, and module |
| POST | /v1/print-jobs | Queue prescription, label, bill, receipt, or discharge print jobs |
| POST | /v1/sync/offline-batch | Push offline-collected events and form state back to the tenant server |
Every tenant, facility, and partner rollout can manage plan tiers, usage, enabled modules, add-on services, billing cycles, and service entitlements through dedicated endpoints.
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/tenants | List tenants, facilities, branches, and deployment state |
| POST | /v1/tenants | Create a new tenant or onboard a new facility group |
| PUT | /v1/tenants/{id} | Update branding, locale, plan, modules, and security profile |
| GET | /v1/tenants/{id}/subscriptions | Retrieve current plan, renewal date, usage, and add-on status |
| POST | /v1/subscriptions/change-plan | Upgrade or downgrade plan tier with proration support |
| POST | /v1/addons/activate | Enable AI, compliance, hardware, migration, support, or white-label bundles |
The API surface spans front-office, clinical, finance, operations, and commercialization workflows so each major module can be integrated without relying on manual exports.
| Module | Representative endpoints | Use cases covered |
|---|---|---|
| OPD / IPD / ER | /v1/encounters, /v1/admissions, /v1/triage | Registration, queue, admission, handoff, and discharge coordination |
| Lab & Diagnostics | /v1/lab/orders, /v1/lab/results, /v1/radiology/studies | Order placement, sample tracking, verified results, PACS/report delivery |
| Pharmacy | /v1/prescriptions, /v1/pharmacy/dispense, /v1/pharmacy/stock | Medication orders, dispensing, refills, batch expiry, stock reconciliation |
| Billing & Claims | /v1/invoices, /v1/payments, /v1/claims, /v1/preauth | Cash, package, TPA, scheme, and reimbursement workflows |
| Inventory & Procurement | /v1/items, /v1/purchase-orders, /v1/goods-receipts | Consumables, reorder rules, vendors, GRN, and store transfers |
| HR & Duty Rosters | /v1/staff, /v1/attendance, /v1/shifts | Roster sync, leave, attendance, and department staffing insight |
| Compliance & Audit | /v1/audit/events, /v1/compliance/checklists, /v1/consents | Consent, policy traceability, readiness evidence, and inspections |
| Tenant Commerce | /v1/tenants, /v1/subscriptions, /v1/addons, /v1/service-orders | Plan packaging, activation, billing cycles, support bundles, white-label rollout |
Below are common request shapes for the most-used records across patient registration, appointment routing, and tenant subscription management.
POST /v1/patients
{
"tenant_id": "paras-hospital",
"branch_id": "main-campus",
"uhid": "UH2025-00142",
"name": "Aarav Mehta",
"gender": "male",
"dob": "1987-11-12",
"mobile": "+91-98XXXXXX10",
"abha_id": "14-xxxx-xxxx-2211",
"consent_status": "granted",
"address": {
"city": "Pune",
"state": "Maharashtra"
}
}
POST /v1/subscriptions/change-plan
{
"tenant_id": "paras-hospital",
"plan_code": "enterprise-plus",
"billing_cycle": "annual",
"users": 220,
"addons": [
"ai-assistant",
"abdm-connect",
"implementation-hypercare"
],
"effective_from": "2026-01-01",
"approved_by": "finance-head"
}
AI actions and operator events stay tenant-scoped, auditable, and role-aware. The API model reflects assistant prompts, recommendation logs, approvals, escalations, and provenance records.
/v1/ai/context returns the active patient, tenant, role, visit, and data-trust state used to power context-aware suggestions.
/v1/ai/recommendations stores prompts, outputs, confidence, human approval, and follow-up action status.
/v1/audit/events records who did what, when, where, why, and under which tenant/session context.
The public docs now expose the core operational data model for patients, encounters, finance, subscriptions, devices, sync events, and audit logs.
| Entity | Key fields | Purpose |
|---|---|---|
| patients | tenant_id, uhid, abha_id, name, gender, dob, phone, consent_status | Master patient identity and demographics |
| encounters | patient_id, doctor_id, encounter_type, visit_status, diagnosis_code, notes | OPD, IPD, emergency, telemedicine, and clinical events |
| appointments | patient_id, provider_id, slot_time, queue_no, channel, reminder_status | Booking, waitlist, reminders, and follow-ups |
| subscriptions | tenant_id, plan_code, billing_cycle, seats, addons, renewal_at | Commercial packaging, entitlements, and renewal control |
| devices | tenant_id, device_type, serial_no, driver_profile, branch_id, health_status | Printers, scanners, kiosks, barcode devices, and tablets |
| audit_events | tenant_id, actor_id, module, action, entity_type, entity_id, ip, created_at | Security, AI, workflow, and compliance traceability |
Subscribe to real-time events via webhooks. Configure webhook URLs in your dashboard settings.
| Event | Description |
|---|---|
patient.created | New patient registered |
appointment.booked | Appointment scheduled |
appointment.cancelled | Appointment cancelled |
encounter.completed | Doctor visit completed |
invoice.created | Invoice generated |
payment.received | Payment posted |
lab.result.ready | Lab result available |
prescription.created | New prescription issued |
| Plan | Rate Limit | Burst |
|---|---|---|
| Starter | 100 requests/min | 20 requests/sec |
| Clinic | 500 requests/min | 50 requests/sec |
| Hospital | 2,000 requests/min | 100 requests/sec |
| Enterprise | Custom (unlimited) | Custom |
70,000+ facilities
ABDM, PM-JAY, RGHS, NHM, multi-tier provider digitization
1,200+ hospitals
DHA, HAAD, NPHIES, Riayati, Arabic-ready workflows
12,000+ facilities
DHIS2, NHIF/SHIF, NHIA, offline-first operations
7,000+ hospitals
SATUSEHAT, BPJS, PhilHealth, MyHIX, multilingual scale
1,229 hospitals
NHS integration, DTAC, UK GDPR, GP-facing workflows
6,100+ hospitals
HIPAA, HITECH, Medicare/Medicaid, specialty automation
Node.js SDK
npm install @ideadunes/sdk
Python SDK
pip install ideadunes
PHP SDK
composer require ideadunes/sdk
Get Started Today
Join hundreds of hospitals and clinics using IdeaDunes to streamline operations, improve patient care, and grow revenue. Start your free trial — no credit card required.
No credit card required • Free onboarding • Cancel anytime
Role Quick Start
Executives, hospital teams, partners, government buyers, and patient-facing users can jump directly to their correct next step from anywhere in the web experience.