Skip to main content

Booked

Description

This query is used to search for booked appointments within a specified time range. The response for this query will provide information about the appointments that have been booked within the specified time range, including details such as patient demographics, appointment time, and appointment status.

API endpoints for Booked Appointments

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/booked.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Intraconnect Unified Model

Event TypeIntraConnects RequestData TypeCerner Request
BookedMeta.DataModelStringScheduling
BookedMeta.EventTypeStringBookedQuery
BookedMeta.EventDateTimeDateTime
BookedMeta.TestBoolean
BookedMeta.SourceString
BookedMeta.Source.IDString
BookedMeta.Source.NameString
BookedStartDateTimeStringstartdate
BookedEndDateTimeStringenddate
BookedVisit.ReasonArray of Strings
BookedVisit.VisitNumberString
BookedVisit.AttendingProviders[]Array of Strings
BookedVisit.AttendingProviders[].IDStringpractitioner
BookedVisit.AttendingProviders[].IDTypeStringProviderID
BookedVisit.AttendingProviders[].FirstNameString
BookedVisit.AttendingProviders[].LastNameString
BookedVisit.AttendingProviders[].Credentials[]Array of Strings
BookedVisit.AttendingProviders[].AddressObject
BookedVisit.AttendingProviders[].Address.StreetAddressString
BookedVisit.AttendingProviders[].Address.CityString
BookedVisit.AttendingProviders[].Address.StateString
BookedVisit.AttendingProviders[].Address.ZIPString
BookedVisit.AttendingProviders[].Address.CountyString
BookedVisit.AttendingProviders[].Address.CountryString
BookedVisit.AttendingProviders[].EmailAddresses[]Array of Strings
BookedVisit.AttendingProviders[].PhoneNumber.OfficeString
BookedVisit.AttendingProviders[].LocationObject
BookedVisit.AttendingProviders[].Location.TypeString
BookedVisit.AttendingProviders[].Location.FacilityString
BookedVisit.AttendingProviders[].Location.DepartmentString
BookedVisit.AttendingProviders[].Location.RoomString
BookedVisit.VisitProvider.IDString
BookedVisit.VisitProvider.IDTypeString
BookedVisit.VisitProvider.FirstNameString
BookedVisit.VisitProvider.LastNameString
BookedVisit.VisitProvider.Credentials[]Array of Strings
BookedVisit.VisitProvider.AddressObject
BookedVisit.VisitProvider.Address.StreetAddressString
BookedVisit.VisitProvider.Address.CityString
BookedVisit.VisitProvider.Address.StateString
BookedVisit.VisitProvider.Address.ZIPString
BookedVisit.VisitProvider.Address.CountyString
BookedVisit.VisitProvider.Address.CountryString
BookedVisit.VisitProvider.EmailAddresses[]Array of Strings
BookedVisit.VisitProvider.PhoneNumber.OfficeString
BookedVisit.VisitProvider.LocationObject
BookedVisit.VisitProvider.Location.TypeString
BookedVisit.VisitProvider.Location.FacilityString
BookedVisit.VisitProvider.Location.DepartmentString
BookedVisit.VisitProvider.Location.RoomString
BookedVisit.LocationObject
BookedVisit.Location.TypeString
BookedVisit.Location.FacilityString
BookedVisit.Location.DepartmentString
BookedVisit.Location.RoomString
BookedVisit.Patients[]Array of Objects
BookedVisit.Patients[].Identifiers[]Array of Objects
BookedVisit.Patients[].Identifiers[].IDString
BookedVisit.Patients[].Identifiers[].IDTypeString