Slack US!!!

Eka Developer Platform APIs

API Reference

Blog

Dashboard

Support

This API provides functionality to get all profiles of patient by their mobile number in business' directory. 

<Note> This API only works on 10 digit mobile number and cannot be used for searching partial phone numbers. The patient with given mobile number should already be registered with business account for results to show up. </Note>


### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| mobile | string | 10 digit phone number | Patient's mobile number | Required |

### **Response parameter**

| Parameter                           | Type      | Expected Values                           | Description                                               |
| ----------------------------------- | --------- | ----------------------------------------- | --------------------------------------------------------- |
| data                                | object    |                                           | Response data object                                      |
| data.profiles                       | array     |                                           | List of patient profiles                                  |
| data.profiles[].name                | string    | "Amit Kumar"                              | Patient's full name                                       |
| data.profiles[].patient_id          | string  | "123456789012345"                        | Unique identifier for the patient (can be null)           |
| data.profiles[].patient_profile     | object    |                                           | Detailed patient profile information                      |
| data.profiles[].patient_profile.created_at | string    | "2024-08-13T07:31:53.750Z"               | Timestamp of profile creation                             |
| data.profiles[].patient_profile.dob | string    | "1990-05-15"                              | Patient's date of birth                                   |
| data.profiles[].patient_profile.first_name | string    | "Amit"                                  | Patient's first name                                      |
| data.profiles[].patient_profile.middle_name | string    | ""                                       | Patient's middle name (can be empty)                      |
| data.profiles[].patient_profile.last_name | string    | "Kumar"                                 | Patient's last name                                       |
| data.profiles[].patient_profile.gender | string    | "M" / "F" / "O"                                  | Patient's gender                                          |
| data.profiles[].patient_profile.mobile | string    | "+919876543210"                           | Patient's mobile number                                   |
| data.profiles[].patient_profile.patient_id | string \| null | "123456789012345"                     | Unique identifier for the patient (can be null)           |
| status_code                         | integer   | 200                                       | HTTP status code of the response                          |
| success                             | boolean   | true                                      | Indicates if the request was successful                   |

**Status Codes**

• 200: Success

• 403: Patient/Business data missing

• 500: Wrong API URL/Wrong JSON request/ Something went wrong

Search Patient profiles by mobile number

Test Patient

Test PT 2

Data2

Patient

PatientProfile1

200OK2

Welcome to the documentation of Eka developer platform APIs

Overview

Getting Started

Authorization APIs to get access and refresh token

Get new Authorization token using the refresh token

Refresh Token

🚀 Getting Started

❗️Error Codes

This API is used to initialize the assessment. It returns the hash that is used to continue the assessment. <Warning>This API must be called before starting the assessment</Warning>

Initialization

This API is used to Start the assessment. It returns the first question of the assessment. <Tip>Use this API to get the first question.</Tip>

Start the assessment

This API is used to continue the assessment. It accepts answer in the request body and returns the next question of the assessment. <Tip>Call this API multiple times until progress reaches 100%</Tip>

Continue the assessment

This API is used to Submit the assessment. This api should be called after the assessment is completed and progress reaches 100%. <Tip>Use this API to submit the assessment and get assessment summary</Tip>

Submit the assessment

This API can be used by developers to get info about the components used throughout the assessment. This API is intended to provide knowledge about the Components that developers can use to display in their UI.

List the components

This functionality enables the addition of new patient records to a business' directory. Users can provide necessary details such as personal information, contact details, and medical history to create a new patient profile.

> _In case the patient is already registered with Eka care, then passing the patient eka id will be enough_

<Warning> Right now adding a patient is done wrt to a specific doctor, which automatically adds the patient to the business directory as well.  This will be `deprecated` soon by adding patient directly to a business (WIP). </Warning>


### Request Parameters

Parameter

| Param | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| patient_id | string |  | In case Eka patient_id already exists use this - no need for profile metadata |
| designation | string | Mr./Miss/Mrs. | Patient Designation | Optional |
| first_name | string | Rahul | First Name | Required |
| middle_name | string | Kumar | Middle Name | Optional |
| last_name | string | Sharma | Last Name | Optional |
| dob | Date | 1987-01-06 | Patient DOB | Required |
| age | string | 36 | Patient Age | Optional |
| mobile | string | +919876543210 | Mobile Number with country code | Required |
| gender | string | M/F/O | Patient Gender | Required |
| email | string | rahul.sharma@example.com | Patient Email Address | Optional |
| address | object | | Address Object | Optional |
| address.city | string | Mumbai | City | Optional |
| address.line1 | string | 123, Shanti Nagar | Address Line 1 | Optional |
| address.line2 | string | Near City Hospital | Address Line 2 | Optional |
| address.pincode | int | 400001 | Pincode | Optional |
| address.state | string | Maharashtra | State | Optional |
| address.country | string | India | Country | Optional |
| metadata | object | | Metadata Object (Set of key-value pairs) | Optional |
| metadata.blood_group | string | B+ | Blood Group | Optional |
| metadata.aadhar_number | string | 123456789012 | Aadhar Number | Optional |
| metadata.UHID | string | MH2024001 | Unique Health ID | Optional |
| doctor_id (to_be_deprecated) | string | DOC12345 | doctor_id | Required |

### Response Parameters

| Parameter | Type | Expected Values | Description |
| --- | --- | --- | --- |
| response | object |  | Response Object |
| response.patient_id | string | 1234567890 | Generated Patient ID |
| response.profile | object |  | Profile Object |
| response.profile.id | string | 1234567890 | Profile ID |
| response.profile.created_at | datetime | 2024-06-12T21:55:51.593Z | Profile Creation Timestamp |
| response.profile.updated_at | datetime | 2024-06-17T09:52:55.257Z | Profile Update Timestamp |

**Status Codes**

• 200: Success

• 404: Patient data missing

• 500: Something went wrong

Add Patient to Directory

This API provides functionality to get details of a patient by their Eka profile id, from a business' directory. 
The patient should have been previously added to the business directory for this API to return the patient's details.

### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| patient_id | string | Patient's Eka profile id | Patient's eka profile id | Required |

### **Response parameter**

| Parameter | Type | Expected Values | Description |
| --- |  --- |  --- |  --- |
| data                                | object    |                                           | Response data object                                      |
| data.name                           | string    | "Amit Kumar"                                | Patient's full name                                       |
| data.patient_id                     | string    | "987654321012345"                         | Unique identifier for the patient                         |
| data.patient_profile                | object    |                                           | Detailed patient profile information                      |
| data.patient_profile.address        | object    |                                           | Patient's address information                             |
| data.patient_profile.address.city   | string    | "Bengaluru"                               | City of residence                                         |
| data.patient_profile.address.line1  | string    | "ABC, B Grade Metropolis"              | Address line 1                                            |
| data.patient_profile.address.pincode| string    | "560048"                                  | Pincode                                                   |
| data.patient_profile.created_at     | datetime  | "2024-06-20T10:17:33.242Z"                | Timestamp of profile creation                             |
| data.patient_profile.dob            | date      | "1990-05-17"                              | Patient's date of birth                                   |
| data.patient_profile.email          | string    | "amit.kumar@example.com"                    | Patient's email address                                   |
| data.patient_profile.first_name     | string    | "Amit"                                    | Patient's first name                                      |
| data.patient_profile.middle_name    | string    | ""                                        | Patient's middle name (can be empty)                      |
| data.patient_profile.last_name      | string    | "Kumar"                                     | Patient's last name                                       |
| data.patient_profile.gender         | string    | "M"/"F"/"O"                                    | Patient's gender                                          |
| data.patient_profile.metadata       | object    |                                           | Metadata related to the patient                           |
| data.patient_profile.metadata.blood_group | string | "AB+"                                    | Patient's blood group                                     |
| data.patient_profile.metadata.uhid  | string    | "DESK-177"                                | Unique Health Identifier (UHID)                           |
| data.patient_profile.mobile         | string    | "+919876543210"                           | Patient's mobile number                                   |
| data.patient_profile.patient_id     | string | "987654321012345"                               | Unique identifier for the patient        |
| status_code                         | integer   | 200                                       | HTTP status code of the response                          |
| success                             | boolean   | true                                      | Indicates if the request was successful                   |


**Status Codes**

• 200: Success

• 403: Patient/Business data missing

• 500: Wrong API URL/Wrong JSON request/ Something went wrong

Get patient details by profile id

Thi API provides functionality to update patient details for the registered patients.

WIP: This API is currently under development and will be available soon.

Update Patient Details  [WIP]


### Overview
The Get Clinic and Doctor Details API provides a comprehensive list of clinics and doctors associated with those clinics for a business. This API is designed to retrieve detailed information about clinics, the doctors working at each clinic, and the overarching business entity.
### Endpoint
**URL:** `{{HOST}}/dr/v1/business/entities`

**Method:** GET
### Request Parameters
This endpoint does not require any parameters. The auth header contains business-id information which will be used to fetch the details.
### Response Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| status | integer | HTTP status code of the response |
| data | object | Response data object |
| data.clinics | array | List of clinic objects |
| data.clinics[].clinic_id | string | Unique identifier of the clinic |
| data.clinics[].name | string | Name of the clinic |
| data.clinics[].doctors | array | List of doctor IDs associated with the clinic |
| data.doctors | array | List of doctor objects |
| data.doctors[].name | string | Name of the doctor |
| data.doctors[].doctor_id | string | Unique identifier of the doctor |
| data.business | object | Details of the business entity |
| data.business.business_id | string | Unique identifier of the business |
| data.business.name | string | Name of the business |

Get Clinic and Doctor details


### Overview
This API endpoint is used to retrieve detailed information about a specific doctor using their unique identifier. The response includes comprehensive information about the doctor, such as personal details, specializations, and associated clinics.
### Endpoint
**URL:** `{{HOST}}/dr/v1/business/doctor/{{doctor_id}}`

**Method:** GET
### Request Parameters

| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| doctor_id | string | Unique identifier for the doctor | Yes |

### Response Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | Unique identifier for the doctor in Eka |
| created_at | datetime | Timestamp when the doctor profile was created |
| profile | object | Doctor's profile details |
| profile.personal | object | Personal details of the doctor |
| profile.personal.designation | string | Designation (e.g., Dr.) |
| profile.personal.first_name | string | First name of the doctor |
| profile.personal.middle_name | string | Middle name of the doctor |
| profile.personal.last_name | string | Last name of the doctor |
| profile.personal.email | string | Email address of the doctor |
| profile.personal.gender | string | Gender of the doctor |
| profile.personal.dob | date | Date of birth of the doctor |
| profile.professional | object | Professional details of the doctor |
| profile.professional.active | boolean | Flag indicating if the profile is active |
| profile.professional.about | string | About section describing the doctor |
| profile.professional.language | array | Languages spoken by the doctor |
| profile.professional.language\[\].language | string | Language name (e.g., English) |
| profile.professional.clinics | array | Clinics associated with the doctor |
| profile.professional.clinics\[\] | object | Clinic details |
| profile.professional.clinics\[\]..id | string | Unique identifier for the clinic |
| profile.professional.clinics\[\].city_name | string | City name where the clinic is located |
| profile.professional.clinics\[\].name | string | Name of the clinic |
| profile.professional.clinics\[\].email | string | Email address of the clinic |
| profile.professional.clinics\[\].about | string | About section of the clinic |
| profile.professional.clinics\[\].speciality | array | Specialities offered at the clinic |
| profile.professional.clinics\[\].number | array | Contact numbers for the clinic |
| profile.professional.clinics\[\].number\[\].name | string | Type of contact number (e.g., Phone, Mobile) |
| profile.professional.clinics\[\].number\[\].n | string | Contact number |
| profile.professional.clinics\[\].address | object | Address details of the clinic |
| profile.professional.clinics\[\].address.line1 | string | Address line 1 |
| profile.professional.clinics\[\].address.line2 | string | Address line 2 |
| profile.professional.clinics\[\].address.city | string | City of the clinic |
| profile.professional.clinics\[\].address.state | string | State of the clinic |
| profile.professional.clinics\[\].address.country | string | Country of the clinic |
| profile.professional.clinics\[\].address.pincode | string | Pincode of the clinic |
| profile.professional.clinics\[\].location | array | Location coordinates of the clinic |
| profile.professional.default_clinic | string | Default clinic ID |
| profile.professional.all_registrations | array | Registrations of the doctor |
| profile.professional.all_registrations\[\].id | number | Registration ID |
| profile.professional.all_registrations\[\].council | string | Medical council name |
| profile.professional.all_registrations\[\].medical_id | string | Medical ID number |
| profile.professional.all_registrations\[\].year | string | Year of registration |
| profile.professional.all_registrations\[\].default | boolean | Flag indicating if it is the default registration |
| profile.professional.degree | array | Degrees earned by the doctor |
| profile.professional.degree\[\].id | number | Degree ID |
| profile.professional.degree\[\].name | string | Name of the degree |
| profile.professional.degree\[\].branch_name | string | Branch name |
| profile.professional.degree\[\].college_name | string | College name |
| profile.professional.degree\[\].display_status | string | Display status of the degree |
| profile.professional.degree\[\].start_year | string | Start year of the degree |
| profile.professional.degree\[\].end_year | string | End year of the degree |
| profile.professional.major_speciality | object | Major speciality of the doctor |
| profile.professional.major_speciality.name | string | Name of the major speciality |
| profile.professional.speciality | array | Specialities of the doctor |
| profile.professional.speciality\[\].name | string | Name of the speciality |
| **Status Codes** |  |  |

