Communication Flow Reference - Appointment & Clinical Events

This document outlines how communication can be triggered for various use cases within the Eka platform. Each communication is driven by a system event (called a trigger) and follows a predefined logic using appointment, patient, clinic or doctor data. This version of the table shows high-level details for each use case in a simplified format.

Event Triggers

Event Description	Event Name	Applicable Mode	Trigger	Sample Payload Snippet	Notes
In-Clinic Appointment Booking	`appointment.created`	In-clinic	When a patient books an appointment	`“status”: “BK”, “mode”: “in-clinic”, “start_time”: 1730189586`	“Mode” can be checked by calling get_appointment_details API
Tele-Consultation Booking	`appointment.created`	Tele	When a patient books an appointment	`“status”: “BK”, “mode”: “in-clinic”, “start_time”: 1730189586`	“Mode” can be checked by calling get_appointment_details API
Doctor Joined Video Consultation	`appointment.tele.dr_joined`	Tele	When the doctor enters the video consultation	Indicates patient that doctor has joined the video room
Appointment Cancelled	`appointment.updated`	All	When the appointment status changes to CN/CND/CNS	Status values: CN (Cancelled by patient), CND (Cancelled by Doctor), CNS (Cancelled by Staff)
Prescription Created	`prescription.created`	All	When the doctor clicks finish prescription	`“prescription_id”: “prescription_id”, “appointment_id”: “appointment_id1”, “prescription_url”: “prescription_url.pdf”`	Use “prescription_id” to fetch full clinical content by calling get_prescription_details API.
Prescription Updated	`prescription.updated`	All	When the doctor modifies a saved prescription	`“prescription_id”: “prescription_id1”, “appointment_id”: “appointment_id1”, “prescription_url”: “prescription_url.pdf”`	Use “prescription_id” to call get_prescription_details API for updated info.

Eka Care Developer API guide

​Event Triggers

Event Triggers