Schedule Queries

Interactive examples coming soon...

appointment :: Appointment

ArgumentTypeDescription
idID!

appointmentReminders :: [AppointmentReminder]

ArgumentTypeDescription
patientIdID!
startDateTime

appointmentTypeTag :: AppointmentTypeTag

ArgumentTypeDescription
idID!ID of resource to lookup

appointmentTypeTags :: [AppointmentTypeTag!]!

ArgumentTypeDescription
locationIdID
nameString

appointmentTypes :: [AppointmentType!]!

ArgumentTypeDescription
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

appointments :: [Appointment]

Get a list of appointments either by location id or provider id

ArgumentTypeDescription
appointmentTypeIds[Int]
apptOnlyBooleanonly return patient appointments (not events)
clientIdID
daycareOnlyBooleanonly return daycare appointments
endDateTime
historicalIdString
ids[ID]
includeCompletedBoolean
includeDeletedBoolean
isLiveBooleanis not completed
isOngoingBooleanis checked in or in-progress
limitInt
locationIdID
offsetInt
onlyDeletedBooleanonly return deleted appts (normally deleted appts are hidden)
onlyTodayBoolean
patientIdID
patientIds[ID]
providerIdID
startDateTime
statuses[AppointmentStatus]show only certain statuses
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime

availableTimes :: [AvailableTimeSlot]

ArgumentTypeDescription
appointmentTypeIdID!
dateDate!
firstAvailableBoolean
locationIdID!
numberOfPetsInt

countAppointmentProviders :: [ApptCountProviders]

Count the number of appointments in a range from start to end segmented into days, weeks, months, years.

ArgumentTypeDescription
endDateTime
segmentTimeSegment!
startDateTime

countAppointments :: [DateCount]

Count the number of appointments in a range from start to end segmented into days, weeks, months, years.

ArgumentTypeDescription
endDateTime
segmentTimeSegment!
startDateTime

countViewerAppointments :: [DateCount]

Count the number of appointments by a certain provider id

ArgumentTypeDescription
endDateTime
segmentTimeSegment!
startDateTime

locationAppointmentTypes :: [AppointmentType]

Get a list of appointments types which are either enabled globally, or enabled for the given location

ArgumentTypeDescription
includeDeletedBoolean
limitInt
locationIdID!
offsetInt

locationSchedules :: [LocationSchedule]

ArgumentTypeDescription
locationIdID
patientIdID

scheduleTemplate :: ScheduleTemplate

ArgumentTypeDescription
idID!ID of resource to lookup

scheduleTemplates :: [ScheduleTemplate!]

ArgumentTypeDescription
locationIdID
updatedAtEndNaiveDateTime
updatedAtStartNaiveDateTime