Vocabulary templates

Vocabulary allows rule-writing experts to define reusable linguistic templates called vocabulary templates. These templates standardize how rules can be written in natural language.

Vocabulary templates can be used in Language rules to help business users author rules using familiar terminology and guided structures.

Create a vocabulary template

1. Navigate to Vocabulary from the main navigation.
2. Select the entity you want to create the template for.
3. Select Add to create a new template.

Create a template for another entity

To create a vocabulary template against a different entity:

1. In the navigation bar, open the ellipsis menu (...).
2. Select the entity you want to create the template for.

Only entities are available in this menu.

Template properties

In Template properties, configure the following fields.

Template type
Select a template type:

• Add Collection Member
• Expression
• Execute rule set
• Execute member rule set

The Execute rule set and Execute member rule set types are described in Execute rule set and Execute member rule set templates.

Name
Enter the internal identifier for the template.

Display name
Enter the name users will see when selecting the template.

Menu group
Select a menu group:

• Actions
• Expressions

Scope

Under Scope, use the toggles to control where the template can be used.

1. Available for rules and calculations for this entity
When enabled, the template is available when authoring rules and calculations in the context of the entity where the template is defined.

2. Available for rules and calculations for entities referencing this entity
When enabled, the template is also available when authoring rules and calculations in entities that reference the entity where the template is defined.

Example: entities referencing this entity

If you have a parent entity that contains this entity as a collection, the parent entity is referencing this entity.

For example:

• Cost Share Determination (parent entity)
  • Patient visits (collection of Patient visits entities)

In this example, Cost Share Determination references Patient visit because Cost Share Determination contains the Patient visits collection.

If the template is created in the Patient visit entity context and you enable Available for rules and calculations for entities referencing this entity, rule authors can use the template when authoring rules and calculations in the Cost Share Determination context.

Business language

Use the Business language text box to define the natural language sentence used by the template.

To define a placeholder in the business language, wrap the placeholder name in dollar signs.

For example:

• $Amount$
• $ServiceDate$
• $Reason$

The placeholder names used here must match the placeholder Name values configured in the Placeholders section.

Placeholders

In Place holders, select Add to create placeholders used by the template.

For each placeholder, configure:

Name
The placeholder identifier. This must match the placeholder used in the business language string.

Display text
The text shown to the user when they fill in the placeholder.

Accepted types
Select the value types allowed for the placeholder:

• boolean
• date
• datetime
• decimal
• integer
• text

Multiple values
Enable the toggle to allow the placeholder to accept more than one value.

Delete
Select the trashcan icon to delete the placeholder.

Evaluate to

Use Evaluate to to specify the data type returned by the template.

The available options are:

• boolean
• date
• datetime
• decimal
• integer
• text

Expression

In Expression, use the expression editor to define the logic that the template generates.

The expression uses the placeholder values as inputs.

Execute rule set and Execute member rule set templates

Two template types run a rule set from within a vocabulary template. Both share the common template properties described above (Name, Display name, Menu group, and Scope) and add their own fields.

note

These are template types in the vocabulary editor. They are different from the Execute rule set and Execute member rule set actions on the Actions page.

Execute rule set

The Execute rule set template runs a target rule set, optionally passing parameters.

Target rule set Enter the rule set to run. This is a single value.

Rule set parameters Map values to the target rule set's parameters using a name/value grid. The grid is keyed by parameter name, and each parameter is mapped to an expression. The value column is labeled Expression.

Execute member rule set

The Execute member rule set template runs a target rule set against each member of a collection, optionally filtering which members are included.

Target collection Enter the collection to run against. This is a single value.

Target rule set Enter the rule set to run. This is a single value.

Collection member filter expression Optionally enter an expression to filter which members are included. This is a single value.

Rule set parameters Map values to the target rule set's parameters using the same name/value grid as Execute rule set.

Limitations

Current limitations:

• The target rule set and collection are entered as single values. They are not picked from a live dropdown.
• Expressions and placeholders are not allowed in the target rule set and collection fields.
• There is no authoring-time validation. Validate the rule application explicitly or on check-in.

Where vocabulary actions and templates appear

• Vocabulary-defined actions are reachable from the main rule and action menu.
• New templates appear in the authoring menus by default.
• Templates can be created against multiple entity contexts from the navigation bar. See Create a template for another entity.

Edit a vocabulary template

1. Navigate to Vocabulary.
2. Select the entity that contains the template.
3. Select the template from the list.
4. Update the template fields as needed.