• 200: Success

• 403: Doctor data missing

• 500: Wrong API URL/Token mismatched/Wrong JSON request.

Get Doctor profile

This API provides functionality to search a patient by their mobile number in doctor's directory

### Request Parameter

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| doctor_id | string |  | Unique identifier for the doctor | Required |

### **Response parameter**

**Status Codes**

• 200: Success

• 403: Patient/Organization data missing

• 500: Wrong API URL/Token mismatched/Wrong JSON request.

Get Clinics for doctor [WIP]

This API is the first step in booking appointment slot for a patient at a doctor's clinic
<Note> We only support date range of D to D+1 to show all available slots of a day. </Note>


**Request Parameters**

| Param | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| patient_id | string | | In case patient id already exists use this - no need for whole profile | Optional |
| designation | string | Mr./Miss/Mrs | Patient Designation | Optional |
| first_name | string | Test | First Name | Required |
| middle_name | string | | Middle Name | Optional |
| last_name | string | Patient | Last Name | Optional |
| dob | string | 1987-01-06 | Patient DOB | Required |
| age | string | 36 | Patient Age | Optional |
| mobile | string | +919999999999 | Mobile Number with country code | Required |
| gender | string | M/F/O | Patient Gender | Required |
| email | string | test@orbi.health | Patient Email Address | Optional |
| address | object | | Address Object | Optional |
| address.city | string | Bangalore | City | Optional |
| address.line1 | string | ABC | Address Line 1 | Optional |
| address.line2 | string | XYZ | Address Line 2 | Optional |
| address.pincode | integer | 560049 | Pincode | Optional |
| address.state | string | Karnataka | State | Optional |
| address.country | string | India | Country | Optional |
| metadata | object | | Metadata Object (Set of key-value pairs) | Optional |
| metadata.blood_group | string | AB+ | Blood Group | Optional |
| metadata.aadhar_number | string | 12345 | Aadhar Number | Optional |
| metadata.UHID | string | VP128 | Unique Health ID | Optional |
| doctor_id (to_be_deprecated) | string | 12345 | doctor_id | Required |

