Data References

To reference data, names for levels are separated by . are used when functions need coordinates for a data point. For example:

entity.category.field

Entities

Entity is the highest level of categorization for data. Two entities currently exist

• integration - any incoming payload that a plan has been configured to receive
• plan - fixed plan attributes (e.g. start date) and calculated columns
• submission - any form or rule derived data
• user - user profile data
• workQueueItem - fixed work queue item attributes

Categories

Some entities must define a second level:

• integration, category is the subject (a.k.a topic) name
• plan, there is no category and the reference requires only two levels
• submission, category is the form name
• user, category is the user's role as defined in the plan
• workQueueItem, category is the work queue name

Fields

A field is defined by a name and type category.

Usually fields are dynamically defined based on the configuration of the form, plan, and integration.

Examples

For example, to get a field named "field1" from a form named "form1":

submission.form1.field1

Or to read the status of a plan:

plan.status

These data references are used by by Healix Expression Grammar discussed next.

Catalog

The following fixed attributes are available

Entity	Category	Field	Permitted Values	Writeable
integration	$subject	_submitted		read only
submission	$formName	_submitted		read only
plan		title		read only
plan		startDate		read only
plan		endDate		read-write
plan		status	OPEN, CLOSED	read-write
plan		riskStatus		read-write
user	$role	title		read-write
user	$role	firstName		read-write
user	$role	middleName		read-write
user	$role	lastName		read-write
user	$role	fullNam		read
user	$role	email		read-write
user	$role	phone		read-write
user	$role	dateOfBirth		read-write
user	$role	gender		read-write
workQueueItem	$workQueueName	title		read only
workQueueItem	$workQueueName	createdAt		read only
workQueueItem	$workQueueName	ticketNumber		read only
workQueueItem	$workQueueName	priority		read-write
workQueueItem	$workQueueName	serviceLocation		read-write
workQueueItem	$workQueueName	queuePosition		read-write
workQueueItem	$workQueueName	status	statuses defined in the work queue definition	read-write

Where $formName, $subject, $workQueueName, and $roleName are the names of the form, subject, work queue, and role respectively.