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 Type | IntraConnects Request | Data Type | Athena Request |
|---|---|---|---|
| Booked | Meta.DataModel | String | Scheduling |
| Booked | Meta.EventType | String | BookedQuery |
| Booked | Meta.EventDateTime | DateTime | |
| Booked | Meta.Test | Boolean | |
| Booked | Meta.Source | String | |
| Booked | Meta.Source.ID | String | |
| Booked | Meta.Source.Name | String | |
| Booked | StartDateTime | String | startdate |
| Booked | EndDateTime | String | enddate |
| Booked | Visit.Reason | Array of Strings | |
| Booked | Visit.VisitNumber | String | |
| Booked | Visit.AttendingProviders[] | Array of Strings | |
| Booked | Visit.AttendingProviders[].ID | String | providerid |
| Booked | Visit.AttendingProviders[].IDType | String | ProviderID |
| Booked | Visit.AttendingProviders[].FirstName | String | |
| Booked | Visit.AttendingProviders[].LastName | String | |
| Booked | Visit.AttendingProviders[].Credentials[] | Array of Strings | |
| Booked | Visit.AttendingProviders[].Address | Object | |
| Booked | Visit.AttendingProviders[].Address.StreetAddress | String | |
| Booked | Visit.AttendingProviders[].Address.City | String | |
| Booked | Visit.AttendingProviders[].Address.State | String | |
| Booked | Visit.AttendingProviders[].Address.ZIP | String | |
| Booked | Visit.AttendingProviders[].Address.County | String | |
| Booked | Visit.AttendingProviders[].Address.Country | String | |
| Booked | Visit.AttendingProviders[].EmailAddresses[] | Array of Strings | |
| Booked | Visit.AttendingProviders[].PhoneNumber.Office | String | |
| Booked | Visit.AttendingProviders[].Location | Object | |
| Booked | Visit.AttendingProviders[].Location.Type | String | |
| Booked | Visit.AttendingProviders[].Location.Facility | String | |
| Booked | Visit.AttendingProviders[].Location.Department | String | |
| Booked | Visit.AttendingProviders[].Location.Room | String | |
| Booked | Visit.VisitProvider.ID | String | |
| Booked | Visit.VisitProvider.IDType | String | |
| Booked | Visit.VisitProvider.FirstName | String | |
| Booked | Visit.VisitProvider.LastName | String | |
| Booked | Visit.VisitProvider.Credentials[] | Array of Strings | |
| Booked | Visit.VisitProvider.Address | Object | |
| Booked | Visit.VisitProvider.Address.StreetAddress | String | |
| Booked | Visit.VisitProvider.Address.City | String | |
| Booked | Visit.VisitProvider.Address.State | String | |
| Booked | Visit.VisitProvider.Address.ZIP | String | |
| Booked | Visit.VisitProvider.Address.County | String | |
| Booked | Visit.VisitProvider.Address.Country | String | |
| Booked | Visit.VisitProvider.EmailAddresses[] | Array of Strings | |
| Booked | Visit.VisitProvider.PhoneNumber.Office | String | |
| Booked | Visit.VisitProvider.Location | Object | |
| Booked | Visit.VisitProvider.Location.Type | String | |
| Booked | Visit.VisitProvider.Location.Facility | String | |
| Booked | Visit.VisitProvider.Location.Department | String | |
| Booked | Visit.VisitProvider.Location.Room | String | |
| Booked | Visit.Location | Object | |
| Booked | Visit.Location.Type | String | |
| Booked | Visit.Location.Facility | String | |
| Booked | Visit.Location.Department | String | |
| Booked | Visit.Location.Room | String | |
| Booked | Visit.Patients[] | Array of Objects | |
| Booked | Visit.Patients[].Identifiers[] | Array of Objects | |
| Booked | Visit.Patients[].Identifiers[].ID | String | |
| Booked | Visit.Patients[].Identifiers[].IDType | String |