About User Defined Fields and Field Prompt Sets

Generally, Letter Writer Fields are based on data taken from the patient and user databases, or ancillary information like today's date for example. When you have exhausted the range of fields available from the Data Toolbar, you can create your own customised or 'user-defined' fields.

When such user-defined fields are added to a template and then a letter based on that template is created, any user-defined fields within it will prompt you for input. You can also create a user-defined field prompt set. A set of user-defined field prompts appears a questionnaire window; you complete the questionnaire, after which the information you entered is added to the letter. Prompt sets include features that are not available to individual user-defined fields, such as:

You can indicate that each field within the set of prompts is compulsory.

You can add notes to the set of prompts to inform users of what information is required for each field.

After responding to a set of prompts, the data you enter appears within a table in the letter.

Note that user-defined fields have an association with the template in which they are created, and are not available to other templates. In other words, although you might create a user-defined field that shares its name with that from another template, the two fields are considered separate entities.

Example

	Two supplied fields are displayed here; <<Patient Demographics Full Name>> <<Patient Demographics Full Address>> Upon creating a new letter based on this example template, these two fields will automatically be replaced by the data they relate to; the patient's full name and full address, as recorded in Clinical.
	This is the Custom Field Properties window. When you add a User-Defined field to a template, this window appears, and it is within this window that you specify what sort of user-defined field you are adding to your template. In the example below; The user has selected 'Prompt' as the type of field. By selecting 'prompt' here, the user is indicating that they wish to insert multiple user-defined fields, of varying types (if desired), as opposed to inserting a single user-defined field. See User-Defined Fields for information on inserting single user-defined fields. They have also specified that this user-defined field set consists of three fields, named "Note Field 1", "A Text Field", "Note Field 2", as indicated in the Items section in the example. This means that when a user creates a new letter based on this template, they will be prompted to provide information for these three fields. They have named the field 'My Demo Prompt Set'
	This is what a user-defined field looks like after it has been inserted into a template; similar to a supplied field, but with a name you have provided it.

Create a User-Defined Prompt Set for a Template

Ensure you are working within a new or existing template.

Ensure that the Data Toolbar is visible. The Data Toolbar can be enabled/disabled by pressing Ctrl+D.

Position the cursor in your document where you wish to insert the User-Defined Prompt field (this is where you want the text to eventually appear on the page).

Locate and double-click the User Defined template field from the Data Toolbar. The Custom Field Properties window appears.

From the Field Type drop-down list, select Prompt.

 

The Custom Field Properties window will now display settings for the custom prompt.


It is with this window that you create a set of custom fields that make up your prompt. For example, your custom prompt might consist of a single question with an associated text field for users to enter their response, or it could be made up of a series of different questions with different user input mechanisms.

 

Enter a name for your custom prompt set in the Caption field.

Add custom field items to your custom prompt set. To do this, click Add   The Custom Field Properties window appears again.



Normally you would use this window to add a custom field to your letter template. This time however, you use this window to add a custom field to your prompt set. See User-Defined Fields for more information about creating individual custom fields.

Add as many custom fields to your custom prompt set as required. The following field types are available:

Field Type	Description
Character	A single line of text. You must also indicate the maximum number of characters this line of text can hold via the associated Max. Length field.
Character Multiline	Multiple lines of text.
Date (Long)	The long-date format, as set in Windows' Regional Settings. Options include; To display a default value (as entered by the user) To default to the current date To use the last saved value.
Date (Short)	Windows short-date format,  as set in Windows' Regional Settings. Options include; To display a default value (as entered by the user) To default to the current date To use the last saved value.
Fixed Note	One or more lines of informative text that appears within the prompt set at the time it is called, when you create a new letter. A 'fixed' note only appears on the prompt set itself and is never added to your resulting letter. An example of a fixed note appears in the example following, at Step 13.
List	A list of text entries that the user can select a single item from.
Number	A positive number. You must also indicate the maximum number of digits this number can be via the associated Max. Length field.
Yes/No	Either 'Yes' or 'No' appears within the resulting letter. However, within the prompt set itself, this appears as a check box for you to either tick (for Yes), or leave empty (for No).
Prompt	A set of one or more of the other field types, combined and displayed in a table within a letter. See User-Defined Prompt Sets for more information.

 

(Optional)

Add a Cancel button to your custom prompt by ticking the associated checkbox on the Custom Field Properties window.

To ensure that all fields are mandatory, tick the associated checkbox on the Custom Field Properties window.

 

(Optional) Re-size the Output Table Column Divider using the associated slider on the Custom Field Properties window.

When your custom prompt set is used in a letter, the user's responses to your prompts are displayed in the letter in a table with two columns; column 1 contains the prompt questions and column 2 contains the user's responses. The Output Table Column Divider is the divider between these two columns in the output table. The default setting is 50%. This can be altered manually once the resulting table of data appears in your letter.

 

Click to save your custom prompt set settings and add the custom prompt set to your template.


If you wish to edit this custom prompt set after you have added it to a template, right-click the custom prompt set placeholder and select Properties from the menu that appears.

 

Remember to save this template

When you create a new letter based on this template, you will be prompted to enter data for your User-Defined set of fields, as shown below.


 
The resulting table of data: