This article describes how to set up a provider record in Kyruus so that they can be scheduled online via the Kyruus Schedule product.
Note: Depending on your role/permissions, you may not be able to edit the below fields directly in Kyruus Connect - Administrator. Please contact the Kyruus Health Support team to modify your permissions.
For every provider that is eligible for online scheduling, there are three components associated with the provider record that must be answered-
-
Who?
Who is the provider and what is the identifying information for this provider in the corresponding EHR?
- System Provider ID: provider identifier in the EHR. For e.g. this is classified as the SER1 ID in Epic, or personnel_id in Cerner Millennium. For Athena, the providerid can be retrieved from the AthenaOne Home Page > Settings > Billing > Providers; the ID is in the second column.
- Source System: target EHR that we are attempting to schedule into. For e.g. epic, cerner, meditech etc.
- System Type: dropdown of available integration models used by Kyruus. For e.g. if the Source System value is cerner then select "millennium", if epic then select "epic" from the dropdown.
-
What?
What is the reason for scheduling the online appointment and what is the identifying information for the appointment type in the corresponding EHR?A detailed guide to setting up Appointment purposes can be found in this article- Manually Configuring Individual Appointment Purposes. However, the key thing to note here is that the Visit Type ID field must be a 1:1 match with the visit/appointment ID from the EHR. If this value is wrong or has a typo- Kyruus will fail to retrieve availability for that appointment purpose.
-
Where?
Where is the appointment being serviced and what is the identifying information for this location in the corresponding EHR?
The location(s) linked to the provider record determine where the appointment purpose(s) will be serviced.
- Location ID: Typically the same value as EHR Location ID
- EHR Location ID: location/facility identifier in the EHR.
- Organization ID: optional field for most EHRs, mandatory for some EHRs like Cerner
- Source System Name: target EHR that we are attempting to schedule into. For e.g. epic, cerner, meditech etc. Must be a 1:1 match with the value used within the provider EHR Identifiers as well as the Appointment Purpose.
- Source System Type: dropdown of available integration models used by Kyruus. Must be a 1:1 match with the value used within the provider EHR Identifiers.
The above fields ensure that the Kyruus system can request information with the right identifiers, however there are additional fields that are crucial for actually surfacing the provider on the website:
- Show in Search: This is a Yes/No field which controls whether the provider is shown/searchable on the find-a-doc website.
- Schedule Provider in Search: This is a Yes/No field which controls whether the provider is eligible for online booking. It also drives the "Book Online" button and facet/badge behavior on the provider tile.
- Entity/Resource Type: This is a dropdown field with "provider" or "location" options that allows you to indicate whether the profile is for an actual human provider or a non-human bookable resource (such as an MRI or X-ray room or machine service). This is particularly important for a Cerner Millennium integration and must be set explicitly to "location" for non-human/resource profiles.
In addition to these critical scheduling fields above, there are additional fields that affect scheduling-
Booking Interval Start (Days): days to wait before any availability displays. Today = 1. Example: today is Monday, set to 2 → no availability shows Monday or Tuesday.
Booking Interval Duration (Days): days of availability to display. Today = 1. Example: today is Monday, set to 3 → availability shows Monday–Wednesday through 11:59 PM.
Same Day Limit (Minutes): minutes from the present moment before a patient can see a slot that can be booked. Example: set to 60 → a slot 30 minutes from now won't show, but one 90 minutes out will.
Changing these booking interval fields affects live scheduling calls immediately, but only affects cached availability after the next availability load/refresh.
Practice Email: a BCC copy of the patient confirmation email can be sent to a configurable list per provider. Requires an OTI to set up; applying to all providers for a customer also requires an OTI.