System Administration
In order to use Coviu's API, you must set up API keys in your account. Under For Developers, there is an API Keys section.
Create the Data Producers
Once you have obtained your credentials, next action will be to create a new data producer.
System Administration > Workflow > Data Producers
Enabled Telehealth via Coviu for appointment types
System Administration > Appointment Types
To visit the main article click: Appointment Types
To configure the appointment type for telehealth system admin need to check Telehealth Enabled via Coviu field. They can either create a new appointment type or modify an existing one.
Note: We recommend setting up specific Telehealth consultation appointment types, so that in person appointments are not accidentally
scheduled as Telehealth.
Appointment Email or SMS
System Administration > Correspondence > Appointment Email or SMS
When an appointment is published to Coviu, links are generated, but not yet accessible.
To share these links with the Patient, you will need to create an appropriate Appointment message (SMS or Email).
The variable to use in templates is patient.telehealth_entry_url.
CareRight provides two default templates, Sms and Email.
CareRight default SMS template:
CareRight default Email template:
Configure Branding settings for Coviu
System Administration > Branding Settings > Coviu
Your Coviu appointments can have branding applied.
Enable Dashboard view:
System Administration > Appointments > User Interface
We recommend enabling Dashboard Show Appointments for easy access by providers to their appointments.
Staff Experience
Create an appointment
When an appointment is created, it is published to the Coviu portal which may take a short period. When it is successfully published, you can verify this via Appointments > Details.
You will see the participants and links:
Updating or cancelling an appointment
If you update or cancel an appointment it flows through automatically to the Coviu platform.
Updates flow through automatically to the Coviu platform.
If required, you may need to inform the patient of any changes, if automated correspondence has already been sent.
Patient Experience
See https://www.coviu.com/en-au/patients#howitworks for more information.
Receive the Link
Once an appointment has been created patient will get secure link to join the session either by SMS or email. If this sent by an email, this will also typically include an iCal invite. Patients can add this to their calendar with one to two clicks on Android or other modern platforms.
Example SMS:
Email Example
Joining the session
Joining the session early:
If the patient or provider join the session early than session start time, they will see a standard message.
Waiting area:
When the scheduled session is ready to commence, the patient proceeds to a waiting area
Provider Experience
Join the Telehealth Session
1. From the Dashboard
We recommend enabling Dashboard Show Appointments for easy access by providers to their appointments. Providers can one-click join the session from dashboard.
Click on the drop down option on the particular appointment system presents the option Join Telehealth Session.
2. From the Patient Record
- From the dashboard.
- Search for a patient.
- Click show.
- Click on the appointment from left side menu.
- Click on the action for particular appointment.
- Click on the Join Telehealth option from drop down.
3. From Appointment details
View Appointments > Details
Accessing your calendar feed from Outlook or Google Calendar
Recommended article: Accessing Calendar Feed.
Provider session view and tools
Providers see the Coviu session embedded in a patient record centric view. On the left, all tools for typical interaction with a patient are available. Tip: Ctrl+Click or Right Click > Open in new Tab to access specific areas while remaining in the call.
If an assessment has been configured, it is available via a Perform Assessment button.
This can be either an assessment performed only by the provider in the call, or if the assessment is a Sharable Assessment; links can be sent to the patient by:
- SMS
- Copied to clipboard (paste in chat)
Further learning
For more detail on using the Coviu telehealth interface, see https://help.coviu.com/knowledge/getting-started-with-coviu