Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FerchoSG/healthcare-web/llms.txt

Use this file to discover all available pages before exploring further.

CitaBox gives every person in your clinic — administrators, receptionists, and doctors — a role-specific workspace. This guide walks you through the full onboarding flow: from your first login, through clinic selection, to creating your first appointment and optionally enabling online booking.
1

Receive your invitation and log in

Your clinic administrator creates your account and sends you credentials by email. Open your clinic’s CitaBox URL and enter your email and password to sign in.CitaBox posts your credentials to /auth/login and returns a short-lived JWT access token. The app stores this token in localStorage under the key access_token and attaches it as a Bearer token on every subsequent request.
If you do not yet have credentials, ask your clinic administrator. Self-registration is not available to individual staff members — accounts are created by an ADMIN or SUPER_ADMIN.
2

Select your clinic (multi-clinic users)

If your account belongs to more than one clinic, CitaBox shows a clinic picker immediately after login. Select the clinic you want to work in. Your choice is stored in localStorage under clinic_id and sent on every API request as the x-clinic-id header.You can switch clinics at any time from the top header without logging out.
CitaBox restores your last active clinic automatically on the next page load, so you rarely need to reselect.
3

Explore your role-specific dashboard

The view you see after login depends on the role assigned to your account in this clinic:
API roleDisplay nameDefault landing view
SUPER_ADMINAdministradorDashboard — KPIs and revenue
ADMINAdministradorDashboard — KPIs and revenue
STAFFRecepciónFront-desk — today’s queue and walk-ins
DOCTORDoctorSchedule — your appointments for the day
The sidebar shows only the views your role can access. Available views are: dashboard, calendar, patients, settings, front-desk, schedule, and medical-records.
4

Create your first appointment

Click New appointment in the top header or directly from the calendar view. Fill in the patient, doctor, date, time range, and an optional reason or service.The app calls POST /appointments with a payload like this:
{
  "patient_id": "uuid",
  "doctor_id": "uuid",
  "start_time": "2025-06-10T09:00:00.000Z",
  "end_time": "2025-06-10T09:30:00.000Z",
  "reason": "Consulta general",
  "service_id": "uuid"
}
Once saved, the appointment appears on the calendar and in the front-desk queue. Its initial status is PENDING. A receptionist can advance it through CONFIRMED → WAITING → IN_CONSULTATION → COMPLETED as the patient moves through the clinic.
All times are stored and returned in UTC ISO 8601 format. The UI converts them to the clinic’s configured timezone for display.
5

Enable online booking (optional)

Admins can turn on the public booking portal from Settings → Clinic settings. When booking_enabled is true, patients can book appointments directly using your clinic’s public URL — no CitaBox account required.See Online booking for the full setup guide.

​
Next steps

Authentication

Learn how bearer tokens work, how to switch clinic context, and how session expiry is handled automatically.

Appointments

Schedule, reschedule, and manage the full appointment lifecycle from pending to completed.

Patients

Add patients, maintain their registry, and open their electronic medical record.

Roles and dashboards

Understand what each role can see and do across the admin, receptionist, and doctor views.

Build docs developers (and LLMs) love

Get started for freeTalk to us