Adding, Editing, and Deleting in YAPI Documents

Adding and editing questions for your YAPI Documents is surprisingly easy to do with a large number of customization options to better fit the content of the document. Being able to create forms can be found in the Creating an IPad Form With The Form Builder article, however, the purpose of this article is to introduce how to add, edit, and delete content to preexisting documents. 

Table of Contents

How to Open the Form Builder

2019-11-07_14-02-27__2_.gif

  1. To access the Form Builder, open the YAPi Dashboard.

  2. Click the Setup and Manage icon 2019-09-03_11-44-13.png at the top of the YAPI Dashboard and click the Manage Documents and Templates option from the dropdown.

  3. When prompted for a password, the password by default should be set as "password" all lower case. 

  4. Within the Manage Documents and Templates window, click on the iPad Forms tab. 

  5. Look and click on the document you wish to edit, then click on the Edit button on the right-hand side of the Manage Documents and Templates window. 

Adding Content

At the bottom of the Form Builder window is an Add button. Clicking on the Add button will introduce a drop-down window that will give a list of questions to introduce into the form. 

2019-11-07_12-38-35.png

With the Question type added, double-clicking the row will open up a window associated with the question type with its own field and options. 

The following Question types are useful options to choose from to help expand on the potential questions that may be given to a patient at the time of their appointment. 

Paragraph

The Paragraph type is used for the majority of larger body texts that contain several paragraphs of text.  A common example is the main text body for consent forms.

 Paragraph_Fields.jpg

1.png Paragraph Area to write your text.

2.png

 

 

 

 

 

 

Spell Check

 

 

 

 

 

 

Use this to check your spelling. If you click on this button all misspelled words will change color to red.

paragraph_spelling.jpg

3.png Vertical adjustment Adjusts the vertical position of your text
4.png Text Color Changes the text color.

5.png

 

Destination

 

Choosing a destination determines where the paragraph will be displayed. You can choose between “iPad”, “Online” or “Both”.

6.png

 

 

Has HTML

 

 

Checking this box allows you to use HTML code to format your text. If you include HTML and don’t check this check box your code will appear along with the paragraph text instead of the formatting applied to the text. 

 

 

Header

Header_with_callout.jpg

This is the title of the form being created or modified that appears at the top of any form. Common examples are “Dental History” or “HIPAA Notice of Privacy Practices.”

 

Header_Details_with_numbering.png

1.png Header Text The text that appears in the header.
2.png Text Size You can choose from Default, x-small, small, large, and x-large.
3.png Alignment Choose from Left, Center, and Right.
4.png Text Color The color of the text. Double-click to open the color picker.

5.png

 

Background Color

 

The color of the background behind the text. If Transparent is turned on, this option will be disabled. Double-click to open the color picker.
6.png Destination The Header component can work in both iPad and Online modes.

7.png 

Transparent

 

Disables the Background Color setting. If you use this option, select a dark Text Color to properly contrast the white background of the application.

NOTE: For longer header names, use a smaller text size and left-align your text. Otherwise, center-align the text. Also avoid using all caps headers.

Label

Label_2.jpg 

Use the Label question type to mark logical sections or groups of questions.

label_fields.jpg

1.png Label Text This is the text of the label as it appears on the form.
2.png Text Size Your options are Default, x-small, small, large, and x-large.
3.png     
4.png Destination This components work for both iPad and Online modes.
5.png Text Color Your options are Black, Red, or Blue. 

Single-Line Text

IMG_0011.png

A Single-Line Text is an open-ended question type that can give the patient the ability to answer the question with their own answer. 

Single_Line_Fields.jpg

1.png Question The single-line text question.

2.png

 

Inline

 

Indents your single-line text. When you click on this checkbox a Width drop-down appears. You can choose your width or leave the default value.
3.png Answer is required Makes the field mandatory for the patient to fill in to proceed.
4.png Has Border Creates a border around your single-line text.
5.png Input Type Formats your field to the type of data you want to enter in the field.

6.png

 

 

Placeholder

 

 

Adds grey text in the field that can be a further explanation of the formatting expected or provides an example of what to input. As soon as you start typing the placeholder text goes away.

 

Multi-Line Text

IMG_0011.png

Like a Single-Line Text, a Multi-Line Text allows for an open-ended response by the patient to fill in their own answer. Multi-Line Text is unique in the sense that it introduces a larger field to input additional information that may not be sufficient with a Single-Line Text. 

Multiline_Fields.jpg

1.png Question The multi-line text question.
2.png Answer is required Makes the field mandatory for the patient to fill in to proceed.
3.png Has Border Creates a border around your multi-line text.

 

YesNo

IMG_0011.png

The YesNo question type allows for a question that simply requires a yes or no response. Further options can also enable for further clarification to the response, such as in the above example. 

