Author: Audrey Perdew
As of February 2025, RDCRN REDCap will be updated to a version that includes the new Enhanced eConsent Framework, commonly referred to as eConsent 2.0. This article provides guidance on how to transition existing REDCap projects from eConsent 1.0 to 2.0. Major differences include:
eConsent framework configuration has moved out of Survey Settings to a specific eConsent and PDF Snapshots feature available through the Designer.
During the setup process for consent forms, their location can be set in relation to a single descriptive field on the survey.
A consent form can be associated with a specific language and/or a Data Access Group.
Improved version control for easily managing new versions of consent forms while maintaining historical versions for audit purposes.
PDF Snapshots that can combine multiple forms and/or signatures into a single PDF document.
Important notes about the installation of these new features:
No immediate changes are needed. Existing eConsent projects will migrate necessary settings automatically with no interruptions to eConsenting.
eConsent 2.0 enhancements will be apparent during project setup the next time a new version of a consent document is implemented or you choose to transition to take advantage of the new features.
The participant experience will be unaffected upon initial installation of eConsent 2.0. Transitioning your project to eConsent 2.0 will not significantly impact patient experience but may include minor changes in the look and feel of the elCFs.
Each consent document will have its own unique instrument. This REDCap instrument will be used for all versions of its corresponding paper form moving forward.
Copy the existing instrument that requires a new version
Find the instrument that requires a new version in the Designer
Click Choose action and Copy
Update the instrument’s name – do not specify a version in the instrument name
Verify addendum of your choice to variable names (ex: “_v2”)
Click Copy Instrument
2. The new copy will appear at the bottom of the instrument list. Move the new copy underneath the old instrument.
Click on the new instrument to open it.
Delete the blank PDF file download field. Downloads will be automatically available in the new framework.
Delete all fields that display consent inline images. Make sure to keep all fields that require participant responses (i.e. signatures, multiple choice questions, etc.)
Create a new, empty descriptive text field where you want the consent form to be. This will be used later to display the new consent form.
Create a new text field that will automatically capture the REDCap consent version
Add @CONSENT-VERSION @HIDDEN-SURVEY @HIDDEN-PDF action tags to the field
Add versioned branching logic to fields requiring participant response
Review all other branching logic on new instrument
Ex: Branching logic that participants can only provide a signature after selecting they would like to participate
Rename former instrument and survey title
Repeat Steps 1-10 for each instrument
Open the “Individual Obtaining Consent” form in the Designer
Click the green arrow, branching logic icon on the staff name or signature field
Keep the existing logic, and add a condition for the corresponding new consent instrument being complete
Repeat for each staff name and signature field
Review changes (located under Designer, on the top left of the webpage )
Click View detailed summary of all drafted changes and verify that you have made all appropriate additions
Review Details regarding all changes made in Draft Mode:. You should see the appropriate number of Fields to be added: and Total potentially critical issues: should equal 0.
If there are potentially critical issues indicated in red, you must correct them before all changes are moved to production
Example of potential critical issue – deleting an existing field or renaming answer choices that will result in data loss
A detailed breakdown of all changes is available in the Below is a listing of the changes to be committed to this project. table
If you submit changes with at least one critical issue, the RDCRN REDCap admin will ask you to confirm this is what you want
Click Return to Previous Page and Submit Changes for Review
Click Submit – changes will be automatically implemented if done correctly
NOTE: The new instruments are now in production. They are not fully functional and cannot be used by participants until the rest of the following sections are also competed.
Click Survey settings located to the right of the new instrument’s name in the Designer
Confirm Survey Status is set to Survey Active
Change Survey Title if applicable
Confirm general survey settings of the former instrument copied to the new instrument
Send Confirmation Email
Confirm that Send confirmation email? is set to Yes
Confirm the Include PDF of completed survey as attachment box is checked
Confirm or update the email message with the IRB approved message
Verify that the other settings are appropriately configured
Save all Survey Settings
Repeat for each new instrument
The new instruments must be in production for this step. If they are not, go back to Review and Submit Changes
Update User Rights to have access to the new instrument
Select Read Only radio button for new consent instrument under the Data Entry Rights on the right-hand side
Confirm the Edit survey responses box is unchecked
Repeat for each role
Click Project Setup
Click Designate Instruments for My Events
Click Begin Editing
Select the new instrument(s) for all events
Click Save
Located in the Designer in the grey box above the instrument list
Export the current Survey Queue and save as part of change management documentation
Click Survey Queue
Click Activate next to new instrument(s)
Set up the survey queue logic for the new instrument(s)
Select appropriate instrument from drop down menu. Pay special attention to select the correct instrument version from the correct event (e.g. Consent, Re-consent 1, PRN Consent 1, etc.).
Copy and paste the survey queue logic of the former instrument to the new instrument. If needed, update logic to reflect new field names.
Select Auto Start option if being used
Click Deactivate on the former instrument survey queue setting
Verify the logic for any other instruments in that event is still accurate
Repeat for each new instrument in each event
Click Save
Export updated Survey Queue and save as part of change management documentation
eConsent framework settings are no longer located in Survey Settings. Instead, they are located in the Designer in the grey box above the instrument list
Click Enable the e-Consent Framework for a survey
Select the new instrument from the dropdown list
Complete configuration settings
Verify that the Allow eConsent responses to be edited by users? checkbox is unchecked
Select first name, last name, and date of birth fields from the Landing Page
Add IRB approved version # as a Custom tag
Select all signature field(s)
Optional: Static PDFs of completed consents will always be saved to the File Repository, but you may also select a field in the project a PDF of the completed instrument
Update any other configurations as desired
Click Save
Repeat for each new instrument
Click Add consent form
Enter consent form version
Select the new descriptive field created during Update New Instrument for placement of the consent form
Click Consent Form (Inline PDF)
Upload the new consent document. The file must be a PDF.
Click Add new consent form
Repeat for each new instrument
Click on Survey Settings of the former, now inactive instrument
Set Survey Status to Survey Offline
Click Save Changes
Repeat for each inactive instrument
Optional: Organize the retired instrument(s)
Enter Draft Mode
Drag and drop the instrument(s) to your desired placement on the instrument list
Repeat steps above to Review and Submit Changes
Site users and the study eConsent management team members should test the functionality and verify the updated verbiage and logic
Run a few test records through the updated workflow.
Test records will appear as real records. Use an obvious and unique naming convention for the Local ID (e.g. TEST-001) so these records can be easily identified
When doing test data entry, enter study staff information or obvious fake information (i.e. Participant’s name: First-test Last-test) to emphasize again that these are test records
Test records should not be deleted from the eConsent project. They are useful to have and keep as documentation of testing