### Response Parameters
| Parameter | Type | Expected Values | Description |
| --- | --- | --- | --- |
| success | string | "true" | Indicates if the request was successful |
| data | object | | Contains the main response data |
| data.clinic_id | object | | Contains the schedule information |
| data.clinic_id.[doctor_id] | array | | Array of schedules for a specific doctor (doctor_id is the key) |
| data.clinic_id.[doctor_id][].service_type | string | "consultation" | Type of service offered |
| data.clinic_id.[doctor_id][].slots | array | | Array of available time slots |
| data.clinic_id.[doctor_id][].slots[].available | boolean | true/false | Indicates if the slot is available |
| data.clinic_id.[doctor_id][].slots[].conf_id | string | | Configuration ID for the slot |
| data.clinic_id.[doctor_id][].slots[].e | string | "2024-09-05T09:30:00+05:30" | End time of the slot in ISO 8601 format |
| data.clinic_id.[doctor_id][].slots[].s | string | "2024-09-05T09:15:00+05:30" | Start time of the slot in ISO 8601 format |
| data.services | object | | Contains information about available services |
| data.services.[conf_id] | object | | Service details (conf_id is the key) |
| data.services.[conf_id].allow_patient_booking | boolean | true/false | Indicates if patients can book directly |
| data.services.[conf_id].appointment_type | string | "REGULAR" | Type of appointment |
| data.services.[conf_id].conf_id | string | | Configuration ID for the service |
| data.services.[conf_id].conv_fee | number | 0 | Convenience fee |
| data.services.[conf_id].currency | string | "INR" | Currency for pricing |
| data.services.[conf_id].discount | number | 0 | Discount amount |
| data.services.[conf_id].mode | array | ["in-clinic"] | Array of service modes |
| data.services.[conf_id].owner_id | string | "161419272566611" | ID of the service owner |
| data.services.[conf_id].post_pay | boolean | false | Indicates if post-payment is allowed |
| data.services.[conf_id].pre_pay | boolean | true | Indicates if pre-payment is required |
| data.services.[conf_id].price | number | 500 | Price of the service |
| data.services.[conf_id].service_id | integer | 1 | Identifier for the service |
| data.services.[conf_id].service_name | string | "consultation" | Name of the service |

**Status codes**

• 200: Success

• 403: Business data missing

• 500: Wrong API URL/Token mismatched/Wrong JSON request.

Get Appointment Slots

This API is used to book an appointment slot for a patient based on the available slots retrieved from the `get appointment slots` API.

<Note> If Eka profile id of a patient is known, there is no need to pass entire patient meta information. Simply passing the patient_id will work.
If patient is not already registered on eka, passing their info under "patient" key will create new profile id.</Note>

**Method:** POST

### Request Parameters

