Item Types and Appearance Reference

Modified on Mon, 9 Nov at 1:25 PM

 

ℹ️ This page is for Data Managers responsible for study design.

 

In OpenClinica, the item type is the question type, or field type, of each question on a form, such as text, number, date, single choice, multiple choice, calculation, file, image, audio, video, or encrypted personal information. The appearance is the display option for that question, such as a drop-down list, a slider, or a Likert scale. This reference lists every item type and appearance, with the name used in Form Designer and the value used in the Form Template.

 

For how to build a form, see Build a Form in Form Designer or Build a Form with the Form Template.


 

What item types does OpenClinica support?

 

In OpenClinica, choose the item type that matches the data you collect. In Form Designer, select it from the palette when you add a question; in the Form Template, select it from the drop-down list in the survey sheet's type column, or type it. Use this table to find the item type for the data you collect.

To collectForm Designer paletteForm Template typeNotes
One answer from a listSelect Oneselect_one listnameOptions are defined in the item's response list, or on the choices sheet under listname.
One or more answers from a listSelect Multipleselect_multiple listnameUse selected() in logic to test for a particular answer.
One answer from a long list in a CSV fileSelect One (External List)select_one_from_file file.csvAppears in the Form Designer palette only after a file is attached to the draft.
Free textTexttextAnswers can be up to 3,999 characters.
A whole numberIntegerintegerCan be shown as a slider.
A number with decimalsDecimaldecimal 
A dateDatedatePartial dates are set through Appearance.
A value computed from other answersCalculatecalculateNot shown on the form. Cannot be required or read only and cannot have an edit check. To show the result, reference it in a Note.
Nothing (display only)NotenoteInstructions or headings; images, audio, or video that users can view or play in the form; or a value piped in from another item, such as a calculated result.
A fileFile Uploadfile 
An image, drawing, or drawn signaturePhoto UploadimageDrawing, annotating, and signature are appearance options.
An audio recordingAudio Uploadaudio 
A videoVideo Uploadvideo 
Encrypted Participant contact informationPII (Encrypted)text, with bind::oc:external = contactdata and instance::oc:contactdata set to the contact type 
A Participant's consent signatureeConsent Signatureselect_multiple, with bind::oc:external = signatureRequires the eConsent module. Available only on forms in a non-repeating visit event or in the Form Library. One per form, not in a repeating group.
A group of questionsCreate group with selected questionsbegin group ... end group 
A repeating group of questionsRepeat this group if necessarybegin repeat ... end repeatRepeating groups cannot be nested.

 

Unsupported Item Types

 

OpenClinica does not support the geopoint, geotrace, geoshape, barcode, time, and dateTime item types. Uploading a Form Template that uses them fails with an "unsupported data type" error.


 

How do I change how a question is displayed?

 

In OpenClinica, the appearance controls how an item is displayed. In Form Designer, open the item's Appearance section and select a card. When the section is collapsed, a label shows the current choice. In the Form Template, select the value from the drop-down list in the appearance column, or type it.

 

In Form Designer, select Custom to type any other appearance value in the box below the cards. If you select Custom and leave the box empty, Form Designer saves the value other in the appearance column. You see this value only in the form definition, for example in the appearance column when you download the form as a Form Template.

 

Use this table to find the appearance card or value for each item type. The most common choices are Dropdown for long lists, Likert scale for agreement scales, and Horizontal slider for a visual analogue scale (VAS).

