Page History

REDCap 15.0.9 Release Notes

Scheduled Upgrade Date: Wednesday, February 19, 4:45 PM – 7:00 PM (ET)

The REDCap 15.0.9 upgrade introduces new features, API enhancements, performance improvements, and eConsent 2.0. Below is a comprehensive list of changes in this release.

1. Artificial Intelligence (AI) Services. (NOT Yet Available in our Instance) 

Overview:

• REDCap can now integrate with an Azure OpenAI instance of ChatGPT to enhance text-based tasks.
• Private Endpoint Model: The AI is hosted on your institution’s Azure environment, ensuring security.
• Financial Considerations: Usage is billed to your institution’s Azure account.
• Project-Level Overrides: You can globally disable or configure AI, or override the config on a per-project basis.

Key AI Features

1. Writing Tools in the Rich Text Editor:
   • A magic wand icon appears in the editor toolbar.
   • Allows you to refine text (tone, length, reading difficulty, etc.).
2. Summarize Text in Reports:
   • Next to free-form text fields, a “Summarize” button can generate an AI-based summary.
3. Auto-Translate in MLM:
   • A button appears on the MLM page to automatically translate any untranslated text (if the institution has AI configured).

...

2. Enhanced e-Consent Framework & PDF Snapshot Functionality

New "Settings for e-Consent & PDF Snapshots" Page:

• Consolidates all e-Consent and PDF Snapshot options in one place (linked from Online Designer).

Key eConsent 2.0 Features:

1. Multi-Form Consents:
   • Combine multiple instruments or signatures into a single PDF.
2. Logic-Based PDF Snapshot Triggers:
   • Automatically generate snapshots when a specified condition is met (e.g., data import, saving a form, etc.).
3. Re-Triggering Snapshots:
   • Users with proper privileges can manually re-run snapshot triggers via a “Trigger Snapshots” link.
4. Vault Storage Integration:
   • If your institution uses the external e-Consent Vault, e-Consent PDFs can automatically be stored externally.
5. Customizable File Names & Headers/Footers:
   • Use piped text, timestamps, or custom text in PDF file names or in PDF headers/footers.
6. Improved Audit Trails:
   • Consent completions & PDF generations are now more thoroughly logged.

Benefits:

• Streamlined Consent Process: Enhances both participant and researcher workflows.
• Compliance & Security: Satisfies regulatory requirements (ICH, FDA) with version control and robust tracking.

...

3. Longitudinal Functionality for MyCap-Enabled Projects

• In prior versions, MyCap was disabled for longitudinal projects.
• Now supports multiple arms/events in MyCap:
  • If you have an existing MyCap project, a "transition" button on the MyCap Participants page allows migration to the new MyCap apps.
  • The older MyCap Classic apps remain available but do not support advanced (longitudinal) features.

Additional MyCap Enhancements

• New MyCap Action Tags:
  • @MC-PARTICIPANT-CODE: Captures participant’s unique MyCap code.
  • @MC-PARTICIPANT-JOINDATE: Captures date/time a participant installs MyCap for the project (requires date/time validation).

...

4. New Built-In PDF Viewer

• Addresses the long-standing gap where iOS/Android devices could only display the first PDF page inline.
• Automatic Fallback: If the device lacks a native PDF viewer, REDCap uses its built-in viewer. Otherwise, it uses the device's native viewer.
• Inline PDF on e-Consent: Previously displayed “This browser does not support inline PDFs” for certain devices. Now it’s always displayed inline.

Applies to:

• Descriptive fields
• File Upload fields using the @INLINE action tag
• e-Consent certification pages

...

5. Background Data Import (Large Files)

• Asynchronous Data Import: Large files can be uploaded without freezing the user interface.
• One Record at a Time: If any record fails validation, that record’s data is skipped, preserving data integrity.
• Error Handling & Retry: On import completion, errors are summarized. You can download a list of failed records, fix them, and re-import.
• Email Notification: REDCap emails the uploader once the import finishes.
• Cancellation: Ongoing imports can be canceled, though any data already imported remains.
• Currently UI-Only: Future updates may offer an API-based background import method.

...

6. Multi-Language Management (MLM) Overhaul

• New Workflow for Adding Languages:
  • Projects can “subscribe” to system-wide languages, so changes made centrally appear in subscribed projects.
  • Admins can restrict how new languages are initialized: from system languages, from language files, or from scratch.
