Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. 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

image-20250130-184020.png


    2. The new copy will appear at the bottom of the instrument list. Move the new copy underneath the old instrument. 

Update New Instrument

  1. Click on the new instrument to open it.  

  2. Delete the blank PDF file download field. Downloads will be automatically available in the new framework. 

  3. 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.)

  4. 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.   

  5. Create a new text field that will automatically capture the REDCap consent version

    1. Add @CONSENT-VERSION @HIDDEN-SURVEY @HIDDEN-PDF action tags to the field

  6. Add versioned branching logic to fields requiring participant response

  7. Review all other branching logic on new instrument 

    1. Ex: Branching logic that participants can only provide a signature after selecting they would like to participate 

  8. Rename former instrument and survey title

...

Review and Submit Changes  


Image RemovedImage Added

  1. Review changes (located under Designer, on the top left of the webpage ) 

  2. Click View detailed summary of all drafted changes and verify that you have made all appropriate additions 

  3. 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.  

    1. If there are potentially critical issues indicated in red, you must correct them before all changes are moved to production  

      Image RemovedImage Added

    2. Example of potential critical issue – deleting an existing field or renaming answer choices that will result in data loss  

    3. A detailed breakdown of all changes is available in the Below is a listing of the changes to be committed to this project. table 

    4. If you submit changes with at least one critical issue, the RDCRN REDCap admin will ask you to confirm this is what you want 

  4. Click Return to Previous Page and Submit Changes for Review 

  5. Click Submit – changes will be automatically implemented if done correctly


Image RemovedImage Added


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.  

...

Designate Instruments to Events


Image RemovedImage Added

  1. Click Project Setup 

  2. Click Designate Instruments for My Events


Image RemovedImage Added

  1. Click Begin Editing 

  2. Select the new instrument(s) for all events 

  3. Click Save 

...

Located in the Designer in the grey box above the instrument list 


Image RemovedImage Added

  1. Export the current Survey Queue and save as part of change management documentation 

  2. Click Survey Queue 

  3. Click Activate next to new instrument(s)  

  4. Set up the survey queue logic for the new instrument(s) 

    1. 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.). 

    2. Copy and paste the survey queue logic of the former instrument to the new instrument. If needed, update logic to reflect new field names. 

    3. Select Auto Start option if being used 

  5. Click Deactivate on the former instrument survey queue setting 

  6. Verify the logic for any other instruments in that event is still accurate  

...

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 


Image RemovedImage Added

Update eConsent Framework

...

Retire Former Instrument(s)


Image RemovedImage Added

  1. Click on Survey Settings of the former, now inactive instrument

  2. Set Survey Status to Survey Offline 

  3. Click Save Changes

...