Item typeForm Designer cardForm Template valueWhat it does
Select OneRadio list(blank)Radio buttons, one option per line. Default.
Select MultipleCheckbox list(blank)Check boxes, one option per line. Default.
Select One, Select MultipleDropdownminimalOptions in a drop-down list.
Select One, Select MultipleColumns (buttons)columns, or columns-2 to columns-10Options arranged in columns, with buttons. Use Columns (#) to choose Automatic or a fixed number of columns from 2 to 10.
Select One, Select MultipleColumns (labels only)columns no-buttons, or columns-n no-buttonsColumns showing only the label or image, without buttons.
Select One, Select MultipleImage gridcolumns-packImage options packed side by side.
Select One, Select MultipleImage grid (labels only)columns-pack no-buttonsImage grid without buttons.
Select OneLikert scalelikertOptions shown as a Likert scale. Not available for Select Multiple.
Select One, Select MultipleSearchautocompleteUsers type to filter the options. Recommended for long lists, often as minimal autocomplete.
Select One, Select MultipleHotspot imageimage-mapUsers click regions of a scalable vector graphics (SVG) image, such as a body map. The SVG file is set in the image column.
TextSingle line(blank)A one-line text box. Default.
TextParagraphmultilineA multi-line text box.
IntegerNumber input(blank)A number box. Default.
IntegerHorizontal slideranalog-scale horizontalA 0 to 100 visual analogue scale.
IntegerHorizontal slider (no ticks)analog-scale horizontal no-ticksThe horizontal scale without tick marks.
IntegerVertical slideranalog-scale verticalA vertical 0 to 100 scale.
IntegerVertical slider (no ticks)analog-scale vertical no-ticksThe vertical scale without tick marks.
IntegerVertical slider with scaleanalog-scale vertical show-scaleThe vertical scale with numbers shown.
DecimalDecimal input(blank)A number box. Default.
DateFull date(blank)Day, month, and year. Default.
DateMonth & yearmonth-yearA partial date: month and year only. Stored as a full date with 01 as the day.
DateYear onlyyearA partial date: year only. Stored as a full date with 01 as the day and month.
Photo UploadUpload & previewdefaultUsers upload an image and see a preview. Default.
Photo UploadDrawdrawUsers draw on the screen.
Photo UploadAnnotateannotateUsers upload an image and draw on it.
Photo UploadSignaturesignatureUsers draw a signature. Form Designer shows a warning that signature capture is not 21 CFR Part 11-compliant; use it only where electronic signature compliance is not required.
NoteNote(blank)Displays the note text. Default.
File UploadFile upload(blank)Users upload a file. Default.
Audio UploadAudio upload(blank)Users upload an audio file. Default.
Video UploadVideo upload(blank)Users upload a video file. Default.
All types except Calculate and groupsCustomAny valueShows an appearance value that does not match any card, such as a value added in the Form Template. To enter your own value, select Custom and type it in the box below the cards. Custom cannot be combined with another card: selecting a different card replaces the custom value.

 

Calculate items have no appearance.


 

Choose a Group Appearance

 

In OpenClinica, groups have three appearance cards and no Custom card. All three are available in every form style. Use this table to choose how a group's questions are laid out.

Form Designer cardForm Template valueWhat it does
Standard group(blank)Shows the group's questions normally.
Table listtable-listShows the questions as a table, with the shared response choices across the top and one row per question. Use it for several questions with the same response list.
Same screenfield-listKeeps all the group's questions on one page in a multiple-page style.

 

ℹ️ Note: If you upload a Form Template in which a group has an appearance value that Form Designer does not recognize, and then open the form in Form Designer, Standard group is shown as selected. The original value is kept until you select a card.

 

How do I put more than one question on a line?

 

In OpenClinica, use a Grid form style and item widths to put more than one question on a single line of the form, and to set how much of the line each question takes up. For example, two blood pressure questions can each take half of a line. Widths apply to Grid styles only.

 

On Grid styles, each group is divided into columns. A group has 4 columns by default, and you can set up to 10. Each question takes up one or more of those columns.

  • Form Designer: set the group's Columns in Grid (1 to 10), then each question's Item width. In a 4-column group, the width cards are Full width, 3/4 width, Half width, and 1/4 width; in other groups they read 1 of N, 2 of N, and so on. The Item width section shows a context line, such as Parent group (VS) has 4 columns. A question that is not in a group shows Form has 4 columns.
  • Form Template: add w1 to w10 to the question's appearance column, alone or with another value, such as minimal w2. For a group's number of columns, add w1 to w10 to the group's appearance column.

 

ℹ️ Note: Both settings are hidden when the form uses a Simple style, and saved widths are kept. If you edit a question's appearance in Form Designer while the form uses a Simple style, that question's width can be removed; check it after you change back to a Grid style.

 

Format Question Text

 

In OpenClinica, question text, hints, notes, and response labels support simple formatting in both Form Designer and the Form Template. Use this table to find the formatting to type.

TypeResult
*text*Italics
**text**Bold
***text***Bold italics
# text (one to six #)Larger text; # is the largest
<span style="color:#ff0000">text</span>Colored text (#FF0000 is a hex code for red)
<span style="text-decoration: underline;">text</span>Underlined text

 

Naming Differences Between Form Designer and the Form Template

 

In OpenClinica, Form Designer and the Form Template (an Excel spreadsheet in the XLSForm format) use different names for the same settings. Use this table to find the Form Template column for a Form Designer field, or the other way round.

ConceptForm DesignerForm Template
Variable nameItem Namename column (survey sheet)
Short label for tables and listingsShort Display Namebind::oc:briefdescription column
Item definition for metadata and extractsItem Descriptionbind::oc:description column
Dataset or domainItem Groupbind::oc:itemgroup column
Question textQuestion text, typed on the question cardlabel column (survey sheet)
Help text under the questionHinthint column
CodelistResponse options (Label, Value, Image)choices sheet (list_name, label, name, image)
Stored code for an answerValuename column (choices sheet)
Skip logicRelevant Logic tabrelevant column
Edit checkValidation Criteria tabconstraint column
Edit check messageConstraint Messageconstraint_message column
Hard edit checkNot availablestrict in the bind::oc:constraint-type column
Required itemRequired: Alwaysrequired column: yes
Conditionally required itemRequired: Conditional, then the Required Logic tabrequired column: an expression
Hard required itemNot availablestrict in the bind::oc:required-type column
Derived variableCalculate item and the Calculation tabcalculate type and the calculation column
Recalculate only when one item changesTriggered bytrigger column
Pre-filled valueDefault Value tabdefault column
Read only valueRead only (Advanced options)readonly column: yes
Display optionAppearanceappearance column
Width of a question on Grid formsItem widthw1 to w10 in the item’s appearance column
Number of columns in a groupColumns in Gridw1 to w10 in the group's appearance column
Data from outside the form, such as the participant's contact information (contactdata), data from the participant's other forms and events (clinicaldata), or the participant ID on Offline Capable forms (identifier)Use External Valuebind::oc:external column
Group of questionsLayout group (Create group with selected questions)begin group and end group rows
Log form or repeating sectionRepeating group (Repeat this group if necessary)begin repeat and end repeat rows
Fixed number of repeatsRepeat Count tabrepeat_count column
Form layoutForm style (Layout & Settings)style column (settings sheet)
Form versionVersion number (Layout & Settings)version column (settings sheet)
Language the form is written inPrimary language (Manage Languages)default_language column (settings sheet)
Translated textTranslations table (Manage Languages)Language columns, such as label::French (fr)

 

Key Terms

 

These are the main OpenClinica terms used in this article.

 

Item type: the question type or field type, such as Integer, Date, or Select One. It cannot be changed after the question is created.

 

Appearance: the display option for a question, such as a drop-down list or a slider.

 

Grid style: a form style where questions in a group can sit side by side in columns.

 

Item width: how many of a group's columns a question spans on a Grid form.

 

Layout group: a set of questions shown together on the form.

 

Form Template: an Excel spreadsheet in the XLSForm format that defines a form.


 

Frequently Asked Questions

 

How do I show answer options as a drop-down list in OpenClinica?

 

In OpenClinica Form Designer, open the Select One or Select Multiple question's Appearance section and select the Dropdown card. In the Form Template, enter minimal in the appearance column. For long lists, use Search (autocomplete) so users can type to filter the options, often as minimal autocomplete.

 

How do I add a visual analogue scale (VAS) in OpenClinica?

 

In OpenClinica, use an Integer question with a slider appearance. In Form Designer, select the Horizontal slider or Vertical slider card. In the Form Template, enter analog-scale horizontal or analog-scale vertical in the appearance column. Both show a 0 to 100 scale; add no-ticks to hide the tick marks.

 

How do I collect a partial date in OpenClinica?

 

In OpenClinica, use a Date question with a partial-date appearance. In Form Designer, select the Month & year card or the Year only card. In the Form Template, enter month-year or year in the appearance column. The default Full date appearance collects the day, month, and year. OpenClinica always stores a full date: for a partial date, it fills in 01 for the missing day, and for a year-only date, 01 for the missing month.

 

Can I change a question's item type after I create it in OpenClinica?

 

No. In OpenClinica Form Designer, the item type of an existing question cannot be changed; delete the question and add it again with the new type. The appearance and every other setting stay editable. An item's data type also cannot change between form versions. See Versions and Changing Forms After Go-Live.


 

Related Articles

 

These OpenClinica articles cover the rest of the form-building process.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article