Providers
Query providers plus their working schedules, time-off blocks, and practice resource calendars.
- Resource
client.providers- SOAP operations
- GetProviders, GetProviderSchedules, GetProviderTimeOffs, GetPracticeResourceSchedules, GetPracticeResourceTimeOffs
- Flat methods
get_providers,get_provider_schedules- Writes
- None
Methods
client.providers.list#
readasync list(*, practice_id=None, practice_name=None, full_name=None, provider_type=None, department_name=None, active_only=False, exclude_referring=False, from_created_date=None, to_created_date=None, from_last_modified_date=None, to_last_modified_date=None, fields=None, extra_filter=None) -> list[dict]List providers using GetProviders. active_only and exclude_referring are applied client-side; when a list-style fields selector is used, Active and Type are added automatically so filtering remains correct.
Parameters
| Parameter | Type | Description |
|---|---|---|
practice_id | int | str | None | Filter by practice ID (sent as a string). |
practice_name | str | None | Filter by practice name. |
full_name | str | None | Provider full name filter. |
provider_type | str | None | Provider type filter (sent as Type). |
department_name | str | None | Department name filter. |
active_only | bool | Keep only rows whose Active value is true. Default False. |
exclude_referring | bool | Drop rows whose Type is Referring Provider. Default False. |
from_created_date | str | date | datetime | None | Lower creation-date bound. |
to_created_date | str | date | datetime | None | Upper creation-date bound. |
from_last_modified_date | str | date | datetime | None | Lower last-modified bound. |
to_last_modified_date | str | date | datetime | None | Upper last-modified bound. |
fields | Iterable[str] | Mapping[str, bool] | None | Field selector. |
extra_filter | Mapping[str, Any] | None | Additional raw Filter keys. |
Returns
list[dict[str, Any]]Example
providers = await client.get_providers(
practice_id=7,
active_only=True,
exclude_referring=True,
)client.providers.get_schedules#
readasync get_schedules(*, practice_id, provider_ids=None, start_datetime=None, end_datetime=None) -> list[dict]Query provider schedules using GetProviderSchedules. Date-only bounds expand to UTC day boundaries.
Parameters
| Parameter | Type | Description |
|---|---|---|
practice_idrequired | int | Practice ID. |
provider_ids | Sequence[int] | None | Restrict to these provider IDs. |
start_datetime | str | date | datetime | None | Start of the schedule window. |
end_datetime | str | date | datetime | None | End of the schedule window. |
Returns
list[dict[str, Any]] (id key ScheduleId)client.providers.get_time_offs#
readasync get_time_offs(*, practice_id, provider_ids=None, start_datetime=None, end_datetime=None) -> list[dict]Query provider time-off blocks using GetProviderTimeOffs.
Parameters
| Parameter | Type | Description |
|---|---|---|
practice_idrequired | int | Practice ID. |
provider_ids | Sequence[int] | None | Restrict to these provider IDs. |
start_datetime | str | date | datetime | None | Start of the window. |
end_datetime | str | date | datetime | None | End of the window. |
Returns
list[dict[str, Any]] (id key TimeOffId)client.providers.get_resource_schedules#
readasync get_resource_schedules(*, practice_id, resource_ids=None, start_datetime=None, end_datetime=None) -> list[dict]Query practice resource schedules using GetPracticeResourceSchedules.
Parameters
| Parameter | Type | Description |
|---|---|---|
practice_idrequired | int | Practice ID. |
resource_ids | Sequence[int] | None | Restrict to these resource IDs. |
start_datetime | str | date | datetime | None | Start of the window. |
end_datetime | str | date | datetime | None | End of the window. |
Returns
list[dict[str, Any]] (id key ScheduleId)client.providers.get_resource_time_offs#
readasync get_resource_time_offs(*, practice_id, resource_ids=None, start_datetime=None, end_datetime=None) -> list[dict]Query practice resource time-off blocks using GetPracticeResourceTimeOffs.
Parameters
| Parameter | Type | Description |
|---|---|---|
practice_idrequired | int | Practice ID. |
resource_ids | Sequence[int] | None | Restrict to these resource IDs. |
start_datetime | str | date | datetime | None | Start of the window. |
end_datetime | str | date | datetime | None | End of the window. |
Returns
list[dict[str, Any]] (id key TimeOffId)Example: weekly availability
providers = await client.get_providers(practice_id=7, active_only=True)
provider_ids = [p["ID"] for p in providers]
schedules, time_offs = await asyncio.gather(
client.providers.get_schedules(
practice_id=7,
provider_ids=provider_ids,
start_datetime="2026-04-13",
end_datetime="2026-04-19",
),
client.providers.get_time_offs(
practice_id=7,
provider_ids=provider_ids,
start_datetime="2026-04-13",
end_datetime="2026-04-19",
),
)
Client-side filters
active_only and exclude_referring filter rows after retrieval. When you pass a list of field names, the resource adds Active and Type so the filters have data to inspect.