Skip to main content
Version: 9.x (Current)

Appointment Manager

The Appointment Manager is a microservice responsible for handling the organization of availabilities and appointments. Leveraging the CRUD Service, the Messaging Service, the Timer Service, and the Teleconsultation Service, it can be used to control availabilities and appointments creation, update and deletion on their respective CRUD collections and to automatically send messages and reminders to the users involved.

The service can be seen as an enriched proxy to the CRUD: it implements the same interfaces of the CRUD Service allowing you to perform a set of operations on a CRUD collection as you normally would with the CRUD Service itself. On top of that it can be configured to handle messages and reminders functionalities.

The service assumes that the users involved in an appointment are contained in one or more attributes of the appointment itself. For example, an appointment related to a medical visit may have the following structure:

{
"other_props": "...",
"doctor": "doctor_id",
"patients": ["patient_id_1"]
}

In this example, the users involved in the appointment are categorized in doctor and patients and contained in two different attributes.

The service gives you complete freedom in deciding to which category of users you want to add to a teleconsultation, or to send messages for each appointment lifecycle phase (creation, update or deletion).

To do so, you can leverage the users property of the service configuration. Here you can specify the category of users you want to use, along with their properties for the messaging service.

Using the previous example, the configuration file for the service involving one doctor and a list of patients will be:

{
"users": {
"doctor": {...},
"patients": {...}
}
}
note

These categories can contain additional properties that are useful only when using the messaging service, and can be left blank otherwise

Sending messages

Whenever you create, update or delete an appointment, you may want to send a specific message to the users involved in the event.

caution

In order to send messages you will need to deploy an instance of the Messaging Service and to correctly configure the environment variables.

Users are defined in the users property of the service configuration This property is a map having as key the category of users you want to send messages to and as value another map linking a message template id (see Messaging Service documentation for more information) to each appointment lifecycle phase.

In response of each change in the appointment lifecycle the service will send a message to each user category that has a template id specified for that phase in the configuration. If a category is not in the configuration, or it does not have a template id for that phase, it will simply not receive the message.

For example, consider the appointment of the last example and the following configuration.

{
"users": {
"doctor": {
"create": "doctor_create_message_template_id",
"delete": "doctor_delete_message_template_id"
},
"patients": {
"create": "patient_create_message_template_id",
"update": "patient_update_message_template_id",
"delete": "patients_delete_message_template_id"
}
}
}

When the appointment is created, both the doctor and the patients involved will receive a message using the dedicated template id.

When the appointment is updated, only the patients involved will receive a message using the dedicated template id.

When the appointment is deleted, both the doctor and the patients involved will receive a message using the dedicated template id.

For more details on how messages are sent in each phase of the lifecycle, see the usage section.

Setting reminders

When you create a new appointment, the service may set a reminder to send a message to the involved users a certain amount of time before the appointment date.

caution

In order to send messages you will need to deploy an instance of the Messaging Service and an instance of the Timer Service, as well as to correctly configure the environment variables.

To trigger the setting of reminders you need to provide a value to the reminderMilliseconds property of your appointment (see the CRUD section for more information).

tip

You can update the reminders by passing a new value for the reminderMilliseconds property in an update request.

tip

You can abort all the set reminders for an appointment by unsetting the reminderMilliseconds property in an update request.

tip

You can avoid sending reminders for appointments created/updated below a given threshold by setting the reminderThresholdMs field in the configuration file (see the CRUD section for more information).

As for messages, the service uses its configuration to know which users categories should receive reminders.

Going back to the example above, we can consider this appointment

{
"other_props": "...",
"doctor": "doctor_id",
"patients": ["patient_id_1"]
}

and this enriched configuration

{
"users": {
"doctor": {
"create": "doctor_create_message_template_id",
"delete": "doctor_delete_message_template_id"
},
"patients": {
"create": "patient_create_message_template_id",
"update": "patient_update_message_template_id",
"delete": "patients_delete_message_template_id",
"reminder": "patients_reminder_message_template_id"
}
}
}

When the appointment is created, a reminder will be scheduled for the patients involved, which will receive a message using the dedicated template id.

When the appointment is updated, if the date of the appointment or the reminder milliseconds have been updated, the reminders scheduled for the patients will be rescheduled.

When the appointment is deleted, the reminders scheduled for the patients will be aborted.

Availabilities

The Appointment Manager can also manage availabilities, in order to allow booking an appointment only if a time slot is available.

An availability can be represented as a sort of matrix, where the matrix rows represent different time slots, and the columns represents simultaneous slots.

For instance, an availability from 9:00 am to 10:30 with 30 minutes slot duration and 2 simultaneous slots can be represented as follows:

start dateslotIdslotId
9:00slot_1slot_2
9:30slot_3slot_4
10:00slot_5slot_6

A user who wants to book an appointment in a given slot must first lock the slot, and then book the appointment by passing the reference of the locked slot.

Recurrent availabilities

Availabilities can also be created in the form of recurring events, in order to allow replicating the same availability without inserting it multiple times. When an availability is set as recurrent, the appointment manager create different availabilities entries in the CRUD according to the recurrence parameters.

For instance, if an availability is set to be repeated each first day of the week for four weeks, four different availabilities are created in the availability collection.

An UUID is added to all the availabilities that belongs to the same recurrence, in order to maintain the relation between them.

Availabilities that belongs to the same recurrence share the same additional properties inside each single slot, and the same number of slots. The start and end date are instead computed according to the recurrence parameters.