Table of Contents -...

High Level DesignVersion 2.2

App Team

Tyler Bartnick

Duong Doan

Andrew Reichard

Ryen Shearn

Peter Shively

Phillip Yoder

CSC 354

Dr. Tan

High Level Design December 7, 2018

Table of ContentsTable of Contents......................................................................................................................................... i

REVISION HISTORY....................................................................................................................................... ii

1.0 INTRODUCTION.....................................................................................................................................1

1.2 What is a System Sequence Diagram?...............................................................................................1

1.3 Explanatory Material: Acronyms & References.................................................................................1

2.0 SYSTEM ARCHITECTURE DESIGN............................................................................................................3

3.0 UML NOTATION.....................................................................................................................................4

4.0 SYSTEM SEQUENCE DIAGRAMS.............................................................................................................5

4.1 View Announcements........................................................................................................................5

4.2 View Announcements........................................................................................................................5

4.3 View Daily Status Record...................................................................................................................7

4.4 Enter AI Status...................................................................................................................................7

4.5 Enter Vital Status...............................................................................................................................8

4.6 Input and Submit Feedback.............................................................................................................10

i


REVISION HISTORYTable 1 is the up-to-date revision history chart. As changes to this document are made, the chart will be edited to include it.

Version Date Description Editor

1.0 11/14/2018 Added:

1.0 Introduction

1.1 Purpose of Document

1.2 What is a System Sequence Design?

1.3 Explanatory Material: Acronyms and References

4.1 View Announcement

Phillip Yoder

1.1 11/15/2018 Added:

3.0 UML Notation

4.3 View Daily Record Status

Andrew Reichard

11/15/2018 Added:

4.2 View Task Instructions

Peter Shively

1.2 11/16/2018 Added:

4.4 Enter AI Status

Duong Doan

11/16/2018 Added:

2.0 System Architecture Design

Peter Shively

11/16/2018 Added:

4.5 Enter Vital Status Record

Revised:

1.0 Introduction

Ryen Shearn

ii



2.0 System Architecture Design

3.0 UML Notation

4.0 System Sequence Diagrams

2.0 12/2/2018 Added:

4.6 Input and Submit Feedback

Tyler Bartnick

12/2/2018 Modified:

4.4s Enter AI Status

Duong Doan

2.1 12/5/2018 Revised:

3.0 UML Notation

4.3 View Daily Status Record

Andrew Reichard

2.2 12/6/2018 Added:4.0 System Sequence Diagram Revised:4.1 View AnnouncementsDiagram 4.1 View Announcements

Phillip Yoder

12/6/2018 Revised:

1.2 What is a System Sequence Diagram

1.3 Explanatory Material: Acronyms and References

4.2 View Task Instructions

Peter Shively

12/7/2018 Modified:

4.4 Enter AI Status

4.5 Enter Vital Status

Ryen Shearn

iii



Table 1: Revision History

iv


1.0 INTRODUCTIONThe High-Level Design (HLD) document provides a high-level overview of the Long Term Care – Task Management System (LTC-TMS). This document includes System Sequence Diagram (SSD) diagrams that illustrate how users interact with the system.


The HLD explains a selected system architectural design for the LTC-TMS (Long Term Care – Task Management System). This HLD uses UML notation and SSDs to detail how the LTC-TMS will be designed. There are two important and related documents, the Software Requirement Specification (SRS) and Software Project Plan (SPP), that elaborate why specific system architectural designs were selected.

1.2 What is a System Sequence Diagram?System Sequence Diagrams are pictorial representations of use cases that are made from the requirements gathered from the clients. The System Sequence Diagrams use the Unified Modeling Language (UML) standard. The System Sequence Diagrams usually focus on the conversation between the actor and system in sequential order. The system is treated in a black box scenario so that it can teach a high-level understanding of how the user will interact with it.

1.3 Explanatory Material: Acronyms & References

Below is a list of acronyms and terms used within this document:

CNA – Certified Nursing Assistant is one of the staff members who will have direct contact with the patients. CNO – The Chief Nursing Officer is a staff member in more of an administrative role at the health facility. LTC – Long Term Care specifies the type of facility where the product will be deployed. TMS – Task Management System is the component of the product that will assist patients in performing daily tasks. MCU – Ming Chuan University is the partner school developing the product alongside the students at Kutztown University. KU – Kutztown University is the partner school developing the product alongside the students at Ming Chuan University. HLD – High-Level Design, pictorial descriptions of the relation between various modules

and functions of the system SRS – Software Requirements Specifications is this document that describes how the LTC –TMS functions with detailed information on how it functions.

v


SPP – Software Project Plan, defines the technical and managerial processes necessary to deliver the project requirements

UML – Unified Modeling Language, a standardized modeling language consisting of an integrated set of diagrams

SSD – System Sequence Design, a sequence diagram that shows, for a particular scenario of a use case

