|
description
Adds the specified form component to the current update.
type
Data symbol function.
syntax
ADD_FORM_COMP(folderpath, name, insert_position, OPEN, label)
arguments
|
folderpath
|
A string specifying the location of the form to be added. |
| name |
The name of the form to be added. |
| insert position |
Optional. Position in the forms list where the new form should be added. Acceptable values for insert point are:
AT_END (default if nothing is specified)
AFTER_CURRENT
AT_BEGINNING
BEFORE_CURRENT
Ordinal number
Note. An ordinal number is the numerical order in which to insert the form, moving other forms down in the list. If an ordinal number is used, the form is inserted into that numerical position in the update. For example, if you had 1,2,3 in the update and you inserted a form with a position argument of 2, it would become 2, 2 would become 3 and 3 would become 4.If the number used is larger than the number of forms in the update, then the form is inserted at the end. Any unrecognizable value for the insert position will be interpreted as AT_END
|
| OPEN |
Optional. Opens the form after inserting it into the update. |
| label |
Optional. Displays a label with the form name when the form is referenced in the update. This label would appear in the left-hand list of forms along with the default form name. |
when to evaluate
When Inserted in Note or when clicking on an action button
returns
Adds the specified form to the current update, and opens it if the OPEN argument is present.
comment
This data symbol cannot be used with quick text.
example 1
{ADD_FORM_COMP('Enterprise\Medicalogic\Exam','Vital Signs',’AFTER CURRENT’,’OPEN’)}
Inserts and opens the Vital Signs form into the current update after the currently selected form. If used within an encounter form, the currently selected form will be closed. If used from a text component, then no form will be open when evaluated.
example 2
{ADD_FORM_COMP('Enterprise\Medicalogic\Past Medical) History,'Histories','3',' ','Past, Family, Social')}
Inserts the predefined Histories form into the update as the third form in the list and displays the name of the form as Histories - Past, Family, Social in the forms list column.
error handling
If the insert position number is greater than the number of forms in the update, the form is inserted at the end. No error message appears when a form cannot be found.
where used
Encounter forms, text components
|
