Versions Compared

Old Version 12

changes.mady.by.user Lucy Jemutai

Saved on

compared with

New Version 13

changes.mady.by.user Lucy Jemutai

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Element

Type

Description

name

string

The name of the form. This is required and should be unique within the system.

uuid

string

The unique form identifier

encounterType

string

The encounter type uuid associated with the form’s encounter. This defines the context in which the form is used.

inlineRendering

single-line / multi-line / automatic

The inline rendering mode

pages

Array<Section>

A collection of pages that make the form. Each page contains sections and questions.

availableIntents

Array<Intent>

A list of intents supported by this form. Intents define specific actions associated with the form.

Additional form properties

Validators

array of objects

These are the conditions that validate the input data.

Default

string/ number/boolean,/object

Default values for fields in the form.

Required

boolean

Fields that must be filled out or selected.

historicalExpression

string

Expression or data related to historical information.

Hide

object

The option to hide certain parts of the form or fields.

CalculatedExpressions

string

Expressions that calculate values based on inputs.

questionInfo

string

These are additional information or context about a question.

answers

array of objects

Responses or answers provided in the form.

orderType

string

Type of order or sequence for form elements.

selectableOrders

array of objects

Orders that can be selected or applied.

conceptMappings

array of objects

This is the mapping of concepts to specific form elements.

Concept ID

string

Identifier for a specific concept within the form.

Pages

A page is a collection of related sections. A typical page definition consists of a label, inlineRendering (optional) and a list of sections. The engine uses the page’s label to identify it from other pages; that being said, it’s mandatory to keep the page’s label unique. Below is an example of a form with one page and section. The section has 4 questions labelled:

...