REDCap External Modules OM REDCap External Modules Angelica Allen aallen@kumc.edu Clinical Informatics Specialist Center for Medical Informatics and Enterprise Analytics

Agenda – REDCap External Modules List of External Modules How the Modules will be enabled for your project Module Sections with Instructions REDCap Help Information

External Modules List Auto Populate Fields - This module provides rich control of default values for data entry fields via a set of action tags. These action tags allow fields to be populated based on values from an ordered list of fields and static values. The fields can be read from the current event or the previous event in longitudinal projects. Save Survey PDF to a Field - This module generates a PDF of a survey upon completion and saves it to a REDCap file upload field. It is configured at the project level with source instrument/target field pairs. In the event of save errors, the PDF is sent to a backup email address. Color Matrix - Allows users to change the background color of a matrix of fields on a survey. Specify the matrix choice name and the background HTML color; voila! Field Notes Display - Provides alternative display modes for field notes. This module adds an action tag @FIELD-NOTES-DISPLAY that accepts the following inputs: 'hover' - displays the text when the field is hovered over; 'tooltip' - places a help icon, which displays the text in a tooltip when hovered over; 'popover' - places a help icon, which displays the text in a popover when clicked. Instant Field Concatenation - This module concatenates fields and places the result in another field instantly. It uses JavaScript and not PHP. It happens upon the user leaving the field. Two Column Checks - Reorients a left-vertically-aligned group of checkboxes into two columns - only if more than ten checkboxes exist in the list (surveys only). This will save room on a survey, but note that it requires the checkbox have LV alignment.

How the Modules will be enabled for your project? REDCap Administrator will enable the listed modules globally for all projects. All projects will have the new link to the External Modules under the “Applications” section. Users with Project Design and Setup rights can click on the external Module link. The External Modules – Project Module Manager will appear. Click on the “Enable a module” and select the module you would like to add to your project by clicking on the Enable button. Modules that only need to be added to the project. (No additional configuration) Auto Populate Fields Field Notes Display Two Column Checks Modules that need to be configured for your project. (See Module section for steps.) Save Survey PDF to a Field Color Matrix Instant Field Concatenate

Auto Populate Fields

Auto Populate Fields This will help the end users have a default choice on fields and/or prefill data from a previous event. New Action Tags: @DEFAULT; @DEFAULT-FROM-PREVIOUS-EVENT; Mixing @DEFAULT\<N> AND @DEFAULT-FROM-PREVIOUS-EVENT\<N> NOTE: The @DEFAULT-FROM-PREVIOUS-EVENT tag will only load data from a previous event that data was entered into the instrument. Note that @DEFAULT is synonymous with @DEFAULT_0. Similarly @DEFAULT-FROM-PREVIOUS-EVENT is synonymous with @DEFAULT-FROM-PREVIOUS-EVENT_0. Note that the square brackets, [] common to REDCap piping are neither required nor supported in @DEFAULT-FROM-PREVIOUS-EVENT and @DEFAULT-FROM-PREVIOUS-EVENT_<N>. They are required in @DEFAULT_<N> just like @DEFAULT. All DEFAULT values can be overridden when data is entered into the field!

Auto Populate Fields - @DEFAULT Add action tag to field with the variable in single quotes and no brackets around the variable. Field types – that work with @DEFAULT

Auto Populate Fields - @DEFAULT-FROM-PREVIOUS-EVENT Add action tag to field with the variable in single quotes and no brackets around the variable. Event 1 - Add data to the Month 1 Instrument for Event 1 Event 2 - Month 1 Instrument for Event 2 and data was listed from Event 1. Event 3 - Month 1 Instrument for Event 3 and No data will be listed because Event 2 Instrument was not updated.

Auto Populate Fields - @DEVAULT\<N> AND @DEFAULT-FROM-PREVIOUS-EVENT\<N> Add the choice value with underscore before the equal sign and variable name in single quotes and no brackets around the variable. Event 1 - Add data to the Baseline Data Instrument for Event 1. Event 1- Month 1 Event 1 instrument and Data was not defaulted from the Baseline Data Instrument. Event 2 - Month 1 Instrument for Event 2 and Data was listed from previous event or the default for yes is enabled Event 3 - Month 1 Instrument for Event 3 and Data was listed form previous event or the default for yes is enabled

Save Survey PDF to a Field

Save Survey PDF to a Field This can allow the end users to review initial surveys on another form/survey. Configure the Module Add a KUMC email address to receive the PDF if the system is unable to save it to the instrument. Select the Instrument that will be saved as the Survey PDF Select the field that will hold the uploaded Survey PDF. (Note: The upload PDF field needs to be created before selecting it here. The fields can be incremented to load multiple surveys.)

