CipherStream Enterprise Data Extraction Platform

Appointments

Core Appointment Data: Extract comprehensive appointment records with intelligent processing.

Processing Modes:

Auto (Recommended): System automatically chooses streaming (≤100K rows) or job processing (>100K rows)
Stream: Forces real-time streaming response (recommended for ≤100K appointments)
Job: Forces background job processing with S3 download (for large datasets)

Attributes

Title

Description

Title

Attribute	Type	Description
`appointment_id`	integer	Unique appointment identifier
`appointment_status`	string	Human-readable appointment status
`appointment_status_codes`	string	Status abbreviation codes
`cancelled`	integer (0/1)	Cancellation flag (0 = not cancelled, 1 = cancelled)
`failed`	integer (0/1)	Failed appointment flag (0 = not failed, 1 = failed)
`attended`	integer (0/1)	Patient attendance flag (0 = not attended, 1 = attended)
`online`	integer (0/1)	Online booking flag (0 = not online, 1 = online booking)
`appointment_type_code`	string	Appointment type identifier
`appointment_type`	string	Appointment type description
`appointment_date`	date	Date of appointment (YYYY-MM-DD)
`start_time`	date-time	Scheduled start time (YYYY-MM-DD HH:MM:SS)
`end_time`	date-time	Scheduled end time (YYYY-MM-DD HH:MM:SS)
`appointment_arrival_time`	date-time, nullable	Actual patient arrival time
`actual_start_time`	date-time, nullable	Actual appointment start time
`actual_end_time`	date-time, nullable	Actual appointment end time
`duration`	integer (minutes)	Scheduled duration in minutes
`recall_set_linked`	integer (0/1)	Linked to recall system flag (0 = no, 1 = yes)
`patient_id`	integer	Associated patient identifier
`practitioner_id`	integer	Assigned practitioner identifier
`location_id`	integer	Practice location identifier
`created_date`	date-time	Appointment creation timestamp
`original_date`	date, nullable	Original creation date (for rescheduled appointments)
`created_by`	string	User who created the appointment
`updated_date`	date-time	Last update timestamp
`updated_by`	string	User who last updated the appointment
`is_deleted`	integer (0/1)	Deletion status (0 = active, 1 = deleted)
`confirmed`	integer (0/1)	Confirmation status (0 = not confirmed, 1 = confirmed)
`schedule_id`	integer	Appointment book/schedule identifier

Key Features:

Intelligent Processing: Auto-switching between streaming and job processing
High-Volume Support: Handles millions of appointment records efficiently
Real-Time Data: Includes both active and deleted appointments for complete audit trail
Status Tracking: Comprehensive appointment status and workflow tracking
Time Accuracy: Scheduled vs actual times for performance analysis

Use Cases:

Appointment management system integration
Schedule optimisation and analysis
Patient flow and wait time analysis
Practitioner utilization reporting
Appointment outcome tracking
Business intelligence and KPI dashboards

Header Parameters

Content-Typestring

Body Parameters

customer_idstring Required

Unique customer identifier

from_datestring

Start date for filtering (YYYY-MM-DD format)

to_datestring

End date for filtering (YYYY-MM-DD format)

date_modifierstring

Filter mode - "All" (default), "Created", or "Updated"

modestring

Execution mode - "auto" (default), "stream", or "job"

output_formatstring

Response format - "ndjson" (default), "json", or "csv"

compressionstring

Compression type - "none" (default), "gzip", or "zip"

encryptedstring

Encryption - "false" (default) or "true"

Sections

Appointments

Attributes

Header Parameters

Body Parameters

What made this section unhelpful for you?

What made this section unhelpful for you?