#### Patient Information

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| patient_id | string | 1234567890 | Patient's id on Eka | Optional |
| designation | string | Mr./Miss/Mrs. | Patient's designation | Optional |
| first_name | string | Test | Patient's first name | Required |
| middle_name | string |  | Patient's middle name | Optional |
| last_name | string | Test | Patient's last name | Required |
| dob | Date | 1987-01-06 | Patient's date of birth | Required |
| mobile | string | +919999999999 | Patient's mobile number with country code | Required |
| gender | string | M/F/O | Patient's gender | Required |
| email | string | [abc@eka.care](https://mailto:pp@orbi.health) | Patient's email address | Optional |

#### Slot Information

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| start_time | datetime | 2024-06-11T09:00:00+05:30 | Start time of the appointment slot | Required |
| end_time | datetime | 2024-06-11T09:30:00+05:30 | End time of the appointment slot | Required |
| service_conf_id | string | 904eec0a73d9b02d9145898db44e628bcb18e7a11cd92852be5a2d6f65159a04 | Configuration ID for the service | Required |

#### Doctor and Clinic Information

| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| doctor_id | string | 1234567890 | Doctor's ID | Required |
| clinic_id | string | 1234567890 | Clinic's ID | Required |

**Response Parameters**

|  |  |  |  |
| --- | --- | --- | --- |
| Parameter | Type | Expected Values | Description |
| status | Int | 200 | API response code |
| start_time | Datetime | 2020-03-19T19:00:00Z | Appointment start date |
| message | Varchar | Appointment has been confirmed | Response message |
| appointment_id | Varchar | 9757016a-dfc2-TEST-a38e-df47b758f60d | Appointment ID |

**Status Codes**  
• 200: Success

• 403: Forbidden access

• 404: service_conf_id not found

Confirm Appointment Slot

This API is used to book an appointment slot for a patient which reserves an appointment in a dummy way, that can be rescheduled and checked in once patient is available.

In this API, slots avaiability is not checked and a dumy reservation is made.

Slots will **not** be `reserved` in this case but only an appointment will be assigned to a slot. Staff can then reschedule the appointment and assign to a particular doctor and a proper visit date and time.

- if no `visit_start_date` is passed, next available slot of current date will be booked.
- The dummy reservation **archives/deleted** once the date of reservation crosses.
- To keep the reservation alive, one can pass a future date (say 3 months) while calling this API so that booking is valid till then.
- Staff can search for the patient name, go to the appointment, and reschedule to correct doctor+datetime

**Method:** POST

### Request Parameters
| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| first_name | string | Patient | Patient's first name | Required |
| middle_name | string | | Patient's middle name | Optional |
| last_name | string | Test | Patient's last name | Required |
| dob | string | 1987-01-06 | Patient's date of birth | Required |
| mobile | string | +919999999999 | Patient's mobile number | Required |
| gender | string | M/F/O | Patient's gender | Required |
| doctor_id | string | default | Doctor's ID | Required |
| clinic_id | string | {{clinic_id}} | Clinic's ID | Required |
| visit_start_time | string | 2024-06-26T11:28:45.000Z | Start time of the appointment slot | Optional |
| client_meta.client_visit_id | string | RNI1234567 | Client visit ID | Optional |
| client_meta.patient_id | string | P123456 | Patient ID | Optional |

### Response Parameters
| Parameter | Type | Expected Values | Description | Required/Optional/Not Required |
| --- | --- | --- | --- | --- |
| appointment_id | string | apt-12345-123456 | Appointment's ID | Required |
| doctor_id | string | 1234567890 | Doctor's ID | Required |
| patient_id | string | 1234567890 | Patient's ID | Required |
| clinic_id | string | 019319i10i01a3e462 | Clinic's ID | Required |
| channel | string | Walkin | Channel of appointment | Required |
| status | string | BK | Status of appointment | Required |
| start_time | string | 2024-06-26T11:28:45.000Z | Start time of the appointment | Required |
| end_time | string | 2024-06-26T11:28:45.000Z | End time of the appointment | Required |
| message | string | Appointment has been confirmed | Confirmation message | Required |

**Status Codes**  
• 200: Success

• 400: Bad Request

• 403: Forbidden

Reserve appointment for business [Special Case- Do NOT use]



### Overview
This API endpoint is used to retrieve the details of an appointment using its unique identifier. The response includes comprehensive information about the appointment, including patient and doctor details, appointment status, and related services.

Appointment_statuses:
  - BK    : Booked
  - CK    : Checked In
  - OG    : Ongoing
  - CM	  : Completed with Prescription
  - CMNP  : Completed without a Prescription
  - CN    : Cancelled


### Endpoint
**URL:** `{{HOST}}/dr/v1/business/appointments/{{appointment_id}}`  
**Method:** GET
### Request Parameters
| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| appointment_id | string | Unique identifier for the appointment | Yes |
### Response Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| data | object | Response data object |
| data.aid | string | Unique identifier for the appointment |
| data.created_at | datetime | Appointment creation timestamp |
| data.doctor_id | string | Unique identifier for the doctor |
| data.patient_id | string | Unique identifier for the patient |
| data.clinic_id | string | Unique identifier for the clinic |
| data.channel | string | Channel of the appointment (`Offline` or `Online`) |
| data.status | string | Appointment status (`CM`, `IN`, `CMNP`, etc.) |
| data.start_time | datetime | Start time of the appointment |
| data.end_time | datetime | End time of the appointment |
| data.visit_checkin | datetime | Check-in time for the visit |
| data.visit_start | datetime | Start time for the visit |
| data.visit_end | datetime | End time for the visit |
| data.stage | string | Stage of the appointment (`COMPLETED`, etc.) |
| data.visit-type | string | Type of visit (`WALKIN`, etc.) |
| data.payment | object | Payment details |
| data.payment.payment_id | string | Payment ID (nullable) |
| data.payment.payment_status | string | Payment status (nullable) |
| data.payment.amount | number | Payment amount (nullable) |
| data.prescription_id | string | Prescription Id (if visit lead to Rx) |
| data.service | object | Service details |
| data.service.created_at | datetime | Service creation timestamp |
| data.service.mode | array | Modes of the service (`in-clinic`, etc.) |
| data.service.price | number | Service price (nullable) |
| data.service.post_pay | boolean | Indicates if post-payment is allowed |
| data.service.service_name | string | Name of the service |
| data.service.appointment_type | string | Type of appointment (`REGULAR`, etc.) |

Get Appointment Details


### Overview

This API endpoint is used to cancel an existing appointment.

### Endpoint

**URL:** `{{HOST}}/dr/v1/business/appointments/cancel`  
**Method:** PUT

### Request Parameters

| Parameter | Type | Description | Required |
| --- | --- | --- | --- |
| appointment_id | string | Unique identifier for the appointment | Yes |

### Request Headers

| Header | Type | Description | Required |
| --- | --- | --- | --- |
| Content-Type | string | `application/json` | Yes |

Cancel Appointment

Get all appointments for profile

This API retrieves comprehensive details of a prescription created by a doctor. It provides a rich set of data encompassing patient history, diagnosis, medications, lab tests, and various other clinical elements. The response includes:

  1. Basic Prescription Info: Includes unique identifiers (rx_id, visit_id), creation timestamp, and associated doctor and patient details.

  2. Clinical Data:
     - Symptoms: Detailed symptom information including severity and duration.
     - Diagnosis: Primary diagnoses made by the doctor.
     - Medications: Comprehensive medication details including dosage, frequency, duration, and special instructions. Both oral medications and injections are covered.
     - Lab Tests: Prescribed laboratory tests with testing dates and types (e.g., routine, urgent).
     - Vitals: Any recorded vital signs or lab results, including their interpretations.

  3. Patient History:
     - Current Medications: Ongoing treatments the patient is undergoing.
     - Allergies: Both drug and food/environmental allergies.
     - Medical Conditions: Pre-existing and newly diagnosed conditions.
     - Family History: Relevant medical history of family members.
     - Lifestyle Factors: Information on habits like smoking, alcohol consumption, etc.
     - Past Procedures: Previous surgeries or significant medical procedures.
     - Travel History: Recent travel information relevant to the diagnosis.

  4. Treatment Plan:
     - Advices: General medical advice given by the doctor.
     - Examinations: Physical examinations performed during the visit.

  5. Prescription URL: A link to access the full prescription document in PDF format.

  6. Specialty Information:
      - Ophthalmic Data: Detailed eye examination results including:
             * Current Spectacle Prescription
             * Final Prescription
             * Intraocular Pressure (IOP) Measurements
             * Subjective Refraction
             * Vision Assessment

  This API is designed to provide a holistic view of the patient's current medical situation and the doctor's prescribed treatment plan. It's particularly useful for follow-up care, referrals to specialists, and maintaining a comprehensive electronic health record.

**Response Parameters**
| Parameter | Type | Description |
| --- | --- | --- |
| data | object | Response data object |
| data.rx_id | string | Unique Prescription ID |
| data.visit_id | string | Associated Appointment ID |
| data.created_at | datetime | Timestamp of prescription creation |
| data.doctor | object | Object containing doctor details |
| data.doctor.id | string | Unique Doctor ID |
| data.patient | object | Object containing patient details |
| data.patient.id | string | Unique Patient ID |
| data.selected_clinic | string | ID of the selected clinic |
| data.rx_url | string | URL to access the prescription PDF |
| data.visit_name | string | Name or purpose of the visit |
| data.rx_entities | object | Comprehensive object containing prescription details |
| data.rx_entities.symptoms | array | Array of patient symptoms |
| data.rx_entities.symptoms[].id | string | Unique Symptom ID |
| data.rx_entities.symptoms[].name | string | Name of the symptom |
| data.rx_entities.symptoms[].properties | object | Properties of the symptom (e.g., severity, duration) |
| data.rx_entities.diagnosis | array | Array of diagnoses |
| data.rx_entities.diagnosis[].id | string | Unique Diagnosis ID |
| data.rx_entities.diagnosis[].name | string | Name of the diagnosis |
| data.rx_entities.diagnosis[].properties | object | Additional properties of the diagnosis |
| data.rx_entities.medications | array | Array of prescribed medications |
| data.rx_entities.medications[].id | string | Unique Medication ID |
| data.rx_entities.medications[].name | string | Name of the medication |
| data.rx_entities.medications[].generic_name | string | Generic name of the medication |
| data.rx_entities.medications[].dosage_form | string | Form of the medication (e.g., tablet, syrup) |
| data.rx_entities.medications[].dose | string | Dosage of the medication |
| data.rx_entities.medications[].frequency | string | Frequency of medication intake |
| data.rx_entities.medications[].duration | string | Duration for which medication should be taken |
| data.rx_entities.medications[].timing | string | Timing of medication intake |
| data.rx_entities.medications[].instruction | string | Additional instructions for medication |
| data.rx_entities.medications[].tapering_dose | array | Tapering dosage instructions, if applicable |
| data.rx_entities.lab_tests | array | Array of prescribed lab tests |
| data.rx_entities.lab_tests[].id | string | Unique Lab Test ID |
| data.rx_entities.lab_tests[].name | string | Name of the lab test |
| data.rx_entities.lab_tests[].test_on | datetime | Date when the test should be performed |
| data.rx_entities.lab_tests[].repeat_on | datetime | Date when the test should be repeated, if applicable |
| data.rx_entities.lab_tests[].testing_type | string | Type of testing (e.g., ROUTINE) |
| data.rx_entities.lab_vitals | array | Array of lab vitals recorded |
| data.rx_entities.lab_vitals[].id | string | Unique Lab Vital ID |
| data.rx_entities.lab_vitals[].name | string | Name of the lab vital |
| data.rx_entities.lab_vitals[].value | string | Recorded value of the vital |
| data.rx_entities.lab_vitals[].unit | object | Unit of measurement for the vital |
| data.rx_entities.lab_vitals[].date | datetime | Date when the vital was recorded |
| data.rx_entities.advices | array | Array of medical advices given |
| data.rx_entities.advices[].text | string | Advice text |
| data.rx_entities.examinations | array | Array of examinations performed |
| data.rx_entities.examinations[].name | string | Name of the examination |
| data.rx_entities.medical_history | object | Comprehensive medical history of the patient |
| data.rx_entities.medical_history.patient_history | object | Detailed patient history |
| data.rx_entities.medical_history.patient_history.current_medications | array | Current medications of the patient |
| data.rx_entities.medical_history.patient_history.drug_allergy | array | Drug allergies of the patient |
| data.rx_entities.medical_history.patient_history.food_other_allergy | array | Food and other allergies of the patient |
| data.rx_entities.medical_history.patient_history.family_history | array | Family medical history |
| data.rx_entities.medical_history.patient_history.lifestyle_habits | array | Patient's lifestyle habits |
| data.rx_entities.medical_history.patient_history.past_procedures | array | Past medical procedures of the patient |
| data.rx_entities.medical_history.patient_history.patient_medical_conditions | array | Existing medical conditions of the patient |
| data.rx_entities.medical_history.patient_history.recent_travel_history | array | Recent travel history of the patient |
| data.rx_entities.medical_history.vitals | array | Recorded vitals of the patient |
**Status Codes**
• 200: Success
• 403: Forbidden
• 404: Rx id/Business data missing
• 500: Wrong API URL/Wrong JSON request/ Something went wrong

Get Prescription details

Generate mobile OTP for user session token

Verify mobile OTP and get user session token

API to list all the Subscriptions / Authorization and Consent requests

Get Provider Details

Search Providers

Fetch the data for ABHA qr code display. <Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note><Warning>There is no fixed structure for this JSON; it can vary depending on the creation of ABHA. Generate the QR code based on the content of the response body.</Warning>

ABHA QR Code

Fetch the ABHA card.<Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note>

ABHA card

Fetches the ABHA profile of the User. <Note>Please cache these results locally. We do not recommend calling this API on every page load. Evict the cache when there is profile update.</Note>

Profile Details

<Warning>Name, gender and date of birth cannot be edited for a KYC verified ABHA</Warning>

Update Profile

This endpoint removes the specified ABHA profile along with all associated documents, vital records, and any other related data from the system.<Warning>Please note that the ABHA metadata will remain in the ABDM system, as ABDM does not provide a delete option</Warning>

Delete Profile

Fetch the token from a hospital. <Note> Get the hip_id and counter_id by reading the QR code of the Hospital/Clinic.</Note> <Note>Use the device location for the location data</Note>

Authorization

General Tools

Doctor Tool

ABDM Connect

User App

Release Notes

Search Patient profiles by mobile number

Request Parameter

Response parameter

Headers

Query Parameters

Response