Skip to main content

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.

Image of a Vocabulary collection in irAuthor Web.

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.

Template properties​

In Template properties, configure the following fields.

Template type
Select a template type:

  • Add Collection Member
  • Expression

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:

  • Expressions
  • Options

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.

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.