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
- submission - any form or rule derived data
- plan - fixed plan attributes (e.g. start date) and calculated columns
- integration - any incoming payload that a plan has been configured to receive
- workQueueItem - fixed work queue item attributes
Categories
Some entities must define a second level:
- submission, category is the form name
- integration, category is the subject (a.k.a topic) name
- workQueueItem, category is the work queue name
- plan, there is no category and the reference requires only two levels
Fields
A field is defined by a name and type information
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:
carePlan.status
These data references are used by by Healix Expression Grammar discussed next.
Catalog
The following fixed attributes are available
| Entity | Field | Permitted Values | Writeable |
| plan | title | read only | |
| plan | startDate | read only | |
| plan | endDate | read-write | |
| plan | status | OPEN, CLOSED | read-write |
| plan | riskStatus | read-write | |
| workQueueItem | title | read only | |
| workQueueItem | createdAt | read only | |
| workQueueItem | ticketNumber | read only | |
| workQueueItem | priority | read-write | |
| workQueueItem | serviceLocation | read-write | |
| workQueueItem | queuePosition | read-write | |
| workQueueItem | status | statuses defined in the work queue definition | read-write |