.heading-expand-header { cursor: pointer; }
	.heading-arrow { color: #e87500; }

	body { color: black; }


The goal of this tutorial is to show how to use the Institutional Review Board (IRB) approved electronic consent form template in REDCap. REDCap allows for the ability to send the consent from as a survey link via email and can capture participants’ information and electronic signatures.

Setting up a New Project

Create Project from Template

  1. Navigate to https://redcap.utdallas.edu and log-in using your NetID and password.

  2. Create a new project by clicking "+New Project"

  3. Enter the following project relevant information:
    1. Project Title
    2. Select Research from the ‘Purpose of this project’ drop-down menu
    3. Administrative details of the project such as the name of the P.I., email, IRB number, etc.
    4. Specify the type of research that best applies

  4. Under the section Start project from scratch or begin with template, select the IRB: Consent to Participate in Research (PI Signature Required) and click ‘Create Project.’

Enable Alerts & Notifications

This template uses a pre-configured "alert" to send participants an email with a PDF copy of their signed consent. When the project is first created, the alert is deactivated and must be re-enabled.

  1. Navigate to Alerts & Notifications

  2. Click the checkbox 'Show deactivated alerts'. When the box is checked, a pre-configured alert will appear. In the Options drop-down, select 'Re-enable alert' to enable the alert.

  3. Be sure to un-check the checkbox to see the newly activated alert.

  4. (Optional) Edit the alert to customize the email message. For example, you may want to add a Lab or Study name in the body of the email. Note: DO NOT edit the "trigger alert" logic, the "Email To" field, or the "File Upload Field". If these settings are altered, the email may not send as expected.

Add Users and Define User Rights

Add users to the project and define their access rights by assigning them pre-defined user roles. Each role has pre-defined project access rights. Note: It is recommended to review and update who has access to the project throughout the duration of the study.

  1. Navigate to User Rights.

  2.  Type a user’s NetID or name in the ‘Assign new user’ box. Select the correct user from the drop-down and click relative role to complete adding the user to the project. Note: Users need to log in to REDCap at least once before they can be added to a project.

  3. See the image below to view the access rights which pertain to each role.
    1. Lab Manager Role: Have complete control and access to the project. They have access to identifiable information.
    2. Data Collector Role: Have the ability to create, view, and edit records. Data is de-identified when performing data exports.

Modify Consent Language

Modify the language in the consent so that it is specific to your project. 

  1. Navigate to the Online Designer

  2. (Optional) Click 'Choose action' and select 'Rename' to rename the form. 

  3. Click on the instrument name to modify the language in the consent. 

  4. Edit a field by clicking the pencil icon. Note: Text in red requires modification.

  5. Click the full-screen icon to widen the window to better edit the content. Be sure to click 'Save' to commit any changes.

  6. The form contains fields for the Research personnel's name, signature, and date; these fields are hidden from the participant when they are filling out the e-consent form. 

Change Project Status to Production

When the project is ready to go live, and you have tested that the project logic behaves as expected,  you must request that the project be moved to 'Production'.  Moving the project to production status requires the completion of seven steps located in the ‘Project Setup’ page. Note: Any changes made to a project in Production must be approved by a REDCap admin to protect the integrity of any collected data. 

  1. Click ‘Project Setup’

  2. Scroll through the Project Setup page and click the 'I'm done!' buttons for each section as a check-list to ensure you've tested all functionality. 

  3. At the bottom of the page, click the button 'Move project to production'

  4. Select ‘Keep ALL data saved so far’ or ‘Delete ALL data, calendar events, documents uploaded for records/responses, survey responses (if applicable), and any logging events pertaining to data collection.’ If ‘Delete ALL data… ‘ is selected, a message box will open to confirm that you want to delete all the data. Click Yes, ‘Move Project to production’.

  5. After requesting to move a project to Production, you will receive a questionnaire via email to ensure you've fully tested the project. Once a REDCap Administrator approves the project's move to Production, you will be notified via email.

Signatures & Consent Copy

Add Researcher Signature

After the participant completes the survey, the researcher/PI needs to access the record to input their information, signature, and to trigger an email with the attached consent.

  1. After the participant completes the survey, click on Record Status Dashboard.

  2. Click the Status icon for the 'Consent to participate in Research' instrument that belongs to the new record. 

  3. Click 'Edit response.'

  4. Complete the following fields:
    1. Name of Researcher Obtaining Consent
    2. Signature of Researcher Obtaining Consent
    3. Date
    4. Click the '
  5. Click the button 'Save & and Exit Record' to save.

Access Consent Copy

  1. Click Record Status Dashboard to access record.

  2. Click the Status icon for the 'Participant PDF Consent form' instrument that belongs to the new record. 

  3. Click on the link located under Record ID named Completed_Consent_PDF_xxx_xxx_xxx.pdf to download the PDF.

Participant's Consent Copy via Email

  1. After research personnel, sign, date, and click the '

  2. See below for a preview of what the PDF looks like.

Consent Comprehension Questions

The following information only applies to IRB protocols that require comprehension questions to be included as part of the e-consent.

If an IRB protocol requires comprehension questions as part of the e-consent, extra steps are required to configure the project. Researchers must configure their project to impede participants from submitting their e-consent until they have answered the comprehensions questions correctly. To enable these features in REDCap please follow the steps below.

Add Comprehension Questions

  1. Modify the comprehension question fields by clicking the edit pencil. DO NOT modify the 'shazam_1 field' or the 'correct_answer_total' field. These fields are used for branching logic and the Shazam module.

  2.  Replace the field label text with the comprehension question.

  3. In the answer 'Choices' section, replace the answers. Be sure to input the "wrong" and "correct" answer choices as described in the field. DO NOT change the variable name because it will break branching logic and the Shazam module.

  4. Repeat steps 1-3 for the rest of the comprehension questions.

  5. You may modify the text in the 'incorrect_answer' and 'correct_answer' fields but DO NOT change the branching logic or the variable names.

Enable and Configure the Shazam Module

Enabling the Shazam module will introduce the programming framework necessary to impede participants from submitting their e-consent until they have answered the comprehension questions correctly.

Enable Shazam

  1. Click on External Modules located in Applications section of the left menu pane.

  2. Click 'Enable a module.'

  3. Find the Paper Trail and Shazam modules and enable them by clicking the 'Enable' button.

  4. You should see the two modules in the "Currently Enabled Modules" list.

Configure Shazam

In the case of this template, the module Shazam is used to modify the look of a survey with CSS code and introduces the ability that prohibits participants to submit the consent without answering all of the questions to test their comprehension of the consent correctly. 

  1. After enabling the shazam module, on the left menu bar, select "Shazam Setup"

  2. Click "Add Shazam Field" and select the variable "shazam_js_1".

  3. Enable the "shazam_js_1" variable and copy and paste the following code:
    1. Under CSS tab paste this code: CSS for Button.txt

    2. Under the JS tab paste this code: JS for Button.txt

For more information, please visit our website REDCap or send us an Email.

For IRB specific questions, please email: irb@utdallas.edu