Get Appointment Details

curl --request GET \
  --url https://api.eka.care/dr/v1/appointment/{appointment_id} \
  --header 'auth: <auth>'

{
  "appointment_id": "{{eka_appointment_id}}",
  "partner_appointment_id": "{{partner_appointment_id}}",
  "created_at": 1730189586,
  "doctor_id": "{{doctor_id}}",
  "clinic_id": "{{clinic_id}}",
  "patient_id": "{{patient_id}}",
  "partner_doctor_id": "{{partner_doctor_id}}",
  "partner_clinic_id": "{{partner_clinic_id}}",
  "partner_patient_id": "{{partner_patient_id}}",
  "status": "CM",
  "mode": "in_clinic",
  "start_time": 1730189586,
  "end_time": 1730189586,
  "payment": {
    "payment_id": null,
    "payment_status": null,
    "amount": null
  },
  "prescription_id": "{{prescription_id}}",
  "service": {
    "created_at": 1730189586,
    "mode": [
      "INCLINIC"
    ],
    "price": null,
    "post_pay": false,
    "service_name": "consultation",
    "appointment_type": "REGULAR",
    "allow_patient_booking": true
  },
  "prescription_url": "https://prescription-store-s3.eka.care/P-DW-1234.pdf",
  "custom_attributes": {
    "label": [
      "vitals_submitted"
    ]
  },
  "partner_meta": {
    "key1": "value1"
  }
}

Appointment API

Get Appointment Details

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:

Booked / Queue States:

BK (Booked) : Appointment created/confirmed.
CK (Checked-in) : Booked appointment added to the Queue (Checked-in).
RV (Reserved) : Appointment marked as Reserved, when patient said they will come for the appointment on the follow-up appointment message.
IN (Initiated) : Appointment marked as Initiated, when patient received follow-up appointment message.
PA (Parked) : Appointment moved to Parked state.

Ongoing States:

OG (Ongoing): Consultation is in progress.

Completion Statuses:

CM (Completed): Appointment completed with a prescription created.
CMNP (Completed No Prescription) : Appointment marked Exit from Queue / Completed without a prescription.
AB (Aborted) : Appointment was started (Start Visit) but not completed. Automatically marked AB at 12:00 AM next day.
NS (No Show) : Appointment was added to Queue but not started/completed. Automatically marked NS at 12:00 AM next day.
NSD (No Show Doctor) : No-show tagged specifically from a doctor’s action (if implemented).
NSS (No Show Staff) : No-show tagged specifically from a staff action (if implemented).

Cancellation Statuses:

CN (Cancelled) : Appointment cancelled via API.
CND (Cancelled Doctor) : Cancelled from the doctor’s account in the tool.
CNS (Cancelled Staff) : Cancelled from the staff’s account in the tool.
PC (Provisional Cancelled) : Appointment marked as provisional cancellation, when patient said they will not come for the appointment on the follow-up appointment message.
PNR (Payment Not Received) : Appointment marked as PNR, when patient tried paying for a pre-paid appointment but the payment failed.

Reschedule Statuses:

RE : Rescheduled via API.
RES : Rescheduled from staff account.
RED : Rescheduled from doctor account.

GET

appointment

{appointment_id}

Get Appointment Details

curl --request GET \
  --url https://api.eka.care/dr/v1/appointment/{appointment_id} \
  --header 'auth: <auth>'

{
  "appointment_id": "{{eka_appointment_id}}",
  "partner_appointment_id": "{{partner_appointment_id}}",
  "created_at": 1730189586,
  "doctor_id": "{{doctor_id}}",
  "clinic_id": "{{clinic_id}}",
  "patient_id": "{{patient_id}}",
  "partner_doctor_id": "{{partner_doctor_id}}",
  "partner_clinic_id": "{{partner_clinic_id}}",
  "partner_patient_id": "{{partner_patient_id}}",
  "status": "CM",
  "mode": "in_clinic",
  "start_time": 1730189586,
  "end_time": 1730189586,
  "payment": {
    "payment_id": null,
    "payment_status": null,
    "amount": null
  },
  "prescription_id": "{{prescription_id}}",
  "service": {
    "created_at": 1730189586,
    "mode": [
      "INCLINIC"
    ],
    "price": null,
    "post_pay": false,
    "service_name": "consultation",
    "appointment_type": "REGULAR",
    "allow_patient_booking": true
  },
  "prescription_url": "https://prescription-store-s3.eka.care/P-DW-1234.pdf",
  "custom_attributes": {
    "label": [
      "vitals_submitted"
    ]
  },
  "partner_meta": {
    "key1": "value1"
  }
}

Headers

auth

string

required

Example:

"auth"

Path Parameters

appointment_id

string

required

Query Parameters

partner_id

string

If set to 1 then appointment_id in path parameter should be partner_appointment_id else eka apppointment_id

Example:

"1"

Response

appointment_id

string

created_at

integer

doctor_id

string

patient_id

string

clinic_id

string

channel

string

status

enum<string>

Available options:

BK,

OG,

CM,

CMNP,

CN,

CND,

CNS

Example:

"BK"

mode

enum<string>

Available options:

tele,

in_clinic

Example:

"in_clinic"

start_time

integer

end_time

integer

payment

object

Show child attributes

prescription_id

string

service

object

Show child attributes

prescription_url

string

custom_attributes

object

partner_meta

object

Book Appointment Slot Update Appointment

⌘I

Documentation Index

Headers

Path Parameters

Query Parameters

Response