This REDCap module facilitates the scheduling and data management of COVID-19 testing for first responders. This project was created by the CTS-IT at the University of Florida to support testing of first responders in Gainesville, Florida and Alachua County.

• REDCap >= 9.3.5
• REDCap Entity >= 2.3.0

• Clone this repo into to <redcap-root>/modules/fr_covidata_v0.0.0.
• Clone redcap_entity repo into <redcap-root>/modules/fr_covidata_v0.0.0.
• Go to Control Center > External Modules, enable REDCap Entity, and then this module. REDCap Entity will be enabled globally, but this module has to be enabled on a per-project basis after Global Configuration is completed.

To configure and use this module, follow these steps:

1. Create a REDCap project from the file First_Responder_COVID19.xml
2. Update the appointments field on the Appointments Form, changing it to a Dynamic SQL field and configuring it to auto-complete. Paste the appropriate code from example/dynamic_sql_query_for_appointment.sql
3. Enable the FR Covidata module as described above
4. Configure the FR Covidata module identify to set Which instrument is used for appointments?
5. Configure the FR Covidata module to indicate which repeat type is used for repeats: Repeating instances or Individual Events
6. Use a MySQL client to load sites data from redcap_entity_test_site_data.sql
7. Adjust the project_ids referenced on those just-loaded sites by editing and running a copy of redcap_entity_test_site_update.sql
8. Generate the initial appointment blocks by accessing Define Sites and clicking Generate future appointments for all sites

This module adds an appointment scheduling feature to REDCap. This feature is built on top of REDCap Entity and a dynamic SQL field. It allows appointment blocks to be selected from a Dynamic SQL field using the built-in auto-completion feature of Dynamic SQL fields. The SQL query queries a table of appointments to generate a list of available appointment blocks. On form save, REDCap writes the appointment_id into the value of the Dynamic SQL field. The module uses the redcap_save_record hook to write the record_id and event_id into the appointment record. The redcap_save_record hook will also update appointment-related fields on the record to provide easy lookups of the site details and date and time of the appointment block.

Once assigned to a person, an appointment block is no longer available. This feature is used in a REDCap survey to allow the first responders to select their appointments.

If the research participant needs to cancel or change an appointment, they must call the Study Team. The study team will access the REDCap project, locate the participant's record, and cancel or replace the existing appointment.

The table of appointments is managed by REDCap Entity.

A site is a COVID-19 testing site. A study coordinator or REDCap admin must define each site before appointment blocks for that site can be created.

REDCap Entity manages the site data. A study coordinator or REDCap admin can populate the site table by accessing the Define Sites page. It allows for CRUD operations on sites for this project.

Each site allows the configuration of a long name, short name, appointment duration, address, open time, close time, closed days of the week, the number of appointment days to build out in advance. The open and close times are bounds on the generation of appointments.

An appointment block is a fixed block of time at a single site. Appointment blocks must be created for a site before a research participant can schedule an appointment at that site.

Appointment block creation is managed by this module. Those scripts can be run manually or automatically. These appointment blocks will be automatically generated nightly or when a study coordinator presses the Generate future appointments for all sites button of the Define sites page.

Appointment block creation uses the appointment horizon, site id, open, close, and appointment duration attributes for each site to generate records in the appointments table. It will generate appointment horizon days of appointment blocks for each site if those blocks do not already exist.

The module will define a cron job that runs daily to assure appointment horizon days of appointment blocks exist at all times.