Versions Compared

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.

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:

...