Use naming conventions to decide what to add to your report

The clinical data report elements that you can add to a Cognos Reporting report are named in a way that can help you determine which report element to use. In general, the labels use the following convention:

optional prefix~ control identifier~ item identifier

The control identifier and item identifier are specified in the study design, retrieved by InForm, and populated in the Clinical Data by Forms folder in Cognos Reporting.

Where the control identifier and item identifier come from

Label Description
optional prefix

The type of element:

  • None
  • Code
  • Unit
  • Unit Code
  • Normalized
  • Date
  • Time
  • Month Yr
  • YYYY/MM/DD
  • HH24:MM:SS
  • Month
  • Year
control identifier

Text that identifies the specific control for the item.

  • Controls other than checkboxes—The Oracle InForm application uses the following properties:
    • Caption property for the control, if it exists.
    • RefName property for the control, if no caption exists.
  • Checkboxes—The Oracle InForm application uses the following properties:
    • Label property of the child control element, if it exists.
    • Caption property of the child control element, if no label exists.
    • RefName property for the child control element, if no label or caption exists.
item reference

Text that identifies the item as it appears in the study. The InForm application uses the following properties:

  • Short Question property for the item, if it exists and is not the default.
  • Question property for the item, if no short question exists.

Default labels by control type

Keep the following in mind as you create a report in Cognos Reporting.

Table 2-1 Report element (Default label)

Code report elements Description Default folder

[control identifier]

Example: Cardiovascular ~ Cardiovascular

Returns the text value that was entered during data entry. Basic Data

Code~ [control identifier]

Example: Code ~ Cardiovascular ~ Cardiovascular

Returns the database code that corresponds to the value entered during data entry. Additional Data

Table 2-2 Data that require units of measure

Code report elements Description Default folder

[control identifier]

Example: Weight

Returns the value that was entered during data entry. For instance, if the Oracle InForm user entered 135 on the form, the Weight element returns 135. Basic Data

Unit~ [control identifier]

Example: Unit~ Weight

Returns the specific unit of measure that was selected at data entry. The label for this element has the prefix Unit ~. For example, the Unit ~ Weight element might return these values: kg or lbs. Basic Data

Normalized~ [control identifier]

Example: Normalized~ Weight

Returns the normalized value; the Oracle InForm application converts measurements to the same, or normalized, unit of measure, based on a base unit of measure that is defined for your study. For example, if the base unit of measure is kilograms, the InForm application converts all entered values to kilograms and stores that value as a normalized value. Additional Data

Unit Code~ [control identifier]

Example: Unit Code ~Weight

Returns the code value for the unit of measure, as it is stored in the database. The label for this element has the prefix Unit Code~. Additional Data

Table 2-3 Date controls

Code report elements Description Default folder

Date ~ [control label]

Example: Date~ Start Date

Returns a date that includes Month, Day, and Year.

If data is not entered, or is marked as Unknown in the Oracle InForm application, data does not appear for this report element.

Basic Data

Month Yr ~ [control label]

Example: Month Yr ~ Start Date

Returns a date that includes Month and Year.

If data is not entered, or is marked as Unknown in the Oracle InForm application, data does not appear for this report element.

Basic Data

YYYYMMDD ~ [control label]

Example: YYYMMDD ~ Date Started

Returns a text string in YYYYMMDD format.

Data displays here when a date control allows empty or unknown values.

Basic Data

Time ~ [control label]

Example: Time ~ Date Taken

Returns a standard time (24-hour clock) in HH:MM:SS format.

If data is not entered, or is marked as Unknown in the Oracle InForm application, data does not appear for this report element.

This report element appears only for those Oracle InForm controls that collect the time portion of a date.

Basic Data

HH24:MM:SS ~ [control label]

Example: HH24:MM:SS~ Date Taken

Returns a text value for time (24-hour clock).

Data displays here when a date control allows empty or unknown values.

This report element appears only for those Oracle InForm controls that collect the time portion of a date.

Basic Data

Year ~ [control label]

Example: Year ~ Date Taken

Returns only the year portion of a date.

If data is not entered, or is marked as Unknown in the Oracle InForm application, data does not appear for this report element.

Additional Data

Month ~ [control label]

Example: Month ~ Date Taken

Returns only the Month portion of a date.

If data is not entered, or is marked as Unknown in the Oracle InForm application, data does not appear for this report element.

Additional Data

Table 2-4 Itemsets, repeating visits, and repeating forms

Code report elements Description Default folder
Visit Index Returns a numeric value that identifies an instance of a repeating visit. Basic Data
Form Index Returns a numeric value that identifies an instance of a repeating form. Basic Data
Itemset Index Returns a numeric value that identifies an instance of an itemset. Basic Data

Table 2-5 Deleted itemsets and form instances

Code report elements Description Default folder
Deleted form

Indicates whether the reported form instance was marked for deletion in the Oracle InForm application. Use this report element with the Form Index element to see form instances that are deleted. Values are:

  • Y—Form was marked for deletion.
  • N—Form was not marked for deletion.
Basic Data
Deleted itemset

Indicates whether the reported Add Entry itemset was marked for deletion in the Oracle InForm application. Use this report element with the Itemset Index to see itemsets that are deleted. Values are:

  • Y—Itemset was marked for deletion.
  • N—Itemset was not marked for deletion.

Note:

You cannot delete or undelete a Repeating Data itemset.
Basic Data

Table 2-6 Incomplete data reasons

Code report elements Description Default folder

Not Done ~ [item label]

Example: Not Done ~ Unit Dose

Returns a textual value that indicates why an item is marked Incomplete. Incomplete Data Reasons

Blank~[item label]

Example: Blank~HeartRate

Indicates whether the reported item appears in a Repeating Data itemset, and is blank, as specified in the study design.

  • Y—Item is blank.
  • N—Item is not blank.
Incomplete Data Reasons

Table 2-7 Transactional data

Code report elements Description Default folder
CREATEDBYUSERID

User ID of the user who started the form by entering data on the form or triggering a rule that entered data on the form.

When the review schema is recreated, this column displays the system user ID.

Basic Data
CREATEDBYDATETIME

Date and time when the reported form was started; that is, when a user entered data on the form or triggered a rule that entered data on the form.

When the review schema is recreated, this column displays the date and time when the review schema was recreated.

Basic Data
MODIFIEDBYUSERID

User ID of the user who started or modified the form by entering or modifying data or triggering a rule that entered or modified data on the form.

When the review schema is recreated, this column displays the system user ID.

Basic Data
MODIFIEDBYDATETIME

Date and time when the reported form was most recently started or modified; that is, when a user entered or modified data on the form or triggered a rule that entered or modified data on the form.

When the review schema is recreated, this column displays the date and time when the review schema was recreated.

Basic Data