The DataSet Element - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential

The DataSet element specifies non-required Keyword Types associated with a Front Office Scanning Data Set.

<DataSet>
<Keyword>Address</Keyword>
<Keyword KeywordAutoFill="true" id="104" type="alpha" minLength="10" maxLength="40">City</Keyword>
</DataSet>

The DataSet element is composed of one or more Keyword sub-elements. Each Keyword sub-element represents one Keyword Value that can, but is not required to be, included in a Front Office Scanning Data Set.

Enter the name of the Keyword Type of the non-required Keyword directly between the Keyword tags.

To ensure that valid data is stored in the Data Set, the following validation options can be optionally included in the Keyword sub-element. These options ensure that the Keyword Value in the Data Set contains only allowable data (e.g., alphanumeric, numeric, currency, etc.) and/or that the length of the Keyword Value does not fall short of the specified minimum length or exceed the maximum allowable length configured for the Keyword Type.

Keyword Sub-Element Settings

Description

KeywordAutofill

This setting allows you to expand an AutoFill Keyword Set when entering a value for the configured Keyword Type during manual Data Set creation.

  • If KeywordAutofill is set to true, when you enter a primary Keyword Value of an AutoFill Keyword Set for the configured Keyword Type while manually creating a Data Set, the AutoFill is expanded in the Selected Data Set window.

  • If KeywordAutofill is set to false, or if no value is present, then AutoFill Keyword Sets will not be expanded during manual Data Set creation.

Note:

This setting is only respected for Keyword Type level AutoFill Keyword Sets; it is not respected for Document Type level AutoFill Keyword Sets.

Note:

This setting can only be configured for one Keyword sub-element.

Note:

When the KeywordAutofill setting is set to true, the PreventAutofillOnUpload setting must also be set to true(i.e., to prevent the AutoFill Keyword Set from being expanded again when the corresponding document is uploaded to OnBase).

ID

This setting allows you to specify the Keyword Type Number for the Keyword Type being configured.

Tip:

A Keyword Type's Keyword Type Number can be found in the upper-right corner of the Keyword Type Configuration dialog box when a Keyword Type is selected. From the OnBase Configuration module, click Keyword | Keyword Types and then select the desired Keyword Type from the Defined Keyword Types list).

This setting is used when configuring your Front Office Scanning solution to work with E-Forms; depending on the configuration of your E-Forms, it may or may not be required.

For more information, see Configuring an Input Button to Create an E-Form.

type

This setting allows you to perform data validation on a Keyword Value to ensure that it contains only data allowable for its associated Keyword Type.

If the Keyword Value does not pass this validation test, an error message is displayed.

For example, if the MRN Keyword Type is configured as a Numeric 20 Keyword, but the registrar accidentally entered a value containing an alphabetic character (e.g., 123X56789), the validation test fails and an error message is displayed.

minLength

This setting allows you to specify a minimum character length for a Keyword Value to ensure that enough, if not all, of the value is captured to allow for retrieval.

If the Keyword Value does not pass this validation test, an error message is displayed.

For example, if minLength="6" for an alphanumeric ID Number Keyword Type, but the registrar accidentally entered a value containing only five characters, the validation test fails and an error message is displayed.

maxLength

This setting allows you to specify a maximum character length for a Keyword Value to ensure that it does not exceed the maximum allowable length for its associated Keyword Type.

If the Keyword Value does not pass this validation test, an error message is displayed.

For example, if the Social Security Number Keyword Type is configured as a Numeric 9 Keyword, but the registrar accidentally entered a value containing ten characters, the validation test fails and an error message is displayed.

Note:

If the maxLength setting is set to a value different than the value configured for the Keyword Type's Maximum Length setting, the setting with the smaller value prevails. For more information on general Keyword Type configuration, see the System Administration module reference guide or help file.

Note:

If Data Sets are only being generated from an HL7 message or from data captured by Application Enabler (i.e., Data Sets are never being manually created), the Keywords and DataSet elements are recommended, but not required. The Keyword Values (and their corresponding Keyword Types) for Data Sets created via HL7 and Application Enabler are specified in the Data Set XML file. Be aware, however, that the order in which Keyword Values are displayed in the Selected Data Set window for the Data Set can be controlled by the Keywords and DataSet elements (see Ordering Keyword Values in a Data Set), and, if these elements are not included in the configuration file, users will not be able to manually create Data Sets.