The code block below illustrates how one might use # and // as comments in your logic and calculations.
# Text can be put here to explain what the logic/calculation does and why.
if ([field1] = '1' and [field2] > 7,
// This comment can explain what the next line does.
[score] * [factor],
// Return '0' if the condition is False.
0
)
Working …
0% means
50% means
100% means
This value you provided is not a number. Please try again.
This value you provided is not an integer. Please try again.
The value entered is not a valid Vanderbilt Medical Record Number (i.e. 4- to 9-digit number, excluding leading zeros). Please try again.
The value you provided must be within the suggested range
The value you provided is outside the suggested range
This value is admissible, but you may wish to double check it.
The value entered must be a time value in the following format HH:MM within the range 00:00-23:59 (e.g., 04:32 or 23:19).
This field must be a 5 or 9 digit U.S. ZIP Code (like 94043). Please re-enter it now.
This field must be a 10 digit U.S. phone number (like 415 555 1212). Please re-enter it now.
This field must be a valid email address (like joe@user.com). Please re-enter it now.
The value you provided could not be validated because it does not follow the expected format. Please try again.
Since this project is currently in PRODUCTION, changes will not be made in real time.Tell me more
You may make changes below while the project is in Draft Mode, which will not affect the existing structure of the project, but all edits will need to be reviewed and approved by a REDCap administrator after you have finalized your changes. When you have finished making changes, click the button below to finalize this draft and submit it for approval. You will be notified by email when your changes have been committed to the project.
Do you wish to remove and discard all the changes you have made to your data collection instruments while in Draft Mode? If so, they will be discarded and your project will be taken out of Draft Mode.
Once you click Submit to finalize these changes, you must wait for your changes to be reviewed and approved, after which you will receive an email confirmation informing you that the changes have been made effective on the project.
NOTE: Please be advised that if your changes made in Draft Mode meet certain qualifications, those changes may get automatically approved, which means that they will be made immediately rather than having to wait for a REDCap admin to approve them.
Have you checked the
Check For Identifiers page to ensure all identifier fields have been tagged?
Share your instruments with others via the REDCap Shared Library
When in production, you may share single data collection instruments from this project with other REDCap users around the world. This is done by uploading your instruments to the REDCap Shared Library. Select the instrument below that you wish to share. Before allowing you to share your instrument, you will be asked to fill out some basic information. (NOTICE: Copyrighted material may not be shared unless you are the owner.)
What is the REDCap Shared Library?
A new MyCap configuration version has been published successfully. The page will be reloaded to reflect this change.
MyCap uses a configuration versioning system. When a participant opens their MyCap mobile app, it sends a request to the REDCap
server to see if a new configuration version has been published. The mobile app updates itself as needed if a new version is found.
Changes you make to REDCap instruments are not automatically pushed to existing participants.
You must explicitly indicate that changes you have made should be published to the MyCap mobile app. However,
new participants will always receive the most recent instrument fields.
This page allows you to build and customize your data collection instruments one field at a time. You may add new fields or edit existing ones. New fields may be added by clicking the Add Field buttons. You can begin editing an existing field by clicking on the Edit icon. If you decide that you do not want to keep a field, you can simply delete it by clicking on the Delete icon. To reorder the fields, simply use the icon to drag and drop a field to a different position within the form below (you may also click this icon to see extended move options). Checking the checkbox in the right upper corner of each field will add the field to the multi-field selection, allowing you to quickly modify several fields at once.
Quick-modify field(s)
|
|
Consider creating a DD Snapshot (see button at top of page) before making lots of field changes.
Choose how to modify the fields selected for the Quick-modify popup
As a way to select more fields on this instrument to use with the Quick-modify popup, click the icons below to select different types of fields that might exist
on this page, then click the Add or Replace buttons to apply your selections to the Quick-modify popup.
Include/Exclude | Direction:
or
In what way would you like to edit the Branching Logic of the following fields?
Fields
In what way would you like to edit the Action Tags / Field Annotation of the following fields?
Fields
– OR –
Note: When no Action Tags are listed above, then all Action Tags will be deactivated or reactivated, respectively.
The Choices Editor provides a way to edit choices for checkbox, radio, and dropdown fields. Choices consist of a code (that gets stored in the backend and usually is exported) and a label (that is displayed on data entry forms and surveys). You can add, edit, or delete choices, copy and paste choices from, e.g., Excel, as well as download a CSV of the current choices. The editor will validate the choices.
NOTE: Please be aware that branching logic and calculated fields will not function on this page. They only work on the survey pages and data entry forms.
You may add or edit a matrix (i.e. grid) of project fields on this data collection instrument by completing the fields below. By providing all necessary info below and clicking Save, the new matrix of fields will be added to the form on this page. A Field Label and Variable name must be provide for each field in the matrix, and you must also set the Choices (i.e. matrix column headers) and answer format (Single Answer vs. Multiple Answers) for the entire matrix.
View a matrix example or
Read more about matrix fields on the Help & FAQ.
You may manually define the coded value for each choice by entering the coded number and a comma before the choice label (see example below). The only acceptable raw values are 1) an integer, or 2) a text string containing only letters, numbers, and underscores. Note: If you wish to insert a line break between choices for horizontally-aligned choices, you may use the <br> tag.
Embedding an external video: You can display an embedded video on a data entry form or survey page by simply providing the video's URL (web address) in the 'Embed media' text box. You may have the video be displayed inline on the page, or you may instead have it initially hidden but displayed after clicking a button. Any video can be set to full-screen mode, if desired. Unlike the attachment option for Descriptive fields, which implies uploading a file into REDCap, an embedded video will not be hosted by REDCap but will be hosted on another server elsewhere on the web and streamed to the user's web browser. YouTube and Vimeo videos are the most compatible video streaming services, and you can obtain the URL for such videos on those websites.
Embedding a website: You can display another website on a data entry form or survey page by providing the URL in the 'Embed media' text box.
This option is best used with the display format of ‘inline’ to have the website appear embedded within the survey or form.
The URL may be another data entry form or survey page within the same project, a data entry form or survey within another project, or a URL internal/external of REDCap.
If the embedded media is in a different project or outside of REDCap entirely, you may directly enter the URL into the 'Embed media' text box to have it appear on the data entry form or survey.
If the embedded media is within the same project, smart variables such as [survey-url:instrument] or [form-url:instrument] will function and connect the data entry forms or surveys to the current record.
NOTE: You may use Piping in the URL of the media text box.
IMPORTANT NOTICE: It is your responsibility as a REDCap user to ensure that you do not upload any videos or files that contain confidential or sensitive information (e.g., PHI or PII), as well as copyrighted material, to third-party websites such as YouTube, Vimeo, etc. REDCap is not responsible for anything that you upload to third-party websites.
Document was successfully uploaded!
There was an error uploading your file.
Upload in progress...
Enable auto variable naming?
NOTE: Best practices suggest that it is best to leave auto naming disabled so that you may define your own variable names manually. Please be advised that if you enable the auto variable naming feature, you may end up with undesirable variable names that may make statistical analysis of your data difficult, tedious, or confusing.
It is recommended that variables be named so that they are sufficiently descriptive yet succinct. For example, the question 'What is your gender?' might have its variable manually defined by a user as 'gender'. Whereas with auto variable naming enabled, the variable would instead end up as 'what_is_your_gender', which is less concise and unnecessarily long.
If you are not interested in manually defining your variable names, either because you will not be performing serious data analysis or for other reasons, you are free to enable the auto naming by clicking the 'Enable' button below.
Branching Logic may be employed when fields/questions need to be hidden under certain conditions. If branching logic is defined, the field will only be visible if the conditions provided are true (i.e. show the field only if...). You may specify those conditions in the text box below for the Advanced Branching Logic Syntax or by choosing the Drag-N-Drop Logic Builder method, which allows you to build your logic in a much easier fashion by simply dragging over the options you want. You may switch back and forth between each method if you wish, but please be aware that since the advanced logic allows for greater complexity, it may not be able to be switched over to the Drag-N-Drop method if it becomes too complex.
This same exact branching logic is shared by multiple fields. Would you like to automatically update the branching logic of ALL the other fields (even those on other instruments) that have the exact same branching logic? NOTE: Clicking YES will update the other fields' branching logic immediately.
Do not show this message again.
The Choices textbox has now been pre-loaded with the choices from the matrix group you just selected. You should *NOT* alter these values.
Field annotations can be used to add explanatory notes or commentary about a given field. This can be used for several purposes, such as for the bookkeeping of a project's field structure (as metadata about the given field) for reference purposes regarding what the field represents or how it should be used (during data entry, analysis, etc.). Field annotations are not displayed on any page but are merely for reference. Field annotations can also be used to map the field to various standards (e.g., CDISC, SNOMED, LOINC) using whatever notation the user sees fit (e.g., using a simple ID code for the standard or a complex XML structure containing information about how to transform the data to the standard). Since it is just an annotation for reference purposes, REDCap will not do anything with the field annotation text on its own, but the annotation can be obtained by users at any time for any purpose (typically accessed via the Data Dictionary download or via the API metadata export). Summarily, field annotations do not have a specifically defined purpose, so users may use them in whatever way they so choose.
If using a slider field on an instrument that is or will be enabled for MyCap, use one of the following annotations to optimize the layout on the mobile device.
@MC-FIELD-SLIDER-BASIC=[MIN]:[MAX]:[STEP]: This is a MyCap annotation used with slider fields. Example: @MC-FIELD-SLIDER-BASIC=0:10:1 is scale from 0 to 10 step by increments of 1, where the slider cannot have more than 13 steps. See documentation . Note that REDCap slider does not accept values < 0 and > 100.
@MC-FIELD-SLIDER-CONTINUOUS=[MIN]:[MAX]:[MAX FRACTIONAL DIGITS]: This is a MyCap annotation used with slider fields. Example @MC-FIELD-SLIDER-CONTINUOUS=0:100:0 is scale from 0 to 100 with no fractions. See documentation. A REDCap slider will default to this if no annotation is specified. Note that REDCap slider does not accept values < 0 and > 100. REDCap slider does not accept fractions, so always use 0 as the last number.
Learn how to use...
How to embed a field elsewhere
Learn how to customize your instrument or survey by using Field Embedding.
How to modify multiple fields together
To copy, move, or delete multiple fields at the same time, hold the Ctrl or Cmd key on your keyboard and click the field to reveal the Quick-modify field(s) feature.
Show:
Field Navigator
You can quickly move to (and select a field) by using the 'Go to field' widget (keyboard shortcut: CTRL-G or CMD-G).
Scroll to Section Header:
Using the Field Bank, search for fields in various catalogs below by selecting a catalog and entering specific keyword. When reviewing the resultsup of your search, click the "Add Field" button for the field to add that field to the current data collection instrument.
Select a catalog to search:
Edit instrument/form name
* Field naming rules apply, i.e. a form name must contain lower case letters, numbers, and underscores only, and must start with a letter and must not end with an underscore.
* This form name cannot be renamed because this is a PRODUCTION project and the form was not added in the current draft mode session.