• Redesigned Editing & Updating:
  • “Edit Language” (rename, notes) is separate from “Update Language” (sync or import translations).
• Auto-Translation with AI (if AI is configured):
  • A single button can rapidly fill in untranslated text.
• ASI Language Source Default: Now defaults to “Language Preference Field” instead of “User’s or survey respondent’s active language.”

...

7. Additional redcap_data Tables (Horizontal Scaling)

• Four Data Tables: redcap_data, redcap_data2, redcap_data3, redcap_data4 for storing project data, assigned automatically.
• Only Affects New Projects: Existing projects stay in redcap_data.
• Dynamic SQL Fields: Use the new [data-table] Smart Variable instead of hard-coding a table name.
• Move Project Data Page:
  • Admins can relocate an existing project’s data to a different table if performance issues arise.
  • The process is transactional—rolls back if an error is detected.

Developer Method: REDCap::getDataTable($pid) to retrieve the correct data table name for a given project.

...

8. Bulk Record Delete

• Two Deletion Modes:
  1. Entire Records (requires “Delete Records” privilege).
  2. Partial Data (by instrument) across multiple records (requires “Delete Records” + instrument “View & Edit”).
• Access Points:
  • Other Functionality page.
  • Record Status Dashboard → Multi-Record Actions dropdown.
• GDPR & Reason for Change Options:
  • If your project has “Delete a record’s logging activity…” or “Require reason for change” enabled, relevant prompts appear.
• System Setting: Bulk Record Delete can be disabled in the Control Center if needed.
• Data Deletion Limitations: E.g., locked forms, completed e-Consent, or disabled editing for survey data.

...

9. New "Test Run" Option for Re-evaluating Alerts & ASIs

• Dry Run: Simulate scheduling/sending of alerts/invitations without actually committing changes.
• Confidence: Users see exactly how many records would be affected before performing a real re-evaluation.
• CSV Download: Option to download a list of all records impacted, whether test or real run.

...

10. Rapid Retrieval Caching

• Page-Level Caching: Known slow pages—Reports, Record Status Dashboard, etc.—can load from a cache for speed.
• Transparently Enabled: A note “Page speed was boosted using Rapid Retrieval” is displayed if a cached result is used.
• Clearing/Disabling:
  • Project-level: “Clear all record & page caches” in Other Functionality.
  • System-level: The Admin can disable or configure it in the Control Center.
• File-Based vs. Database Storage: By default, it stores cached files on the server, but can optionally store them in the DB.

...

11. New Read Replica Server Feature

• If your REDCap server experiences routine slowness:
  • You can configure a secondary read-only database server.
  • Read operations (reports, logging exports, record dashboards) will use the replica, reducing load on the primary.
• Minimal Setup: The hardest part is spinning up a properly replicating MySQL/MariaDB server.
• Recommended for: Larger institutions or those with heavy usage.

...

12. Randomization Enhancements

Multiple Models & Blinded Allocation

• You can define more than one randomization model in a single project.
• Blinded or Open randomization options:
  • Blinded uses a text field to store the randomization number.
  • Open uses a multiple-choice field (radio, dropdown).

New Smart Variables: [rand-number], [rand-time], [rand-utc-time]

• Accept :value to return a raw datetime string.
• :n if multiple randomization models exist.

API & Hook Enhancements

• "Randomize Record" API method.
• Hook: redcap_module_randomize_record to run custom code prior to randomization.

Real-Time Trigger Logic

• Automated randomization upon saving a form if the logic condition is met.

Admin Options (rare/unexpected cases)

• Manually randomize a record, un-randomize, or remove/alter existing allocations.

...

13. Other Notable Features & Improvements

1. Descriptive Popups:

   • A new way to display small pop-up text boxes on hover, integrated from the “Inline Descriptive Popup” External Module.
   • Configurable for all instruments or per instrument/page.

2. Draft Preview Mode:

   • Preview forms with drafted changes as if live, storing ephemeral data in your session. No data is saved to the project.
   • Limitations: No record creation, data changes are transient, etc.

3. AI Writing Tools (Reiterated):

   • Summarize or refine text within the Rich Text Editor.

4. Security & Cookie Policy Updates:

   • “SameSite=Strict” default for cookies, improved 2FA OTP encryption.
   • Newly added “cookie policy” link in the REDCap footer.

