# shubhanshujoshi/clinic-appointment-assistant architecture

> Architecture diagram of the GitHub repository shubhanshujoshi/clinic-appointment-assistant, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shubhanshujoshi/clinic-appointment-assistant
- Repository: https://github.com/shubhanshujoshi/clinic-appointment-assistant

## Overview

CareBot is a clinic appointment assistant with a patient-facing conversation flow and an admin appointment overview. Patients send messages through the chat UI; the chat API interprets booking, discovery, availability, lookup, cancellation, and rescheduling requests, then delegates appointment operations to clinic logic backed by MongoDB. The README also lists FAQ responses, reminder-ready records, and no-show support. Those capabilities are documented, but their implementation details are not fully shown in the sampled source.

Main entry points: [`lib/clinic.ts`](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts) (Clinic operations), [`app/api/chat/route.ts`](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/chat/route.ts) (Chat endpoint), [`app/admin/page.tsx`](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/admin/page.tsx) (Admin dashboard), [`app/page.tsx`](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/page.tsx) (Chat interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_patient["Patient experience"]
  node_chat_ui["Chat interface<br/>[page.tsx]"]
  node_admin_ui["Admin dashboard<br/>[page.tsx]"]
end

subgraph group_conversation["Conversation handling"]
  node_chat_api["Chat endpoint<br/>[route.ts]"]
  node_appointment_api["Appointments endpoint<br/>[route.ts]"]
end

subgraph group_clinic["Clinic operations"]
  node_clinic_ops["Clinic operations<br/>[clinic.ts]"]
  node_doctors["Doctor discovery<br/>[clinic.ts]"]
  node_availability["Slot availability<br/>[clinic.ts]"]
  node_booking["Appointment booking<br/>[clinic.ts]"]
  node_management["Appointment management<br/>[clinic.ts]"]
  node_faq["Clinic FAQ<br/>[route.ts]"]
  node_reminders["Reminder records<br/>[clinic.ts]"]
  node_no_show["No-show tracking<br/>[page.tsx]"]
end

subgraph group_storage["Persistence"]
  node_db_helpers["Database and seeding<br/>[db.ts]"]
  node_mongo_client["MongoDB connection<br/>[mongodb.ts]"]
end

node_patient(("Patient"))
node_openai["OpenAI service"]
node_mongo[("MongoDB Atlas")]

node_patient -->|"messages"| node_chat_ui
node_chat_ui -->|"sends requests"| node_chat_api
node_chat_api -->|"returns replies"| node_chat_ui
node_chat_api -->|"dispatches operations"| node_clinic_ops
node_chat_api -->|"requests completion"| node_openai
node_chat_api -.->|"handles questions"| node_faq
node_clinic_ops -->|"finds doctors"| node_doctors
node_clinic_ops -->|"checks slots"| node_availability
node_clinic_ops -->|"books appointments"| node_booking
node_clinic_ops -->|"manages appointments"| node_management
node_clinic_ops -->|"uses database"| node_db_helpers
node_db_helpers -->|"gets client"| node_mongo_client
node_mongo_client -.->|"connects"| node_mongo
node_patient -.->|"views overview"| node_admin_ui
node_admin_ui -->|"fetches appointments"| node_appointment_api
node_appointment_api -.->|"reads appointments"| node_clinic_ops
node_booking -->|"sets pending status"| node_reminders
node_admin_ui -->|"counts status"| node_no_show

click node_chat_ui "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/page.tsx"
click node_admin_ui "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/admin/page.tsx"
click node_chat_api "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/chat/route.ts"
click node_appointment_api "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/appointments/route.ts"
click node_clinic_ops "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_doctors "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_availability "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_booking "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_management "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_faq "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/chat/route.ts"
click node_reminders "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts"
click node_no_show "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/admin/page.tsx"
click node_db_helpers "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/db.ts"
click node_mongo_client "https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/mongodb.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_chat_ui,node_admin_ui toneBlue
class node_chat_api,node_appointment_api,node_mongo toneAmber
class node_clinic_ops,node_doctors,node_availability,node_booking,node_management,node_faq,node_reminders,node_no_show toneMint
class node_db_helpers,node_mongo_client toneRose
class node_patient,node_openai toneIndigo
```

## Components

### Patient experience

- [Chat interface](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/page.tsx): `app/page.tsx`
- [Admin dashboard](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/admin/page.tsx): `app/admin/page.tsx`

### Conversation handling

- [Chat endpoint](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/chat/route.ts): `app/api/chat/route.ts`
- [Appointments endpoint](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/appointments/route.ts): `app/api/appointments/route.ts`

### Clinic operations

- [Clinic operations](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [Doctor discovery](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [Slot availability](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [Appointment booking](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [Appointment management](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [Clinic FAQ](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/api/chat/route.ts): `app/api/chat/route.ts`
- [Reminder records](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/clinic.ts): `lib/clinic.ts`
- [No-show tracking](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/app/admin/page.tsx): `app/admin/page.tsx`

### Persistence

- [Database and seeding](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/db.ts): `lib/db.ts`
- [MongoDB connection](https://github.com/shubhanshujoshi/clinic-appointment-assistant/blob/main/lib/mongodb.ts): `lib/mongodb.ts`

### Other components

- **Patient**
- **OpenAI service**
- **MongoDB Atlas**

## Connections

- Patient → Chat interface: messages (evidence: `app/page.tsx`)
- Chat interface → Chat endpoint: sends requests (evidence: `app/page.tsx`)
- Chat endpoint → Chat interface: returns replies (evidence: `app/page.tsx`)
- Chat endpoint → Clinic operations: dispatches operations (evidence: `app/api/chat/route.ts`)
- Chat endpoint → OpenAI service: requests completion (evidence: `app/api/chat/route.ts`)
- Chat endpoint → Clinic FAQ: handles questions (evidence: `app/api/chat/route.ts`)
- Clinic operations → Doctor discovery: finds doctors (evidence: `lib/clinic.ts`)
- Clinic operations → Slot availability: checks slots (evidence: `lib/clinic.ts`)
- Clinic operations → Appointment booking: books appointments (evidence: `lib/clinic.ts`)
- Clinic operations → Appointment management: manages appointments (evidence: `lib/clinic.ts`)
- Clinic operations → Database and seeding: uses database (evidence: `lib/clinic.ts`)
- Database and seeding → MongoDB connection: gets client (evidence: `lib/db.ts`)
- MongoDB connection → MongoDB Atlas: connects
- Patient → Admin dashboard: views overview
- Admin dashboard → Appointments endpoint: fetches appointments (evidence: `app/admin/page.tsx`)
- Appointments endpoint → Clinic operations: reads appointments
- Appointment booking → Reminder records: sets pending status (evidence: `lib/clinic.ts`)
- Admin dashboard → No-show tracking: counts status (evidence: `app/admin/page.tsx`)
