Types
FormMetadata
Type: Object
| Key | Type | Default | Description |
|---|---|---|---|
| name | string | - | Specifies the name of the form. |
| version | string | - | Specifies the version of the form. |
| templateId | string | - | Specifies the template id. |
| resources | Resources | - | Defines the resources for form. |
Resources
Type: Object
| Key | Type | Default | Description |
|---|---|---|---|
| description | object | null | Specifies the Ehr form description of the form. |
| layout | object | - | Specifies the layout of the form. |
Credentials
Type: Object
| Key | Type | Default | Description |
|---|---|---|---|
| username | string | true | Specifies name of the user. |
| password | string | true | Specifies password of the user. |
| authType | string | false | Specifies the type of authentication. |
MrdTimePlaceholderFormat
Type: Object
| Key | Type | Accepted | Required | Description |
|---|---|---|---|---|
| hour | string | Hour formats | false | Specifies the hour format. |
| minute | string | Minute formats | false | Specifies the minute format. |
ValidationModel
Type: Object
| Key | Type | Description |
|---|---|---|
| valid | boolean | Indicates whether or not the form is valid. |
| errorMessages | object | Specifies the validity for required fields in the form. |
InputItem
Type: Object
| Key | Type | Required | Description |
|---|---|---|---|
| label | string | true | Specifies the label value. |
| code | string | true | Specifies the code value. |
FormElement
Type: Object
| Key | Type | Description |
|---|---|---|
| name | string | Specifies the name of a form element. |
| type | string | Specifies the type of a form element. |
| value | object | Specifies the value of a form element. |
| aqlPath | string | Specifies the aql path of a form element. |
| isHidden | boolean | Specifies whether a form element is hidden. |
| isReadOnly | boolean | Specifies whether a form element is in read only mode. |
| isContainer | boolean | Specifies whether a form element is of type container. |
| min | number | Specifies the minimum multiplicity of a form element. |
| max | number | Specifies the maximum multiplicity of a form element. |
ScriptApiListenerOptions
Type: Object
| Key | Type | Default | Required | Description |
|---|---|---|---|---|
| onInitialValueSet | boolean | true | false | Specifies whether the script will run on initial load (when form is rendered). |
| searchWithinContainer | string | false | Specifies the parent container’s tag or id to search from. | |
| debounce | number | false | Specifies an amount of time in milliseconds that the listener should wait before processing a new event |
ScriptApiClearOptions
Type: Object
| Key | Type | Accepted | Required | Description |
|---|---|---|---|---|
| prop | string | Property names | false | Specifies the property name of form element. |
| searchWithinContainerTag | string | false | Specifies the parent container’s tag to search from. |
Variable
Type: Object
| Key | Type | Accepted | Description |
|---|---|---|---|
| id | string | Specifies the id of a variable. | |
| name | string | Specifies the name of a variable. | |
| mandatory | string | Specifies whether the variable value must be provided. | |
| type | string | Variable types | Specifies the type of a variable. |
| value | string, number, boolean, object, or array | Specifies the value of a variable. | |
| source | string | Variable sources | Specifies the source of a variable. |
| created | string | Variable creation types | Specifies the creation type of a variable. |
| dependentFields | array<string> | Specifies the form ids of form elements that are dependent on a variable | |
| testValue | string, number, boolean, object, or array | Specifies the value of a variable that is used when building a form. |
ModelDuplicate
Type: Object
| Key | Type | Description |
|---|---|---|
| duplicatedModel | object | Specifies the duplicate of a model. |
| modelIndex | number | Specifies the index of a model based on the parent model children. |
FormInfo
Type: Object
| Key | Type | Description |
|---|---|---|
| name | string | Specifies the name of the form. |
| version | string | Specifies the version of the form. |
| templateId | string | Specifies the template id. |
| tags | object | Specifies the tags of the form. |
ImageArea
Type: Object
| Key | Type | Accepted | Required | Description |
|---|---|---|---|---|
| shape | string | 'rect', 'circle', 'poly' | true | Specifies the shape of the area |
| coords | string | true | SVG coordinates of the shape (example value for rect: '206,153,257,192' | |
| value | string | false | Each area should have a corresponding value that maps to one field input value | |
| title | string | false | Title of the area shown as helper text if user hovers the area | |
| color | ImageAreaColor | false | Color attributes of the image area |
ImageAreaColor
Type: Object
| Key | Type | Description |
|---|---|---|
| fill | string | Specifies the fill color of the area provided in HEX format (e.g.: #fefefe) |
| outline | string | Specifies the border color of the area provided in HEX format (e.g.: #fefefe) |
PreSaveHookOptions
| Key | Type | Description |
|---|---|---|
| catchError | boolean | Specifies if the error should be handled if the hook throws an error |