Build an Instrument

This article provides an overview of the 3 methods used to build an instrument.

The 3 ways to Build an instrument are listed below.

A. Online Designer

For guidance on field types & coding click HERE to view

B. Data Dictionary

First, understand the Impact of Data Dictionary changes, then make your edits. View process HERE

C. Shared Library

For guidance on Promis & CATs (Computer Adaptive Tests) found in the shared library, click HERE

A. Online Designer

Go to project and click ‘designer’ or ‘online designer’ within project setup:
Click on "Create" to add a new instrument or edit the default form (Form 1)
3. Once an instrument has been selected, you can add and edit field questions
1. To copy, move, or delete multiple fields at the same time, hold the Ctrl, Shift, or Cmd key on your keyboard and click the field to reveal the options.

To learn more, view in the Online Designer in-app video & resources:

B. Data Dictionary

The data dictionary has certain contents listed in each column. The following table gives a description:

Column	Column Name (Row 1)	Description	Required?
A	Variable / Field Name	Lists the variable name	Yes
B	Form Name	Lists the auto generated form name	Yes
C	Section Header	Lists header that appears above question	No
D	Field Type	Lists field type, which is one of the following: text, notes, calc, dropdown, radio, checkbox yesno, truefalse, file, slider, or descriptive	Yes
E	Field Label	Label that appears on forms / surveys	Yes
F	Choices, Calculations, OR Slider Labels	Lists the choices, calculation, or slider labels. Separates choices with \|	Required for the following field types: calc, dropdown, radio button, and checkbox
G	Field Note	Text that appears below answers	No
H	Text Validation Type OR Show Slider Number	Used to validate text questions and the type of data it will hold (E.g. date_mdy, number, phone, etc.)	No
I	Text Validation Min		No
J	Text Validation Max		No
K	Identifier?	Has 1 if question is marked as an identifier	No
L	Branching Logic (Show field only if...)	Lists branching logic	No
M	Required Field?	Lists 1 for yes	No
N	Custom Alignment (Where the answers or text box is located, if left empty, automatically is RV)	RV = Right / Vertical RH = Right / Horizontal LV = Left / Vertical LH = Left / Horizontal	No
O	Question Number (surveys only)		No
P	Matrix Group Name		Required for Matrix fields
Q	Matrix Ranking?		No
R	Field Annotation		No

Navigate to your project setup > click 'Data Dictionary' > watch tutorial on how to use this page:

Steps for making project changes:
1.) Download the current Data Dictionary
2.) Edit the Data Dictionary (see the Help & FAQ for help)
3.) Upload the Data Dictionary using the form below
4.) The changes will be made to the project after the Data Dictionary has been checked for errors

C. Shared Library

Navigate to the Online designer using either method below:

2. Click on "Import" tab

3. You'll now be on the REDCap Shared Library page, where you can select to import an already existing form. Click on the form you would like to use, and select "Import into my REDCap project"

You now will need to agree with things listed in an agreement, once that is done a box similar to the one below will show up. Here you can change the name of the form and add it to your project.