1.8.3 Web Client Enhancements
Table of Contents
Highlights of New Features2
Major Query Status Redesign2
Expanded Admin Tool - Administration & Configuration Tool2
New Monitor Dashboard - Activity & Usage Monitoring Tool3
Improvements to the Login UI3
New Web Client Configurations4
Detailed Documentation on New Features4
Major Query Status Redesign4
Default Visualizations4
Optional Visualizations9
Mapping Visualizations to Breakdowns12
Creating New Breakdown Visualizations12
Configuring the Query Report12
Displaying Query Status in a Separate Tab13
Expanded Admin Tool - Details shared previously14
New Monitor Dashboard - Details shared previously14
Improvements to the Login UI15
New Web Client Configurations16
Security Related Changes16
Web Client Changes16
Server-Side Changes16
Bug Fixes16
Web Client Changes16
Server-Side Changes17
Additional Miscellaneous Changes18
Web Client Changes18
Server-Side Changes18

Highlights of New Features

 

Major Query Status Redesign

Query Status was redesigned to be modular, where one or more data visualizations can be mapped to each query breakdown. These range from simple bar charts and pie charts to complex interactive spatiotemporal visualizations and data download options.

Expanded Admin Tool - Administration & Configuration Tool

The Admin Tool was enhanced with new features for user account management, authentication configuration, and project parameter management.

New Monitor Dashboard - Activity & Usage Monitoring Tool

The new Monitor Dashboard tool provides summaries of i2b2 user activity, such as the number of queries run per project, number of new users, number of failed login attempts, and trends over time.

Improvements to the Login UI

The i2b2 login now includes configurable messaging, password visibility toggle, and improved styling.

New Web Client Configurations

CSS has been centralized to make branding and customizations easier and there are new options to customize the position and behavior of tabs.

Detailed Documentation on New Features

Major Query Status Redesign

The i2b2 web client now includes a library of modular data visualizations that can be used with Query Status. A configuration file (`/js-i2b2/cells/CRC/QueryStatus/breakdowns.json`) maps each query breakdown to one or more of these visualizations. Users can switch between different visualizations using a drop-down menu on the top-right corner of each breakdown. Query Report has also been updated to use these new visualizations.
This new feature greatly expands how breakdowns can be used in i2b2. Previously, bar charts were the only way to view query breakdowns. This limited breakdowns to a small number of categories before the charts became unreadable. By pairing custom SQL breakdowns with the appropriate visualization(s), any type of breakdown data can be returned to the web client presented to the user in different ways.

Default Visualizations

By default, i2b2 1.8.3 includes several breakdowns and mapped data visualizations. These include demographic breakdowns mapped to bar charts, pie charts, and line graphs; an NIH-style enrollment table; a table summary of the data; and an option to download the breakdown as a comma-separated values (CSV) file.
Below is the standard Bar Chart showing a drop-down menu with additional visualization options.

The Line Chart visualization is useful for breakdowns where the categories are numbers or dates, such as patient age.

The Pie Chart visualization shows the proportion of patients in each category.

The NIH Enrollment Table visualization is based on forms used by the U.S. National Institutes of Health to collect demographic breakdowns (race, ethnicity, and sex) for clinical studies.Clarification: this is expected to be enabled (visible if properly configured) in the out-of-the-box 1.8.3 web client.Yes, it should be enabled.FYI we have nowhere to test this yetThis breakdown SQL needs to be added to i2b2 back-end you are using for testing (and to the 1.8.3 release). There is also a custom SQL breakdown to replace the default age breakdown to make the age visualizations look better. The SQL for the optional breakdowns also needs to be included in 1.8.3 in a separate file.

The Table Summary displays a simple table with each breakdown group and the corresponding number of patients.

The CSV Download option, rather than displaying the breakdown within the web client, exports the data to a CSV file that can be opened in other data analysis programs.