Bowel Preparation App: User Guide - CS-CSIFcsiflabs.cs.ucdavis.edu/~cs193/User's Guide/Bowel Prep...
Transcript of Bowel Preparation App: User Guide - CS-CSIFcsiflabs.cs.ucdavis.edu/~cs193/User's Guide/Bowel Prep...
1
Bowel Preparation App: User Guide
Team Members: Ela Amatya, Kevin Huang, Kevin Lee, Tsz Kit Lo, and Guangsha Mou Client: Sooraj Tejaswi Professor: Xin Liu
2
Table of Contents 1. Preface pg 3
1.1 README 1.2 Summary 1.3 Audience 1.4 Vocabularies
2. Overview of the Product pg 4 3. Installation or Distribution pg 4 4. Functionalities pg 5
4.1 Appointment Setup/ App initialization 4.2 Tab Views
4.2.1 Checklist View 4.2.2 Appointment View 4.2.3 Instruction View 4.2.4 FAQ View Frequently Asked Questions
4.3 Notifications 5. Troubleshooting pg 11 6. Frequently Asked Questions pg 11 7. Contact information pg 12 8. Index pg 13 9. Appendix pg 14
3
1. Preface 1.1 README
Authors: Ela Amatya, Kevin Huang, Kevin Lee, Tsz Kit Lo, and Guangsha Mou 1.2 Summary
When a patient is scheduled a colonoscopy, they are often provided paper instructions and various online resources that the patient must strictly follow prior to the procedure. However, patients tend to overlook these instructions, forget about it, or simply follow them too late. In a standard colonoscopy, patients must follow the instructions tightly especially starting 5 days before. Another problem is the frequent calls to the office for frequently asked questions, which tends to waste the doctor’s time. This app strives to solve these two problems by providing notifications to alert users of the daily instructions, providing a user friendly interface to view their instructions, and providing various resources and information regarding the colonoscopy procedure.
1.3 Audience This user guide is intended for users of the bowel preparation. This app
was optimized for colonoscopy patients which are usually in the age groups of 50 years old and above.
1.4 Vocabularies Instructions These are daily instructions provided to the patient that
consist of strict dietary guidelines and tasks that the patient must follow.
4
2. Overview of the product This application is designed to guide patients in preparation for a colonoscopy
and will replace the current method of paper instruction distribution. It includes instructions for the five days leading up to the procedure. After an appointment date, location and current medications are inputted, the
user will be alerted of any conflicts with the preparation if one exists. The user will then receive reminder notifications starting five days prior to the
appointment date until the day of the appointment. The user can consult the application for FAQs (equipped with a search tool),
instructions for any of the five days, and colonoscopy related videos. Additionally, the appointment date can be added to your phone calendar and directions to your appointment location may also be accessed via the application.
A successful preparation is vital for a successful colonoscopy and this application's purpose is to enforce the preparation instructions in the most effective way.
3. Installation/Distribution The mobile application: “Bowel Preparation” is available in the iOS App store. In
order to download the application, users need to search the application name in either the App store or on iTunes.
iPhone users with a version of 8.0 or higher will be able to use the application.
5
4. Functionalities 4.1 Appointment Setup
For legal purposes, users will have to accept the disclaimer in order to use this app. Figure 1.
Figure 1 Figure 2
After accepting the disclaimer, the user will be presented with a screen to add an appointment (Figure 2). Then, the users will input necessary information regarding their procedure as seen below.
6
4.2 Tab Views This app is separated into 4 tab views: Checklist, Appointment, Instruction, FAQ
4.2.1 Checklist View: the user will be able to view what they must do today. This is especially helpful starting 5 days before the procedure.
7
4.2.2 Appointment View: This view consists of the general information regarding the user’s appointment. User’s may interact with the buttons.
Location Button: Helps user open iOS builtin Maps app and pinpoint the location.
Date Button: Allows user to synchronize appointment time with iOS builtin Calendar app. The user has the option to remove appointment information from the Calendar app as well.
Medication Button: Lets the user know whether they have medication conflicts.
Today’s Instruction Button: Helps user navigate to the instruction view for the current day.
Edit Appointment Button: User may change the information regarding their appointment. Note that this is the same as the appointment setup view.
8
4.2.3 Instruction View Shows all the instruction that the user should follow on the current day. The user can also view instructions for other days or general instructions by selecting the appropriate days from the drop down list.
9
4.2.4 FAQ View (Frequently Asked Questions): The user will be able to scroll through a list of Frequently Asked Questions and query the questions using a provided search bar. The user can also select the category to pinpoint their questions
10
4.3 Notifications:
Notifications are sent to the user beginning on the fifth day prior to the procedure. Two notifications are sent each day for the day’s instructions. Additionally, a day before and on the day of the appointment, several notifications are sent in regards to the solution the user is supposed to drink.
11
5. Troubleshooting 5.1 How do I start from scratch again, from the the disclaimer page?
Recall that you can configure your appointment information via the Appointment Tab > Edit Appointment. However, if you would like to start from the very beginning, simply delete the app and reinstall the app again.
6. Frequently Asked Questions 6.1 Is there a way to access my medical records and synchronize information from my colonoscopy facility website that I have online?
Unfortunately, this application does not support synchronization with online networks as medical records are highly sensitive.
6.2 Are there applications that the Bowel Prep App utilize? Yes. After you create an appointment, you can add the appointment to your
Calendar. In addition, you can click on map icon to get directions to the location of your appointment via Maps.
6.3 When will I receive my push notifications? Typically, notifications are sent 15 minutes prior to an action having to take place.
For example, if you are to take medication at 6:00 PM, you will receive a notification at 5:45 PM.
6.4 How can I report bugs that I find while using this application? Please contact one or more (it is recommended that you CC all) of the authors
listed under Contact Information.
12
7. Contact Information Guangsha Mou
Lead Application Developer Email: [email protected]
Tsz Kit Lo Application Developer Email: [email protected]
Kevin Lee Application Developer Email: [email protected]
Kevin Huang Release Engineer Email: [email protected]
Ela Amatya: Application Developer Email: [email protected]
13
8. Index
Index Locator (Left Navigation Pane)
Authors Preface README
What problem does the Bowel Prep App solve?
Overview of the product
Downloading the App Installation/Distribution
Is my iPhone version compatible with the app?
Installation/Distribution
Creating an appointment Functionalities Appointment Setup
Colonoscopy instructions Functionalities Instruction View
Frequently Asked Questions about Colonoscopy
Functionalities FAQ
Frequently Asked Questions about the Bowel Prep Application
Frequently Asked Questions
14
9. Appendix Appendix A: Requirements Document Revision History: 1/20 Initial Commit
1/24 Kevin Huang added Glossary terms, and Requirements
1/30 Kevin Lee added introduction edited by Ela
2/06 Ela and Jay added deadlines for each user case
3/08 Kevin Huang added new Use Case and Class diagram.
3/12 Kevin Huang added new Glossary terms and new use case/user story. Kevin Lee updated System Architecture Overview descriptions.
5/29 Kevin Lee created user guide. Ela added the Notifications section and updated User Requirements. Kevin Huang Added the Index section.
15
Introduction
Doctors often provide colonoscopy patients a paper set instruction for the 5 day colon cancer screening preparation. Each day requires strict guidelines such as dietary rules and patient specific notes. The issue with paper instructions is that patient are responsible for remembering to read and follow the instructions every day, starting five days prior to their colonoscopy. One of the most common mistakes patients make is that they overlook, forget or lose the paper instruction, or look at it a day or two before their appointment, when it is already too late to begin the preparation procedure. In addition, paper notes do not allow patients to easily access additional information regarding colonoscopy and would require the patients to keep track of several papers.
In this senior design project, Dr. Sooraj Tejaswi proposed an app that replaces the paper instructions. Not only will the paper instructions be replaced, but informational sections such as “Frequently Asked Questions” and helpful videos can be dynamically added to further assist the patients. This will also be the first goto place for patients regarding any general procedure questions before calling the doctors. This would benefit both the patients and the doctors. Doctors are often very busy and sometimes unable to answer patient phone calls and in the case that they do, they have to answer the same questions several times for different patients. This app would provide all of the patients with answers to frequently asked questions. It would also help the patients as they would not have to call and wait to hear back from doctors for general questions.
Since patients must follow strict guidelines starting five days prior to the procedure, this app will focus in providing important and necessary alerts and notifications to the patients to make sure that they are instructed to follow the required guidelines in a timely manner. This step is crucial in many medical preparation procedures, since a mistake in the preparation stage can jeopardize the procedure altogether. Proper preparation is especially important for colonoscopy so that the doctors are able to clearly detect and remove any potential cancer cells. An improper preparation could highly risk such cell detection.
In all, the vision of this app is to upgrade from paper instructions and actively assist patients in preparing for a colonoscopy in a user friendly, intuitive and efficient app.
16
Glossary of Terms Agile Development development method that allows for changes, testing, etc. during biweekly sprints; more flexible than the traditional waterfall development method where a bunch of development is done all at once, and testing is done at the very end. API Level in short, this is the android version. Higher API levels permit more advanced features to be used in Android Studio but the shortcoming is that many older Android devices may not support that API level. Apple Push Notifications allows mobile apps to forward notifications to users of the app in the form of badges, sounds, or text alerts. Bitbucket online version control tool that allows developers manage different branches of source code; uses Git requests to commit, pull, push, merge, etc. Colonoscopy a procedure that permits the doctor(s) to use a colonoscope that is inserted through the anus to check the linings of the colon. The colon is composed of the rectum and large intestine. Google Calendar API allows developers to integrate their app with Google Calendars so users can create events, add date/times, etc. IPA a format of an iOS app that can be downloaded by iOS users for Ad Hoc Distribution. Parallax displacement of the seen position of an object viewed from different perspectives. Storyboard (Xcode) used to design/manage the interface of an iPhone app. It presents to you the entire layout of all the screens connected by segues. Swift programming language for Apple OS products including iOS. It will supplant ObjectiveC in the near future. UI Collection View presents a collection of data items and presents them to the user in customizable layouts such as multicolumn grids, tiled layouts, circular layouts, and more. Xcode platform used to create apps for OS X, iPhones, and iPads. Xib XML Interface Builder; typically used by developers and designers to build the Graphical User Interface. System Architecture Overview
17
New Use Case Diagram:
Class Diagram:
This is a general overview in a class diagram of the interaction regarding the doctor, patient and the application.
18
High Level Picture: This is the initial wireframe of the application. V2 update: Minor UI color scheme and design have been updated. V3 update: Consult previous pages for the updated design screenshots
Requirements
The following are functionalities/features specifically requested by our client. Below each case is the status of the feature. “Completed” means the feature is fully implemented and tested to work as expected.
Use Cases/User Stories:
As a user, I can input my colonoscopy appointment date. COMPLETED
As a user, I can edit my appointment date and time. COMPLETED
As a user, I can add my appointment date to my phone calendar. COMPLETED
As a user I can get directions to my procedure location via the map app. COMPLETED
As a user I can use the menu on the bottom to navigate through the different pages. COMPLETED
As a user, I can look at what I need to do for each of the 5 days prior to my colonoscopy procedure.
COMPLETED As a user, I can get a notification for what I need to do that day, everyday from 5 days
prior to my colonoscopy until the day of my appointment. COMPLETED
As a user I can look at a list of dietary rules that I must follow. COMPLETED
As a user, I can input my current medications and other patient information (i.e.: medical diagnoses) and be given a warning if anything will conflict with the procedure or if I need to contact my doctor for anything.
COMPLETED As a user, I can view a FAQs page regarding the procedure.
COMPLETED As a user, I can view and utilize a checklist of things I need to do for the day
COMPLETED
19
Prototyping Code Link https://bitbucket.org/huangkc2/bowelpreparationapp Appendices Xcode (Programming language: Swift) IDE to create the app. ArgoUML Used to create system architecture overview/diagrams iPhone 4/5/6 Sketch Used to generate the wireframe of the app