Skip to main content

AthenaSchedulingAbilityConfig

@gravity-rail/sdk


@gravity-rail/sdk / AthenaSchedulingAbilityConfig

Interface: AthenaSchedulingAbilityConfig

Config for the athenahealth scheduling ability.

Mirrors AthenaSchedulingParams (lib/abilities/builtin/athena_scheduling.py), which is authoritative. The connection must be an enabled athenahealth FHIR connection in the workspace; department, reason and provider ids are athenaOne ids the practice supplies. requireCoverage can only tighten the connection's booking policy, never loosen it.

Properties​

activateOnBook?​

optional activateOnBook: boolean

Set the patient's athena status to active before booking (default false).


bookingEnabled?​

optional bookingEnabled: boolean

Give the Agent the booking tool (default false).


connectionId​

connectionId: number

The athenahealth FHIR connection's id (a positive integer).


departmentId​

departmentId: number

athenaOne department id.


providerIds​

providerIds: number[]

1-20 distinct athenaOne provider ids searched together.


reasonId​

reasonId: number

athenaOne new-patient scheduling reason id (not the -1 wildcard).


requireCoverage?​

optional requireCoverage: boolean

Require confirmed coverage before booking (default false).


searchDays?​

optional searchDays: number | null

Days ahead to search, 1-14 (default 7 when omitted). null is an authored value that did not parse; it is never saveable.