Firebase – a mobile and web application development platform

Android – a mobile operating system developed by Google iOS – a mobile operating system developed by Apple, exclusively for Apple hardware Raspberry Pi – a credit card-sized computer that has General Purpose Input Output pins

vi


2.0 SYSTEM ARCHITECTURE DESIGNFigure 2-1 represents the system architecture of the LTC-TMS. All data is hosted in the Google Firebase platform. Firebase not only provides a platform for the NoSQL database, but also for the web application utilized by the CNO and Director to manage the system. Because of the nature of Firebase being remotely hosted, all devices will communicate with Firebase via the Internet. The web application is primarily intended for use by the CNO and Director to perform administrative tasks. Android and iOS phones and tablets are the primary devices of the CNA and family. They primarily are used to retrieve task and health data from Firebase. The Raspberry Pi is used to send health and location metrics to Firebase. The data the Raspberry Pi sends is from a Microbit embedded system worn by the patient.

Figure 2-1: System Architecture Design

vii


viii


3.0 UML NOTATIONTable 3 illustrates and describes the notation used in the System Sequence Diagrams in Section 4.0. The left column shows the visual symbols used and the right column is a detailed description of each symbol.

Symbol Description

Actor

This symbol is a representation of a stick figure (actor). The stick figure represents the user or an entity of the system.

The symbol is a rectangular box with the word “:system” inside it. This represents the Long Term Care – Task Management System.

The symbol on the left is a vertical dotted line that extends from the bottom of the actor and system. This represents the lifeline of the object.

Message (Parameter(s)) The symbol on the left is a solid arrow pointing right with the message on top with potential parameters. This line originates from the actor and ends at the system box.

ResponseThis symbol on the left is a dotted arrow pointing left with the response underneath. This line originates from the system box and ends at the actor.

The symbol on the left is a note that further explains a message or response. It is used to help the reader easily understand what is happening in the diagram via comment or background knowledge.

The symbol on the left is a looping notation. The top left corner identifies it as a loop. The box encompasses the vertical dotted lines as well as the messages and/or responses.

*[condition]returnValue

:=parameter

The symbol on the left is also a looping notation. This only works if the given condition is true.

Table 3: UML Notation Guideix


4.0 SYSTEM SEQUENCE DIAGRAMS A System Sequence Diagram describes a use case scenario with event triggers. The diagram used to show the actors interaction with the system, whatever that system may be. It also gives context for what order the actions go in and which ones are repeated in the use case.

4.1 View AnnouncementsBelow is an illustration on how a CNA or family member checks the announcements on the LTC-TMS app. After successfully logging in, the announcements are displayed on the first screen seen after logging in. This display is a list of all the announcements in chronological order. The user can select an announcement to read, close, select another announcement, or go to a different page.

Diagram 4-1 Checking Announcements Scenario

x


4.2 View AnnouncementsScenario 4-2 is a System Sequence Diagram that shows how a CNA will access task instructions using the LTC-TMS app. The diagram assumes the user is logged into their account already.

Scenario 4-2: View Task Instructions Scenario

xi


4.3 View Daily Status RecordBelow, Scenario 4-3 is an illustration of how a CNA or family member views the Daily Status Record page in the LTC-TMS. After logging in, the user will select the “Daily Status Record” from the home page. The system will then display the Daily Status Record page by date. The user can select a specific daily status record and the system will display the information associated with that. Once done, the user may click on the “Back” button and return to the Daily Status Record page. If the user selects any other button, it will bring them to the page they selected.

Scenario 4-3: View Daily Record Status

xii


4.4 Enter AI StatusThe job of the CNA is to measure the AI Status of the patient such as heart rate, step count, etc. CNA must record and submit these measurements to the database. CNA must log in to the application and navigate to the room page, select room number then select patient. Next, CNA can record these measurements. Lastly, CNA double check and submit it. Scenario 4-4 gives more detail on the process.

Scenario 4-4: Enter AI Status

xiii


4.5 Enter Vital StatusDiagram 4-5 illustrates how the CNA enters the patient’s vital status information, which includes heart rate and temperature, with the tablet LTC-TMS app. This information is recorded on the tablet app and all saved data is automatically sent to the Raspberry Pi, then to the database. Once the information is received, this information is viewable by the family, other CNAs, CNO, and Director. This information is also used to calculate the patient’s AI status.

xiv


Diagram 4-5: Enter Vital Status Record

xv



Diagram 4-6 illustrates how both CNAs and family members input and submit user feedback. This information is valuable to any customer service-oriented business and will allow LTC facility management with insight into how they can better care for their patients, as well as how they can look to improve the apps. The data is input and then promptly submitted to the database, where it is then saved for further review at a later date.

Diagram 4-6: Input and Submit Feedback

xvi

Table of Contents -...

Documents

Transcript of Table of Contents -...