System Requirements Document for copper-web

1. Introduction

Copper-web is a web and mobile application designed to improve the hospital appointment and waiting experience. The application provides real-time updates on hospital appointments and queue management, allowing patients to view their appointment status, queue number, estimated waiting time, number of patients ahead, and expected time to be seen by the doctor. It also provides information on whether the doctor has arrived, any delays, and notifies patients when their turn is approaching. The goal is to save patients' time, reduce hospital crowding, and make the appointment process more transparent and convenient.

2. System Overview

Copper-web is a real-time hospital appointment and queue management system that serves both patients and hospital staff. It provides patients with up-to-date information about their appointments and waiting times, while hospital staff can manage appointment and queue data to ensure accurate and timely updates. The system is designed to operate in real-time, ensuring that all users have access to the most current information.

2a. Product Interpretation and Delivery Boundary

Copper-web is delivered as both a web application and a mobile app, providing seamless access to hospital appointment and queue information. It requires user authentication for accessing protected patient and staff functionalities. The system is designed to cover hospital doctor appointments and associated waiting queues, with a focus on reducing unnecessary waiting and improving transparency. The application supports real-time synchronization of appointment, queue, doctor-arrival, and delay state, and delivers notifications for approaching turns.

2b. Source Content Inventory

Not applicable as no content source directive is provided.

2c. Page Content and Component Coverage

Landing

• Purpose: Introduce the application and its functionalities to new users.
• Components:
  • Overview of the application features.
  • Information on how the system benefits patients and hospital staff.
  • Access to login and registration.

Login

• Purpose: Authenticate users to access protected functionalities.
• Components:
  • Input fields for username and password.
  • Role-aware access control for patients and staff.
  • Password recovery option.

Appointment Status

• Purpose: Display the current status of a patient's hospital appointment.
• Components:
  • Current appointment details.
  • Status updates and notifications.

Queue Status

• Purpose: Show the patient's queue number and the number of patients ahead.
• Components:
  • Queue position.
  • Real-time updates on queue movement.

Wait Times

• Purpose: Provide estimated waiting time and expected doctor-seen time.
• Components:
  • Estimated waiting time.
  • Expected time to see the doctor.

Doctor Status

• Purpose: Inform patients about the doctor's arrival and any delays.
• Components:
  • Doctor arrival status.
  • Delay notifications.

Queue Management

• Purpose: Allow staff to manage appointment and queue information.
• Components:
  • Tools for updating queue and appointment data.
  • Real-time synchronization with patient-facing information.

Doctor Status Management

• Purpose: Enable staff to update doctor arrival and delay status.
• Components:
  • Interface for managing doctor schedules.
  • Delay and arrival status updates.

3. Functional Requirements

• As a Patient, I should be able to see my appointment status to know when I will be seen by the doctor. (explicit)
• As a Patient, I should be able to see my queue number and the number of patients ahead of me to estimate my waiting time. (explicit)
• As a Patient, I should be able to see the estimated waiting time and the expected time when I will be seen by the doctor. (explicit)
• As a Patient, I should be able to see whether the doctor has arrived and if there is any delay. (explicit)
• As a Patient, I should receive notifications when my turn is approaching to reduce unnecessary waiting. (explicit)
• As Hospital appointment and queue staff, I should be able to manage appointment and queue information to provide accurate real-time updates to patients. (required_inference)
• As Hospital appointment and queue staff, I should be able to update doctor arrival and delay status to ensure patients receive accurate information. (required_inference)

4. User Personas

Patient

• Context: Patients use the application to manage their hospital appointments and minimize waiting times.
• Primary Goal: To receive timely updates on appointment status and queue position to plan their visit efficiently.
• Responsibilities: Checking appointment status, queue number, estimated waiting time, and receiving notifications.
• Interactions: Receives real-time updates and notifications about their appointments.

Hospital Appointment and Queue Staff

• Context: Staff members use the application to manage and update appointment and queue information.
• Primary Goal: To ensure accurate and timely updates are available for patients.
• Responsibilities: Managing appointment schedules, updating queue information, and doctor status.
• Interactions: Provides real-time data updates that patients rely on for their appointments.

5. Core User Flows

Patient Checking Appointment Status

1. Starting Context: Patient logs into the application.
2. Appointment Status Page: Patient navigates to the Appointment Status page.
3. Action: Patient views current appointment details and status.
4. Result: Patient receives real-time updates on appointment status.
5. Next Step: Patient can navigate to Queue Status or Wait Times for more information.

Patient Viewing Queue Status

1. Starting Context: Patient is logged in and on the main dashboard.
2. Queue Status Page: Patient selects the Queue Status page.
3. Action: Patient views their queue number and the number of patients ahead.
4. Result: Real-time updates on queue position are displayed.
5. Next Step: Patient can check Wait Times or Doctor Status for additional information.

Staff Managing Queue Information

1. Starting Context: Staff logs into the application.
2. Queue Management Page: Staff accesses the Queue Management page.
3. Action: Staff updates queue and appointment data.
4. Result: Real-time synchronization with patient-facing information.
5. Next Step: Staff can update Doctor Status if needed.

6. Visuals Colors and Theme

• Muse: Yves Béhar
• Palette:
  • Background: #FAF8F6
  • Surface: #FFFFFF
  • Text: #333333
  • Primary: #A8D5BA
  • Accent: #D96C75
  • Muted: #E0E0E0
• Typography:
  • Headings: Work Sans — Bold
  • Body: Karla
  • Scale: 1.25 modular
• Shape Language: Rounded forms
• Layout: Soft cards, clear information hierarchy
• Motion: Breathing, slow easing transitions

7. Signature Design Concept

The landing page will feature a full-width hero image with a calming green background (#A8D5BA) and a prominent welcoming message. Rounded cards will display queue and appointment details with soft shadows. Large, friendly icons will represent different sections like appointment status, queue, and waiting time. Animated transitions will update real-time queue status to enhance engagement.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
• Motion Tempo: Restrained
• Hero Dimensionality: Layered_2d
• Landing Hero Motion Brief: The hero section will feature a soothing color background with oversized friendly type and illustrative icons representing healthcare contexts. The animation will include slow easing transitions to promote calmness, with a reduced-motion state available for accessibility.

9. Non-Functional Requirements

• The system must provide real-time updates to ensure patients and staff have the most current information. (explicit)
• The application should be accessible on both web and mobile platforms. (explicit)
• The user interface must be intuitive and user-friendly to accommodate a wide range of users. (explicit)

10. Tech Stack

• Frontend: React for web application, React Native for mobile app
• Backend: Python/FastAPI for API development
• Database: PostgreSQL for storing appointment and queue data
• Containerization: Docker for deployment
• Orchestration: Kubernetes for managing containerized applications

11. Assumptions and Constraints

• The application is intended for use in hospital settings for managing doctor appointments and queues. (explicit)
• Real-time data synchronization is a critical requirement for the system's functionality. (explicit)
• The application must comply with healthcare data privacy regulations.

12. Glossary

• Appointment Status: The current state of a patient's scheduled appointment.
• Queue Number: The position of a patient in the waiting line.
• Estimated Waiting Time: The projected time a patient will wait before seeing the doctor.
• Doctor Arrival Status: Information on whether the doctor is present and any delays.
• Real-time Synchronization: Continuous updating of data to reflect the most current information.