5. Mobile Toolbox (MTB) MyCap Measures:

   • Additional cognitive/behavior tasks for MyCap.

6. Additional UI & Accessibility:

   • Color contrast improvements.
   • Control Center and Home Page reworks with more clarity.

7. Multiple Shibboleth / SSO IdPs:

   • Institutions can define multiple identity providers for Shibboleth auth.

8. Improved Database Query Tool:

   • “Smart Variables Context” can be used in queries.
   • Admin can open the DQT from specific pages with the project’s context pre-filled.

9. Enhanced External Module Framework:

   • More robust scanning for security & composer conflicts.
   • Support for local twig templates.

API Enhancements & Connection Stability Updates

Expanded Read Replica Usage for API Exports(Prevents API Timeouts & Connection Drops)

• All API export methods now use the Read Replica database if enabled.

• Faster API response times and reduced primary database load.

Rapid Retrieval Caching for API Exports(Speeds Up Large Data Retrievals)

• API calls for Export Records and Export Reports now reuse cached results.

• Prevents excessive query execution times, reducing API timeouts.

New Background Process for Terminating Stale Queries(Prevents API Session Failures)

• A cron job now runs every few minutes to identify and terminate abandoned queries left running by API users.

• Prevents stuck API sessions that could interfere with new requests.

New "Randomize Record" API Method

• Allows API users to randomize records programmatically.

• Requires parameters: content="record", action="randomize", record=Record Name, randomization_id=Target Field/Event ID.

• Returns: Assigned randomization value or error message.

CDIS API Enhancements(FHIR Validation & New Endpoints)

• FHIR resource validation ensures only supported resources can be retrieved via API.

• New FHIR endpoints: Appointments, Procedures, Medical History, Diagnoses, Device Implants.

Future API Support for Background Data Import(Planned Enhancement)

• Currently, background data import is UI-only.

• Future API updates may allow for asynchronous data imports without API timeouts.

Performance & Usability Enhancements

✔ New Background Process for Pruning Stale Database Queries(Prevents Zombie Sessions)
✔ Survey QR Code Enhancements: Copy, download, and high-resolution SVG support.
✔ File Upload Enhancements: Full file name visibility when hovering over the download link.
✔ Data Import Tool: Now allows tab and semicolon-delimited templates.
✔ Rich Text Editor Upgraded(Now Uses TinyMCE v6).
✔ Updated Help & FAQ Page(Expanded with new documentation from the FAQ Committee).
✔ UI Fixes for Bootstrap 5 Compatibility(Improves system-wide consistency).

New Action Tags

✔ @MC-PARTICIPANT-CODE – Captures the MyCap participant's unique ID when joining via MyCap mobile app.
✔ @MC-PARTICIPANT-JOINDATE – Captures the exact date and time a MyCap participant joins a project.
✔ @SHOWCHOICE – Restricts multiple-choice fields to only display specified choices dynamically.

New Math & Text Functions

✔ Math Functions: mod(dividend, divisor), exponential(number).
✔ String Functions: replace_text(haystack, search, replace), concat_ws(separator, text, text, ...).
✔ New Date Piping Functions: year([dob]), month([visit_datetime]), day([visit_date]).

Dear REDCap Users,

Please note that on Thursday, September 30th 29th REDCap will be down after normal business hours from 6:00 pm to 7:00 pm EST for planned maintenance and an upgrade to 12.4.7. The upgrade will bring more functionality and system improvement to REDCap. REDCap will be upgraded to 12.4.7.

A changelog and summary of new features can be found here: 

...

Thank you in advance for your patience.

Maxx M Somers, MA

Cincinnati Children’s Hospital Medical Center

Information Services For Research (IS4R)

Senior Project Manager, IS

REDCap Program Manager

Maxx.Somers@cchmc.org

859-866-0653Maxx 

NEW FEATURES, IMPROVEMENTS/CHANGES & BUG FIXES;

...

REDCap Update Summary

...

New API method: “Import Repeating Instruments and Events” – Allows users to import a list of the repeated instruments and repeating events for a project as a means of setting which instruments and events should be repeatable.

REDCap Update User Summary
REDCap will be down for a planned outage from5:00pm to7:00pm EDT onMonday October 8th. We will be updating to REDCap 8.5.13.

...