Professional Documents
Culture Documents
Software
Architecture and
Design Document
Template
For Documenting the Architectural and detailed Design of Graduating
Year Projects
Contents
1 INTRODUCTION...........................................................................................3
1.1 Purpose.........................................................................................................3
1.2 Scope........................................................................................................3
1.3 Overview..................................................................................................4
2. SYSTEM OVERVIEW..................................................................................5
3. SYSTEM ARCHITECTURE.........................................................................6
4 DATA DESIGN............................................................................................18
5 COMPONENT DESIGN..............................................................................23
7 REQUIREMENTS MATRIX.......................................................................37
1 INTRODUCTION
1.1 Purpose
The purpose of this software architectural and design document provides a
comprehensive architectural overview of the system, using a number of different
architectural views to depict different aspects of the system. It is intended to capture
and convey the significant architectural decisions which have been made on the
system.
The development team can use this document to review the architecture of the system.
The Architecture document will be also useful for future development. It identifies
the top-level system architecture, hardware, software, communication, and interface
components.
1.2 Scope
The aim of this project is to create mobile based patient appointment system.
System is providing communication between the patient and the doctor,
whereby a patient can register, login to the system, change his profile and
schedule appointment with doctor as per the doctor’s available, patient can
also interact with doctor through a message or email.
Doctors can also view his details, change his profile, view appointments and
set available time for appointment thereby making it more convenient for
them. Administrator also have access to the system and able to change
information of the system and have access to database.
1.3 Overview
The remaining sections of this document provide a general description include
characteristics of the users at this project, the product architecture and the functional
and data requirement of the product
General description of the project is discussed in section 2 of this document, section 3
gives the system architecture and Decomposition, description and Design Rationale
section 4 is for data design includes data description and data dictionary section is all
about component design and section 5 and 6 are Human Interface Design and
Requirements matrix respectively.
Acronyms/Abbreviatio Definition
n
PAA Patient Appointment Application
IEEE Institute of Electronics and Electrical
Engineering Standard
SRS Software Requirements Specification
Table 1: Definitions, Acronyms and Abbreviations
2. SYSTEM OVERVIEW
Even though the product, which is going to be, implemented (Patient Appointment
system) is a new product it can be used as enhancing solution for an existing system.
This system explained in this document is the first version. All the activity is done
from scratch: no prier version of the system is used for getting either functionality
being performed or specification defined.
Patient Appointment system is a new system that enhance the user of this system to
access adequate information about specified site he want to visit as well as posting his
status of view with their friends with internet connection using either mobile or
personal computer devices. Therefore, the user of this system is well satisfied since
the system is available for 7x24 hours in addition to since it does require internet
connection basically it relies on wide area networks.
3. SYSTEM ARCHITECTURE
The User of this system will have the following functionalities from the system as
described by the following class diagram which will be implemented in the system.
Functionalities that the system will provide
Diagram 1: logical view of patient Appointment System
3.1.3 Process view
In this view, we try to describe the flow of activities which are mainly can be done by
this system. The process view is one of the components from the 4+1 architectural
view which can be described and illustrated using activity diagram. PAS system’s
process view has been illustrated using activity diagram.
Diagram 2: process of patient Appointment System
Function Using this class, the admin of the system can able to add hospital, delete hospital,
add hospital manager and delete hospital manager to the system.
Subordinates This class has the following interface session and interface permeation
Dependencies This class is mainly depending on the database and the network connection.
Processing This class achieves the desired functionality through the following process
Deleting user from the system can be performed through deleteUser classes. So,
administrator of the system can able to delete unnecessary user from the system
by only filling username of the user after addUser class is launched
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
3.2.3 User
Identification Doctor, patient
Type Interface
Purpose The purpose of this Interface is to login and register for patient and doctor.
Function Using this class, the admin of the system can able to make call, receive call,
receive message and send message.
Subordinates This component has the following method
Add doctor
Delete doctor
Delete patient
Dependencies This component mainly depends on the database and also depends on account
manager in some extent. This component is used foremost component of this
system because unless they have an account on this system they can’t able to
operate the functionality of this system.
Interface This class has the following interface
Login
Logout
Forgot password
Resource Phone storage, firebase Database, Database Server, Local area network connection
Processing This component achieves the desired functionality through the following process
If user has no account on this system previously and they need to create their own
account on this system. First register User class will be launched then the user
should fill all the required filled to be registered successfully or to have a valid
account on the system.
Once they are successfully registered to the system they can access the system
using their username and password otherwise the system informs them please try
to fill all the required filled
If user forget their password, they do have a privilege to reset their password so
at this time reset class will be launched to perform this task If user is interested to
change their password the system provides a privilege to change their password
in a good way.
This component also achieves the desired functionality through the following
process Deleting user from the system can be performed through deleteUser
classes. So, administrator of the system can able to delete unnecessary user from
the system by only filling username of the user after DeactivateUser class is
launched.
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
3.2.4 Hospital
Identification Hospital
Type Class
Purpose The purpose of this class is to add doctor, delete doctor, update only data of his
hospital
Function Using this class, the admin of the system can able to add doctor, delete doctor,
update hospital information and delete patient of his hospital
Subordinates This class has the following interface session and interface permeation
Dependencies This component mainly depends on the database and also depends on account
manager in some extent. This component is used foremost component of this
system because unless they have an account on this system they can’t able to
operate the functionality of this system.
Interface This class has the following interface
Login
Logout
Forgot password
Resource Phone storage, firebase Database, Database Server, Local area network connection
Processing This component achieves the desired functionality through the following process
If user has no account on this system previously and they need to create their own
account on this system. First register User class will be launched then the user
should fill all the required filled to be registered successfully or to have a valid
account on the system.
Once they are successfully registered to the system they can access the system
using their username and password otherwise the system informs them please try
to fill all the required filled
If user forget their password, they do have a privilege to reset their password so
at this time reset class will be launched to perform this task If user is interested to
change their password the system provides a privilege to change their password
in a good way so at this time Change Password method will be launched
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
3.2.5 Appointment
Identification Appointment
Type Class
Purpose The purpose of this class is to book appointment for doctor
Function Using this class, the admin of the system can able to send command and receive
commend
Subordinates This component has the following classes
Send commend
Receive command
Dependencies This component mainly depends on the database and also depends on account
manager in some extent. This component is used foremost component of this
system because unless they have an account on this system they can’t able to
operate the functionality of this system.
Interface This class has the following interface
Responsibility
Resource Phone storage, firebase Database, Database Server, Local area network connection
Processing This component achieves the desired functionality through the following process
If doctor attach his free time, then the patient depending on free times send
appointment to doctor.
If schedule comfort to doctors, then confirm appointment.
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
3.2.6 Remainder
Identification Remainder
Type Class
Purpose The purpose of this class is to remind doctor and patient their appointment by
making alert or alarm depending on confirmation of appointment
Function Using this class, the admin of the system can able to send command and receive
commend
Subordinates This component has the following classes
Send commend
Receive command
Dependencies This component mainly depends on the database and also depends on account
manager in some extent. This component is used foremost component of this
system because unless they have an account on this system they can’t able to
operate the functionality of this system.
Interface This class has the following interface
Responsibility
Resource Phone storage, firebase Database, Database Server, Local area network connection
Processing This component achieves the desired functionality through the following process
If doctor attach his free time, then the patient depending on free times send
appointment to doctor.
If schedule comfort to doctors, then confirm appointment.
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
Function Using this class, the doctor of the system can able to send command and receive
commend
Subordinates This component has the following classes
Send commend
Receive command
Dependencies This component mainly depends on the database and also depends on account
manager in some extent. This component is used foremost component of this
system because unless they have an account on this system they can’t able to
operate the functionality of this system.
Interface This class has the following interface
Responsibility
Resource Phone storage, firebase Database, Database Server, Local area network connection
Processing This component achieves the desired functionality through the following process
Add doctor from the system can be performed through add method. So, doctor of
the system can able to delete unnecessary patient from the system by only filling
username of the user after add user method is launched
Data This class will fetch data from database and present it in plain text format.
And execute(delete) data from database that is requested by the admin
4 DATA DESIGN
In this section the data design description is presented as how data are
represented in this project and what type of data are used in this project.
Also, this section will discuss about available objects in the project with their
respective attributes.
We use third normal form to delete and handle any duplication of data from
the database
Diagram 5: Data design diagram
As described in the above PAS system has one databases namely PAS system
ADMIN table: used to store all information or attribute that are used for the
admin login in to the system
Doctor table: used to store the attribute of the Doctor and used for identify
itself to the system in order to performs tasks.
Patient: used to store the attribute of the patient and used for identify itself to
the system in order to performs tasks.
Appointment table: used to store information relate to appointment.
Hospital table used to store all information or attribute that are used in
hospital.
Time slot: used to store the attribute of the doctor and available time of doctor.
4.2 Data Dictionary
The properties of database entities which are mentioned in the above section
will be described more in this section
Entity ADMIN
Function This is used to store all information or attribute that are used for the admin login in to
the system
Entity Doctor
Function This is used to store the attribute of doctor and used for identify all information
Entity Appointment
Function This is used to store the attribute of book appointment between doctor and patient
5 COMPONENT DESIGN
5.1 Class Diagram of PAS
Diagram 6: Class diagram for PAS