The available options for this field type are:
YesNo_Fields.jpg

1.png Question The Yes/No question.
2.png YesNo The text that will be displayed for a positive/negative answer.
3.png Inline Indents your Yes/No.
4.png Answer is required Makes the field mandatory for the patient to fill in to proceed.
5.png Has Border Creates a border around your Yes/No element.
6.png Small Makes text smaller. This can be used for long questions.

7.png

Required

Makes the Yes/No conditional; meaning if you choose an answer the element will prompt you to explain your answer further.

8.png

 

When Yes/ When No

 

Specifies when the element will display a single line text field to explain your answer. The Required checkbox has to be checked to enable this option. 
9.png

Placeholder

The answer prompt that provides different default options or allows you to type in a custom prompt. 


NOTE
: Avoid making the question too long or a filler will be required to ensure proper spacing.

List

IMG_0011.png

IMG_0012.png

The List question type visually looks similar to a Single-Line Text. However, when clicking the field a new window will appear showing a list of preselected options that can choose a single option. 

The available options for this component are:

List_Fields.jpg

1.png Question The List question.

2.png

 

Inline

 

Indents your List.  When you click on this checkbox a Width drop-down appears. You can choose your width or leave the default value.
3.png Answer is required Makes the field mandatory for the patient to select an answer from the list to proceed.
4.png Has border Creates a border around your List.
5.png Selection Option

Contains the list values. Write each value on a separate line.

6.png

 

Destination

 

Choosing a destination determines where the Label will be displayed. You can choose between “iPad”, “Online” or “Both”.

Checkboxes

IMG_0011.png

The Checkbox question type allows for the selection of either a single or multiple options from a list. An additional "Other" option can be included to introduce a custom response by the patient. 

The available options for this component are:

checkboxes.jpg

1.png Question The checkbox question.
2.png Has border Creates a border around your checkboxes.
3.png Small font Makes your font smaller.

4.png

 

Columns

 

Organizes your answers into columns. You can have up to 3 columns.

 

5.png 

Has other option

 

Adds an extra checkbox called “Other” and if it’s selected a single-line field will appear for you to fill in.

6.png

 

 

 

 

 

 

Use YN button

 

 

 

 

 

 

Replaces checkboxes with YN selection icons. It is advised not to use this option as it appears very small on the iPad screen hence very hard to read.

YN_Option_Checkbox.jpg

7.png Single selection is required Makes the field mandatory for the patient to select a single answer to proceed (for iPad only).

8.png

 

Selection Option

 

Contains the checkboxes values. Write each value on a separate line.

9.png

 

Destination

 

Choosing a destination determines where the checkboxes will be displayed. You can choose between “iPad”, “Online” or “Both”. 

 

Acknowledgment Checkbox

IMG_0011.png

An Acknowledgement Checkbox allows for the patient to confirm specific information before proceeding with the document. A good alternative in place of a field that would typically require initials. 

The available options for this component are:

Acknowledgemenet_Checkbox_Fields.jpg

1.png Header (for online form)  The acknowledgment instructions.
2.png Statement The statement that needs to be acknowledged.
3.png Acknowledgment is required  Makes the field mandatory for the patient to check the checkbox to proceed.

4.png

 

Destination

 

Choosing a destination determines where the checkboxes will be displayed. You can choose between “iPad”, “Online” or “Both”.

Editing Content

2019-11-07_13-13-56__1_.gif

To edit a preexisting question type, double-click the row within the Form Editor. Each type will have a field that includes the content of the question viewable by the patient. All adjustments done to the type requires the window to be completed by clicking OK, then finalizing the changes for the form by clicking the Save button at the bottom of the Form Builder. 

Changing the Title and Name

In the top-left corner of the Form Builder is the name of the form being edited. There are two fields to be aware of: Title and Name.

2019-11-08_14-48-45.png

  • The Name will be the form visible in the Manage Documents and Templates window and to the patient when viewing the document on the iPad.
  • The Title will be the name seen when viewed from the Online New Patient Package. 
NOTE: Edits introduced with a new Name will create a new instance of the form and will need to be activated and replaced in the packages currently used on the iPad and Online packages.  

Moving Content

Moving rows is as easy as simple as clicking, dragging, and dropping the row in the order that will be applied.

2019-11-08_14-51-05__1_.gif

Deleting Content

2019-11-08_12-18-37__1_.gif

To delete a preexisting question type, click and highlight the row to delete, then click the Delete button on the bottom-left corner of the Form Builder window. 

Testing Documents

 Once all the additions and/or edits are finished, ensure that the document is available by confirming the document is available to be viewed on the iPad. 

A full break down on how to test and preview your form can be found in the Preview Your Form on an iPad article.

Was this article helpful?
0 out of 0 found this helpful