API Reference

The API Reference provides a complete technical description of the AppointmentScheduler class and all its configurable parameters, methods, and outputs. Each page focuses on a specific component of the scheduler, including data-generation logic, probabilistic models, and output structures.

Use this section as a detailed companion to the User Guide for in-depth understanding or advanced customization.

• AppointmentScheduler
  • Purpose
  • Parameters
  • Attributes
  • Methods
  • Usage example
  • Notes
• Date ranges and reference date
  • date_ranges
  • ref_date
• Calendar structure
  • working_days
  • working_hours
  • appointments_per_hour
• Seasonality and weights
  • weekday_weights
  • month_weights
• Booking dynamics
  • fill_rate
  • booking_horizon
  • median_lead_time
• Attendance behavior
  • status_rates
  • rebook_category
• Patient flow
  • visits_per_year
  • first_attendance
• Patient demographics
  • age_gender_probs
  • bin_size
  • lower_cutoff and upper_cutoff
  • truncated
• Appointment timing
  • check_in_time_mean
  • Appointment duration model
• Randomness and variability
  • seed
  • noise
• Appointments table
  • Overview
  • Core columns
  • Generation logic
  • Example
  • Related parameters
• Slots table
  • Overview
  • Core columns
  • Generation logic
  • Example
  • Related parameters
• Patients table
  • Overview
  • Core columns
  • Demographic generation
  • Identity fields
  • Example
  • Related parameters
  • References
• Adding custom columns
  • Overview
  • Function signature
  • Parameters
  • Distribution models
  • Behavior and validation
  • Examples
  • Practical applications
  • Related parameters