Field Details

The following table describes the various fields shown in the Details section of the Field Manager dialog.

Prerequisites: You must have the 'Manage Fields and Tables' role function enabled.

Table 8-1: Understanding Field Details

Field

Req’d

Description

Table

Y

The name of the table in which the field reside. You can modify this value by clicking the ... button and selecting a different table from the tree structure.

DB Name

Y

This is a read-only field that is automatically entered after you type the field Name.

Name

Y

The name appears in the Fields list. This name cannot contain spaces or special characters.

Type

Y

Determines the data type for the field in the table. The option selected here changes the fields that appear in the Properties area. Choose one of the following:

Note: From the Field list (Managing Form Fields) you may see additional types (e.g., Hidden, [default], integer, HTML, etc.). These types are used for core fields only. All new fields may only be defined with the types described here.

Caption

Y

The name that will appear in Expression Editor field types and reports. The caption can be overridden at the form level, using the Caption field that appears in the Properties section of the Form Designer.

Form Caption

Y

The name that will appear on submission and management forms.

Description

N

Information that should be displayed to users when they click the question mark icon next to the field.

Table DB Name

 

The name of the database in which the Fields table resides. This value cannot be modified.

Visibility

Y

Allows (True) or prevents (False) the field from appearing on forms.

Note: You can use Expression Editor to define when a field is visible, mandatory, readonly or available (see Expression Editor Overview). These fields, along with the Default Value and Caption, can be overridden at the form level.

Mandatory

Y

Allows (True) or prevents (False) the field from being compulsory on forms. When the field is marked as Mandatory, it must also be visible on the form to be considered a required field. For example, a mandatory field may appear when a selection is made from another field (see Refreshing Sections in a Form for details); this field is part of the form but because it was hidden, it could not be completed before submitting or saving the file.

Readonly

Y

Allows (False) or prevents (True) the field from being modified by the end user.

Availability

Y

Allows (True) for completed field information to be retained in the database even when another field has changed to make the field no longer relevant. When In-Patient is selected from the Type of Person Affected field, for example, the MRN field appears. When the file is being reviewed, the manager may change the value to Visitor, which causes the field to disappear. If the default Availability setting is used (True), the MRN value entered by the front-line staff will be retained in the database (and available for use in reports) even though it is no longer relevant to the file; when set to False, the value is removed from the database, but is still viewable in the original summary. This setting prevents data from being skewed in reports.

Default Value

N

Allows you to determine what value appears in the field when the form the field has been assigned to is first accessed. For example:

Date – enter[SYS:DATE] into this field to enter the current date into the field.

Time – enter[SYS:TIME] into this field to enter the current time into the field. The time is pulled from the server that is hosting the application.

Text – enter any number of user profile attributes to automatically complete the field. For example, type [USER:SITE] to enter the user’s site into the field; [USER:FULLNAME] for the user’s first and last name; [USER:ID] for the primary key of the user (which is unique to the system, where there may be users with the same full name). For a full list of user attributes that are available, see Creating Generic Scopes.

Dropdown and Radio button –once you have selected a pick list, use this field to choose the list item that should be automatically selected when the form is opened.

If the value begins with an open square bracket (i.e., “[“), it must end with a close square bracket (“]”). The system recognizes values between the brackets.

Note: Default values can also be set in the Icon Wall icon for submission forms (see Field Details for details).

PHI Level

N

Identify at what level the field reveals personal health information:

None – field’s value cannot be used to identify the person affected.

Full – field’s value can be used (without any added information) to identify the person affected, e.g., MRN.

Partial – field’s value can be used in combination with some other information in the file to identify the person affected, e.g., date of birth.

This parameter will be used for future exporting functionality.

Sensitive

Y

This is typically used for fields that identify a patient or fall under the various patient privacy legislation measures. Choose an option to determine if the field contains sensitive data:

True - the field is considered sensitive and the value will be fully redacted (i.e. showing a substitute value defined in the PRIVATE_FIELD_TAG system parameter in place of the actual value) when the user chooses the Hide Private Fields option for printing, emailing, or downloading file summaries.

False - the field value is not considered sensitive and will be displayed in printing, emailing, or downloading file summaries and form letters.

Calculated - the field is considered sensitive under specific circumstances which can be defined using the Expression Editor. The field value will be hidden in printed, email or download summaries when the specified conditions are met.

If the PHI Level field is set to Full or Partial, the Sensitive field is automatically set to True. For sensitive fields to be redacted, the user creating the file summary or form letter must have the Redact Sensitive Field role permission enabled. If this role permission is not enabled, the field values will not be hidden even if the user selects the Hide Private Fields option in the File Summary dialog.

Inactive in Field Picker

Y

Check this box to hide the field from the field picker, which is used when defining reports, alerts, and various other expressions. This feature helps alleviate confusion for users who create reports or advanced searches by limiting the fields from which they can select to those that are actually in use in your organization’s installation.