Save Survey PDF to a Field Add a file upload field to the instrument in your project. Field Type = File Upload (for users to upload files) Variable name = any name Field Label = any label Instrument that holds the uploaded PDF field status will change from no status to Incomplete once the survey has been submitted. Upload PDF field will look like this when the survey has been submitted.

Color Matrix

This can allow the end user to change the look of the Matrix. Color Matrix This can allow the end user to change the look of the Matrix. Configure the Module Matrix fields need to be created before configuring the module. Add the matrix group name. (Note: the matrix needs to be created before adding it here.) Add the color name or HTML Code you would like for the choices and labels. You can find a list of these codes at https://www.w3schools.com/colors/colors_picker.asp Add the background color for each column Increment additional lines for each column background. Matrix headings will not be affected by the module. To change the Matrix heading to a different color you will need to add the HTML into the heading within the field .

Color Matrix

Field Notes Display

Field Notes Display The new Action Tag is used to allow information from the Field Note to be displayed in different ways on the instrument. Once the module is activated on a project, the @FIELD-NOTES-DISPLAY will be available in the action tag help text of the Online Designer. Add @FIELD-NOTES-DISPLAY to any field where you would like to display the field note using one of the three display modes. Specify the display mode you would like to use as a parameter to the action tag. Valid display modes are hover, tooltip, and popover. Provide the content of the field note as usual.

Field Notes Display - @FIELD-NOTES-DISPLAY=“hover” Add a any field type to the instrument(s) in your project. Exception are the Descriptive Text and Begin New Section. These do not have the Field Note available. Field Type = Any except Descriptive or Begin New Section Action Tags = @FIELD-NOTES-DISPLAY=“hover” Field Note = Any information that needs to be displayed The field note only visible when cursor is hover over the field name @FIELD-NOTES-DISPLAY=“hover”

Field Notes Display - @FIELD-NOTES-DISPLAY=“tooltip” Add a any field type to the instrument(s) in your project. Exception are the Descriptive Text and Begin New Section. These do not have the Field Note available. Field Type = Any except Descriptive or Begin New Section Action Tags = @FIELD-NOTES-DISPLAY=“tooltip” Field Note = Any information that needs to be displayed The field note only visible as a tooltip @FIELD-NOTES-DISPLAY=“tooltip”

Field Notes Display - @FIELD-NOTES-DISPLAY=“popover” Add a any field type to the instrument(s) in your project. Exception are the Descriptive Text and Begin New Section. These do not have the Field Note available. Field Type = Any except Descriptive or Begin New Section Action Tags = @FIELD-NOTES-DISPLAY=“popover” Field Note = Any information that needs to be displayed The field note only visible as a popover @FIELD-NOTES-DISPLAY=“popover”

Instant Field Concatenation

Instant Field Concatenation This can allow the end user to combine multiple fields for new information like custom ids, full names, etc... Configure the Module Select the field for the end value from the multiple events. (Note: this needs to be created before selecting it here.) Select the field to add to the end value field. Increment additional fields that will be added to the end value field. Check the box if spaces are needed between values added.

Instant Field Concatenation Add a Multiple Choice or Text Box field to the instrument(s) in your project, that are needed for the Concatenation. Field Type = Multiple Choice or Text Box All Validation in a text box field can be concatenated.

Instant Field Concatenation Concatenation Value Fields. Concatenation Field. Regular piping. Piping from the concatenated field can also be done. Concatenation Fields can also be exported for reports.

Two Column Checks

Two Column Checks Survey Data Entry View Manual Data Entry View Reorients a left-vertically-aligned group of checkboxes into two columns - only if more than ten choices exist in the list (surveys only). This will save room on a survey, but note that it requires the checkbox have LV alignment. Add a checkbox field to your project. Survey Data Entry View Field Type = Checkboxes Custom Alignment = Left/Vertical (LV) Manual Data Entry View Choices =10 or more for the columns to be separated. Note: The alignment of the two columns are only viewable on surveys and not manual data entry.

And… Thank you! Not Exhaustive but: https://redcap.kumc.edu/index.php?action=training misupport@kumc.edu REDCap Lunch & Learns 1st & 3rd Tuesdays 12-1.30PM 3001D Student Center 1on1s after each Lunch and learn available for sign up. Sign up: https://redcap.kumc.edu/surveys/?s=L72oqA Pizza! REDCap at University of Kansas Medical Center is supported by CTSA grant from NCRR and NCATS awarded to the University of Kansas Medical Center for Frontiers: University of Kansas Clinical and Translational Science Institute