diff --git a/.gitignore b/.gitignore index 13d99561..d834f808 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -.DS_Store +git .DS_Store .idea/ .venv .venv/* +node_modules diff --git a/docs.json b/docs.json index da08311f..5b76ec5d 100644 --- a/docs.json +++ b/docs.json @@ -29,14 +29,50 @@ "tab": "Documentation", "groups": [ { - "group": "Eka Care Developer API guide", + "group": "Eka Overview", + "pages": [ + "user-guides/get-started", + "user-guides/eka-products" + ] + }, + { + "group": "Product Details", "pages": [ - "introduction", - "abdm-connect", - "getting-started", - "communication-flow-appointment-clinical-events" - ] - } + { + "group": "Core-EMR", + "pages": [ + "integrations/core-emr/patients", + "integrations/core-emr/doctor", + "integrations/core-emr/appointments", + "integrations/core-emr/clinic", + "integrations/core-emr/payments", + "integrations/core-emr/prescription", + "integrations/core-emr/medical-db", + "integrations/core-emr/medical-document-parsing" + ] + }, + { + "group": "Health AI", + "pages": [ + "integrations/health-ai/assessments", + "integrations/health-ai/ekascribe", + "integrations/health-ai/medassist" + ] + }, + { + "group": "Interoperability", + "pages": [ + "integrations/interoperability/abdm" + ] + }, + { + "group": "MCP", + "pages": [ + "integrations/mcp/mcp" + ] + } + ] + } ] }, { @@ -1052,13 +1088,8 @@ ] } ] - }, - { - "anchor": "Developer Discord", - "href": "https://discord.gg/THgd5S22EK", - "icon": "discord", - "iconType": "brands" } + ] }, "logo": { @@ -1070,6 +1101,13 @@ { "label": "Support", "href": "https://discord.gg/THgd5S22EK" + }, + { + "label": "Developer Discord", + "anchor": "Developer Discord", + "href": "https://discord.gg/THgd5S22EK", + "icon": "discord", + "iconType": "brands" } ], "primary": { diff --git a/images/EkascribeProductBasedOnBusinessModelAndIntegrationDecision.png b/images/EkascribeProductBasedOnBusinessModelAndIntegrationDecision.png new file mode 100644 index 00000000..736b7824 Binary files /dev/null and b/images/EkascribeProductBasedOnBusinessModelAndIntegrationDecision.png differ diff --git a/images/ekascribe-integration-flow.png b/images/ekascribe-integration-flow.png new file mode 100644 index 00000000..f50c0085 Binary files /dev/null and b/images/ekascribe-integration-flow.png differ diff --git a/integrations/core-emr/appointments.mdx b/integrations/core-emr/appointments.mdx new file mode 100644 index 00000000..deb59431 --- /dev/null +++ b/integrations/core-emr/appointments.mdx @@ -0,0 +1,19 @@ +## Appointment + +An Appointment is a scheduled meeting between a patient and a doctor. Appointment details include identifiers, participant information, location, timing, and status. + +### Key Fields: + +- **appointment_id** (string): Unique identifier for the appointment +- **doctor_oid** (string): Unique identifier for the doctor +- **patient_oid** (string): Unique identifier for the patient +- **clinic_id** (string): Unique identifier for the clinic +- **status** (string): Status of the appointment (e.g., CM - Completed, BK - Booked) +- **start_time** (datetime): Start time of the appointment +- **end_time** (datetime): End time of the appointment +- **payment** (object): Payment details for the appointment + +Read more : ([API Reference - Appointment](https://developer.eka.care/api-reference/doc-tool/Actors/actors)) section. + +Read more : ([API Reference - communication-flow-appointment-clinical-events ](/communication-flow-appointment-clinical-events)) section. + diff --git a/integrations/core-emr/clinic.mdx b/integrations/core-emr/clinic.mdx new file mode 100644 index 00000000..a04faabe --- /dev/null +++ b/integrations/core-emr/clinic.mdx @@ -0,0 +1,12 @@ +## Clinic + +A Clinic is a healthcare facility where doctors provide medical services. Clinic profiles include name, address, contact information, specialties, and operating hours. + +### Key Fields: + +- **id** (string): Unique identifier for the clinic +- **name** (string): Name of the clinic +- **address** (object): Clinic's address details +- **contacts** (array): Contact information for the clinic + +Read more : ([API Reference - Clinic](https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/getting-started)) section. \ No newline at end of file diff --git a/integrations/core-emr/doctor.mdx b/integrations/core-emr/doctor.mdx new file mode 100644 index 00000000..832700ce --- /dev/null +++ b/integrations/core-emr/doctor.mdx @@ -0,0 +1,12 @@ +## Doctor + +A Doctor is a medical professional registered on the Eka platform. Doctor profiles include personal details, professional credentials, clinic associations, and availability for appointments. + +### Key Fields: + +- **id** (string): Unique identifier for the doctor +- **profile** (object): Contains personal and professional information + - **personal** (object): Doctor's personal details (name, DOB, gender) + - **professional** (object): Doctor's professional information (specialties, degrees, clinics) + +Read more : ([API Reference - Doctor](https://developer.eka.care/api-reference/doc-tool/doctor-and-clinic-api/getting-started)) section. \ No newline at end of file diff --git a/integrations/core-emr/medical-db.mdx b/integrations/core-emr/medical-db.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/core-emr/medical-db.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/core-emr/medical-document-parsing.mdx b/integrations/core-emr/medical-document-parsing.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/core-emr/medical-document-parsing.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/core-emr/patients.mdx b/integrations/core-emr/patients.mdx new file mode 100644 index 00000000..82aa9cd3 --- /dev/null +++ b/integrations/core-emr/patients.mdx @@ -0,0 +1,16 @@ +## Patient + +A Patient is an individual who receives medical care and services. Patient profiles contain personal information, medical history, and other relevant data. + +### Key Fields: + +- **patient_id** (string): Unique identifier for the patient, created upon registration +- **first_name** (string): Patient's first name +- **last_name** (string): Patient's last name +- **dob** (date): Patient's date of birth (YYYY-MM-DD) +- **mobile** (string): Patient's mobile phone number +- **gender** (string): Patient's gender (e.g., M, F) +- **address** (object): Patient's address details (optional) +- **metadata** (object): Additional patient information like UHID, Blood Group, medical history (optional) + +Read more : ([API Reference - Patients](https://developer.eka.care/api-reference/doc-tool/Actors/actors)) section. \ No newline at end of file diff --git a/integrations/core-emr/payments.mdx b/integrations/core-emr/payments.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/core-emr/payments.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/core-emr/prescription.mdx b/integrations/core-emr/prescription.mdx new file mode 100644 index 00000000..9cd0b25c --- /dev/null +++ b/integrations/core-emr/prescription.mdx @@ -0,0 +1,17 @@ +## Prescription + +A Prescription is a medical document provided by a doctor to a patient, including prescribed medications, dosage instructions, and other treatment recommendations. + +### Key Fields: + +- **rx_id** (string): Unique identifier for the prescription +- **visit_id** (string): Unique identifier for the associated visit +- **doctor** (object): Details of the prescribing doctor +- **patient** (object): Details of the patient +- **rx_entities** (object): Contains symptoms, diagnosis, medications, and lab tests + - **symptoms** (array): List of reported symptoms + - **diagnosis** (array): List of diagnoses made + - **medications** (array): List of prescribed medications + - **labTests** (array): List of prescribed lab tests + +Read more : ([API Reference - Prescription](https://developer.eka.care/api-reference/doc-tool/prescription-api/get-prescription-details)) section. \ No newline at end of file diff --git a/integrations/health-ai/assessments.mdx b/integrations/health-ai/assessments.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/health-ai/assessments.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/health-ai/ekascribe.mdx b/integrations/health-ai/ekascribe.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/health-ai/ekascribe.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/health-ai/medassist.mdx b/integrations/health-ai/medassist.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/health-ai/medassist.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/integrations/interoperability/abdm.mdx b/integrations/interoperability/abdm.mdx new file mode 100644 index 00000000..127d7212 --- /dev/null +++ b/integrations/interoperability/abdm.mdx @@ -0,0 +1,4 @@ +## ABDM CONNECT + + +Read more : ([API Reference - abdm-connect](/abdm-connect)) section. \ No newline at end of file diff --git a/integrations/mcp/mcp.mdx b/integrations/mcp/mcp.mdx new file mode 100644 index 00000000..66e78dd7 --- /dev/null +++ b/integrations/mcp/mcp.mdx @@ -0,0 +1,3 @@ +## Work in progress + +WIP \ No newline at end of file diff --git a/snippets/snippet-intro.mdx b/snippets/snippet-intro.mdx deleted file mode 100644 index c57e7c75..00000000 --- a/snippets/snippet-intro.mdx +++ /dev/null @@ -1,4 +0,0 @@ -One of the core principles of software development is DRY (Don't Repeat -Yourself). This is a principle that apply to documentation as -well. If you find yourself repeating the same content in multiple places, you -should consider creating a custom snippet to keep your content in sync. diff --git a/styles.css b/styles.css new file mode 100644 index 00000000..15db4ada --- /dev/null +++ b/styles.css @@ -0,0 +1,19 @@ +.eka-card-wrapper { + border-radius: 14px; + transition: transform 0.15s ease; +} + +.eka-card-wrapper:hover { + transform: translateY(-3px); +} + +.eka-card-wrapper:hover > * { + box-shadow: 0 12px 28px rgba(80, 66, 189, 0.22); + border-color: #5042BD; +} + +.eka-divider { + border: none; + border-top: 1px solid rgba(80, 66, 189, 0.25); + margin: 48px 0; +} \ No newline at end of file diff --git a/user-guides/eka-products.mdx b/user-guides/eka-products.mdx new file mode 100644 index 00000000..56bebc22 --- /dev/null +++ b/user-guides/eka-products.mdx @@ -0,0 +1,141 @@ +--- +title: Eka Products +description: Explore all Eka platform products across Core EMR, Health AI, Interoperability, and MCP. +--- + +import { Columns, Card } from '@mintlify/components' + +
+ + +

Core EMR

+ + +
+ +

+ Patient profiles, demographics, medical history, and longitudinal records. +

+ +
+ +
+ +

+ Clinical workflows, charting tools, and physician productivity features. +

+ +
+ +
+ +

+ Scheduling and appointment lifecycle management. +

+ +
+ +
+ +

+ Clinic setup, configuration, staff, and operations. +

+ +
+ +
+ +

+ Billing, invoices, and payment tracking. +

+ +
+ +
+ +

+ Medication orders and prescription workflows. +

+ +
+ +
+ +

+ Standardized medical knowledge base. +

+ +
+ +
+ +

+ Extract structured data from clinical documents. +

+ +
+ + +--- + +

Health AI

+ + +
+ +

+ AI-powered clinical and health risk assessments. +

+ +
+ +
+ +

+ Ambient clinical documentation using voice. +

+ +
+ +
+ +

+ AI assistance for clinical decision support. +

+ +
+ + +--- + +

Interoperability

+ + +
+ +

+ India’s ABDM integrations for consent-based health data exchange. +

+ +
+ + +--- + +

MCP

+ + +
+ +

+ Infrastructure for AI-native healthcare workflows and agents. +

+ +
+ diff --git a/user-guides/get-started.mdx b/user-guides/get-started.mdx new file mode 100644 index 00000000..b3e72a99 --- /dev/null +++ b/user-guides/get-started.mdx @@ -0,0 +1,101 @@ +--- +title: Get Started +description: SIGN UP. BUILD. DEPLOY. 🚀 +--- + +import { Columns, Card } from '@mintlify/components' + +
+ +--- +

Eka Connect

+ + + + **STEP 1: Sign Up for an API Key** + + To get started, you need to sign up for an API key. This key will authenticate your requests and give you access to our API. Ping us and we will provide you with the required API Keys. + + **Pre-requisites** + +
+ +

+ A unique identifier assigned to a third-party application interacting with Eka's API. +

+ +
+ +
+ +

+ It is a confidential key, similar to a password used alongside the Client ID. +

+ +
+ + + **Obtain the Client ID and Client Secret** + + - Login to your Eka Care Control Panel at [Console](https://console.eka.care) and create client_id and client_secret + - If you’re building an app for doctors or patients, you can either integrate Eka Accounts using end-to-end OIDC or request an API key from your healthcare provider’s workspace for access. [Hub](https://hub.eka.care/account/account/apitoken/) + - For support or more details, contact us at ekaconnect@eka.care + + **STEP 2: Set Up Your Environment** + + Before making API calls, ensure your environment is properly set up. We recommend using the following tools and libraries: + - HTTP Client: Use tools like Postman, cURL, or any HTTP client library in your preferred programming language. + - Base URL: All API requests should be directed to https://api.eka.care + + + Eka Connect’s API authentication securely verifies users and applications, ensuring only authorized access to sensitive healthcare data. + + **How to Authenticate with EKA’s API** + + 1. Short Lived Token + + +
+ +

+ Authenticate your app using the login API with your Client ID and Client Secret to receive the required access tokens. +

+ +
+ +
+ +

+ Pass the access token in the Authorization header with each API request to confirm your app’s access to Eka services. +

+ +
+ +
+ +

+ Access tokens expire for security reasons and return a 401 Unauthorized error, use the Refresh Token API to generate a new access token. +

+ +
+ + + - **Access Token**: A short-lived token (usually 30 minutes) sent with each API request to authorize your app, refreshed using the Refresh Token API.([Access Token API](https://developer.eka.care/api-reference/authorization/client-login)) + - **Refresh Token**: A longer-lived token that helps you get a new Access Token when the old one expires, without having to log in again. ([Refresh Token API](/api-reference/authorization/refresh-token-v2)) + + 2. Long Lived Token : ([Long Lived Token](https://developer.eka.care/api-reference/authorization/getting-started)) section. + + + + We recommend reviewing our products before starting integration and selecting the one that best fits your use case. + + See you in the ([Eka Products](/user-guides/eka-products)) section. + + +