Skip to main content

Data Export - Appointments

Appointment​

Generated by the Bulk Data Export system

The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.

What this export contains​

One row per scheduled appointment between a patient and a provider, with its status (booked, arrived, noshow, canceled and so on), start and end time and duration. An appointment may or may not turn into a measurement encounter. This is the export for scheduling, attendance and no-show analysis.

Example questions this export can answer​

  • Measure no-show and cancellation rates by provider, site or time period
  • Analyze appointment volume and utilization over time
  • Compare scheduled appointments against measurement encounters to see where measurement actually happened
PropertyNameField TypeCardinalityNotes
instituteidInstitute Ididentifier1..*
instituteShortcodeInstitute ShortcodeString1..*
idIdidentifier1..1
statusStatusenum1..1proposed | pendingbookedarrivedfulfilledcancelednoshow
startDateStart Datetimestamp1..1
endDateEnd Datetimestamp0..1
minutesDurationDuration (minutes)integer1..1
encounterIdEncounter Ididentifier0..1Encounter
practitionerIdPractitioner Ididentifier0..1Practitioner
patientIdPatient Ididentifier1..1Patient
treatmentServiceIdTreatment Service Ididentifier1..1Treatment Service