AvailableSlots
Description
This query is used to search for available appointment slots within a specified time range. The response for this query will provide information about the available appointment times, which can be used for booking appointments.
API endpoints for Available slots
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/available-slots.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Intraconnects Unified Model
| Event Type | IntraConnects Request | Data Type | Athena Request |
|---|---|---|---|
| AvailableSlots | Meta.DataModel | String | |
| AvailableSlots | Meta.EventType | String | |
| AvailableSlots | Meta.EventDateTime | DateTime | |
| AvailableSlots | Meta.Test | Boolean | |
| AvailableSlots | Meta.Source | String | |
| AvailableSlots | Meta.Source.ID | String | |
| AvailableSlots | Meta.Source.Name | String | |
| AvailableSlots | Provider.Identifiers[] | Array of Objects | |
| AvailableSlots | Provider.Identifiers[].ID | String | providerid |
| AvailableSlots | Provider.Identifiers[].IDType | String | |
| AvailableSlots | Provider.Demographics.FirstName | String | |
| AvailableSlots | Provider.Demographics.MiddleName | String | |
| AvailableSlots | Provider.Demographics.LastName | String | |
| AvailableSlots | Provider.Demographics.DOB | String | |
| AvailableSlots | Provider.Demographics.SSN | String | |
| AvailableSlots | Provider.Demographics.Sex | String | |
| AvailableSlots | Provider.Demographics.Race | String | |
| AvailableSlots | Provider.Demographics.IsHispanic | Boolean | |
| AvailableSlots | Provider.Demographics.Religion | String | |
| AvailableSlots | Provider.Demographics.MaritalStatus | String | |
| AvailableSlots | Provider.Demographics.IsDeceased | Boolean | |
| AvailableSlots | Provider.Demographics.DeathDateTime | DateTime | |
| AvailableSlots | Provider.Demographics.PhoneNumber.Home | String | |
| AvailableSlots | Provider.Demographics.PhoneNumber.Office | String | |
| AvailableSlots | Provider.Demographics.PhoneNumber.Mobile | String | |
| AvailableSlots | Provider.Demographics.EmailAddresses[] | Array of Strings | |
| AvailableSlots | Provider.Demographics.Language | String | |
| AvailableSlots | Provider.Demographics.Citizenship[] | Array of Strings | |
| AvailableSlots | Provider.Demographics.Address | Object | |
| AvailableSlots | Provider.Demographics.Address.StreetAddress | String | |
| AvailableSlots | Provider.Demographics.Address.City | String | |
| AvailableSlots | Provider.Demographics.Address.State | String | |
| AvailableSlots | Provider.Demographics.Address.ZIP | String | |
| AvailableSlots | Provider.Demographics.Address.County | String | |
| AvailableSlots | Provider.Demographics.Address.Country | String | |
| AvailableSlots | Provider.Notes[] | Array of Strings | |
| AvailableSlots | Provider.Diagnoses[] | Array of Objects | |
| AvailableSlots | Provider.Diagnoses[].Code | String | |
| AvailableSlots | Provider.Diagnoses[].Codeset | String | |
| AvailableSlots | Provider.Diagnoses[].Name | String | |
| AvailableSlots | Provider.Diagnoses[].Type | String | |
| AvailableSlots | Provider.Diagnoses[].DocumentedDateTime | String | |
| AvailableSlots | StartDateTime | String | startdate |
| AvailableSlots | EndDateTime | String | enddate |
| AvailableSlots | Visit.Reasons[] | Array of Strings | |
| AvailableSlots | Visit.AttendingProviders[].ID | String | |
| AvailableSlots | Visit.AttendingProviders[].IDType | String | |
| AvailableSlots | Visit.AttendingProviders[].FirstName | String | |
| AvailableSlots | Visit.AttendingProviders[].LastName | String | |
| AvailableSlots | Visit.AttendingProviders[].Credentials[] | Array of Strings | |
| AvailableSlots | Visit.AttendingProviders[].Address | Object | |
| AvailableSlots | Visit.AttendingProviders[].Address.StreetAddress | String | |
| AvailableSlots | Visit.AttendingProviders[].Address.City | String | |
| AvailableSlots | Visit.AttendingProviders[].Address.State | String | |
| AvailableSlots | Visit.AttendingProviders[].Address.ZIP | String | |
| AvailableSlots | Visit.AttendingProviders[].Address.County | String | |
| AvailableSlots | Visit.AttendingProviders[].Address.Country | String | |
| AvailableSlots | Visit.AttendingProviders[].EmailAddresses[] | Array of Strings | |
| AvailableSlots | Visit.AttendingProviders[].PhoneNumber.Office | String | |
| AvailableSlots | Visit.AttendingProviders[].Location | Object | |
| AvailableSlots | Visit.AttendingProviders[].Location.Type | String | |
| AvailableSlots | Visit.AttendingProviders[].Location.Facility | String | |
| AvailableSlots | Visit.AttendingProviders[].Location.Department | String | |
| AvailableSlots | Visit.AttendingProviders[].Location.Room | String | |
| AvailableSlots | Visit.Locations[] | Array | |
| AvailableSlots | Visit.Locations[].Type | String | |
| AvailableSlots | Visit.Locations[].Facility | String | |
| AvailableSlots | Visit.Locations[].Department | String | departmentid |
| AvailableSlots | Visit.Locations[].SpecialtyDepartment | Object | |
| AvailableSlots | Visit.Locations[].SpecialtyDepartment.Code | String | |
| AvailableSlots | Visit.Locations[].SpecialtyDepartment.Codeset | String | |
| AvailableSlots | Visit.Locations[].SpecialtyDepartment.Description | String | |
| AvailableSlots | Visit.Locations[].Room | String | |
| AvailableSlots | Visit.Locations[].ID | String | |
| AvailableSlots | Visit.VisitType[] | Array of Objects | |
| AvailableSlots | Visit.VisitType[].Code | String | |
| AvailableSlots | Visit.VisitType[].Codeset | String | |
| AvailableSlots | Visit.VisitType[].Description | String | |
| AvailableSlots | Visit.VisitPreference[] | Array of Objects | |
| AvailableSlots | Visit.VisitPreference[].Duration | String | |
| AvailableSlots | Visit.VisitPreference[].DurationUnit | String | |
| AvailableSlots | Visit.VisitPreference[].Day[] | Array of Strings | |
| AvailableSlots | Visit.VisitPreference[].Time[] | Array of Strings |