This article outlines how developers can streamline the patient/client entry flow into a Waiting Area.
Who is this article aimed at:
This article is aimed at customers who have some software develpment skills and/or access to their own software developers. It would also require an understanding of and access to your referring system e.g. your PMS/EMR/booking system.
This feature should not require any intevention by Coviu staff.
Last Updated: August 2024
On this page:
About
Coviu’s Waiting Area workflow provides support for external systems to streamline the entry of a patient into a Waiting Area where the information about the patient is already known by the referring system e.g. your PMS/EMR/Booking system.
This allows for the creation of more advanced and efficient entry workflows into a Coviu waiting area - without the more difficult technical requirements of a direct integration with Coviu’s APIs.
Some scenarios that this allows for:
-
Pre-filling of known patient details required for call entry, such as their name
-
Pre-filling clinic specific details that the patient does not need to be aware of, such as workflow IDs, where a custom entry field is configured
-
Automatically joining the queue (bypassing the entry form) where all required information has been provided
These parameters are provided as query string parameters to the waiting area URL - this URL can then be provided to a patient to allow them to access the clinic waiting area.
Note about PII
If using Waiting Area parameters, it’s important to note that patient PII (such as their name) will be included in the waiting area URL. As such, you should take steps to ensure that the URL is provided only to the patient, or to people authorised to view that information.
Pre-requisites
URL pre-filling according to this guide is only available to Waiting Area join flows. User room and unique sessions are not supported.
Basic/standard parameters
The following are standard parameters supported by all Waiting Areas:
-
firstName -
lastName -
aj=1-
Queue auto joining. When set, this will skip any call setup screens (such as the camera, microphone and speaker tests), and go straight into the queue if all required fields have been provided. If required fields have not been provided, the patient will be prompted to enter any missing before joining the queue.
-
Custom parameters
Coviu allows clinics to configure their own set of custom entry fields that a patient is prompted to enter prior to joining the queue. These can also take advantage of prefilling.
To do, the following is required:
-
A custom entry field will need to be configured for the clinic Waiting Area, and you will need to know the name of the field
-
The entry field cannot be “Internal Use Only”, but hidden fields are acceptable.
To provide a custom field value for pre-filling, the custom field values will go into to “additional” URL parameter, as URL-encoded JSON strings.
Examples
Let’s take the example of a custom field with the name myehrappointmentid, which is to be displayed to clinical staff when they are viewing the call on the Waiting Area dashboard management page.
This value for the appointment ID go in the “additional” URL param, as URL-encoded JSON.
JSON:
1 {"myehrappointmentid":"12345"}
URL encoded version:
1 %7B%22myehrappointmentid%22%3A%2212345%22%7DThis would result in a link that looks like the following:
-
https://yourteam.coviu.com/join?firstName=frog&additional={"myehrappointmentid"%3A"12345"}
More support options
You have completed another Coviu help article. You now know how to make your patient/client Waiting Area flow a llittle easier.
If this is not what you were looking for, explore our knowledge base and search for another article from here.
If you still require any assistance, please do not hesitate to get in touch with our friendly Customer Success team using any of the contact methods available here.
Author: KM