How to Use the Brim Variable Library

Overview

The Brim Variable Library is a curated set of pre-built, validated variables that you can add to your projects with just a few clicks. Library variables are vetted by Brim, come with standardized definitions, and are organized into thematic bundles, so you spend less time building from scratch and more time customizing and validating your abstraction pipeline.

Accessing the Variable Library

The Variable Library is accessible from Project Setup. Look for the Add Variables button above the variable list, then select Add from Library. This opens the full Library browsing interface.

You can also find the Variable Library in your Settings menu in the top right of your Brim app; just click Settings > Variable Library.

Permissions note: You must have Upload Data and Variables permissions to access the Variable Library. Contact your organization admin if you don't see this option.

Browsing and Searching

The Library has two main display modes. You can toggle between them using the tabs at the top of the page:

1. Variable Bundles: Shows the available bundles and allows you to view all of the variables in a bundle at once.
2. All Variables: A list of all variables available.

When looking at the variable list, you'll see a high-level summary for each variable, including:

• Scope icon: indicates whether the variable is Many Per Note, One Per Note, One Per Patient, or a Dependent Variable. Hover over the icon for a label.
• Variable name
• Type: boolean, float, timestamp, text, or integer
• Bundle(s): thematic groupings the variable belongs to (e.g., NSQIP, Trauma, Measurement)
• Description: a short, plain-language explanation of what the variable captures
• Status: whether the variable has already been added to your current project, and the option to add it to your project.

Variable lists also allow you to:

Search: Use the search bar to find variables by name, description, or type.

Filter by Bundle: Use the Filter dropdown to narrow the list to a specific thematic group. A variable can belong to more than one bundle; the filter shows all variables in the selected bundle.

Viewing Variable Details

Click the info icon (ⓘ) next to any variable name to open the Library Variable Details modal. This view shows:

• Scope, name, type, and bundle tags
• Authors and last updated date
• Full description
• If the variable requires input variables, they are listed here with their own scope icons and names. You can click any input variable to view its full definition.

Adding a Variable to Your Project

From the Library table or the Details modal, click Add to Project.

A few things to know:

• Input variables are included automatically. If the variable you're adding depends on other variables (input variables), Brim will pull in the full hierarchy. You don't need to add them separately.
• Once added, the variable's row will show "Added to current project" with a Remove option.

To remove a variable: Click Remove next to the variable. You'll be asked to confirm.

From the Bundles page, you also have the option to add all variables from a Bundle.

Library Variables in Your Project

Once added, library variables appear in your variable and dependent variable lists just like any other variable.

At the top of the Edit Variable screen, a tag will appear for any unmodified library variable noting that it is a Library Variable.

Editing a Library Variable

Library variables are open and editable. They're designed to be a high-quality starting point that you can customize for your specific needs.

If you make changes to a library variable and save, you will be asked to confirm. If you accept, your variable will be fully transitioned to a custom variable.

Once confirmed, the variable becomes a standard custom variable. Its origin as a library variable is preserved in its history, but it will no longer be treated as a library variable going forward.

Frequently Asked Questions

What happens if Brim updates a library variable I'm already using? Updates to library variables do not automatically propagate to existing projects. Your project will continue using the version that was current when you added it.

Can I use a library variable as a starting point and then modify for my needs? Yes; they work great as a starting point. Add the variable, review its definition in the Edit Variable screen, make your changes, and confirm the conversion when saving. Your customized version is saved as a project variable.

How do I give feedback on the Variable Library? If you have an idea for a new or modified Library Variable or Bundle, we want to know about it! Shoot us a quick note at support@brimanalytics.com.