Software Design Specification

For

Sahana Hospitals Management Module

Submitted by

Turner Hayes

Bach Vu Dao

Copyright (c) 2005, Gregory W. Hislop. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 orany later version published by the Free Software Foundation.

22

Table of ContentsIntroduction..............................................31.1 Purpose.............................................31.2 Scope...............................................31.3 Definitions, Acronyms, and Abbreviations............41.4 References..........................................41.5 Overview ...........................................4

2 Architectural Description..............................52.1 Component Decomposition.............................5

3 Interface Description..................................63.1 User interface......................................63.2 Data Interface......................................73.3 Programming Interface...............................7

4 Detailed Design........................................74.1 Home 1 – Homepage...................................74.1.1 Type............................................74.1.2 Purpose.........................................8

4.2 View 1 – View/Edit/Delete Hospitals Page............84.2.1 Type............................................84.2.2 Purpose.........................................9

4.3 View 2 – View Specific Hospital Page................94.3.1 Type............................................94.3.2 Purpose........................................10

4.4 Add 1 – Add Hospital Page..........................104.4.1 Type...........................................104.4.2 Purpose........................................11

4.5 Add 2 – Confirmation Page..........................114.5.1 Type...........................................114.5.2 Purpose........................................12

4.6 Edit 1 – Edit Specific Hospitals Page..............124.6.1 Type...........................................124.6.2 Purpose........................................13

4.7 Edit 2 – Confirmation Page.........................134.7.1 Type...........................................134.7.2 Purpose........................................14

4.8 Delete 1 – Delete Specific Hospital Page...........144.8.1 Type...........................................144.8.2 Purpose........................................15

33

4.9 Delete 2 – Delete Hospital Confirmation Page.......154.9.1 Type...........................................154.9.2 Purpose........................................16

IntroductionThe Sahana Hospital Management Module is a system that keepstrack of available medical facilities in the area of the disaster. It will enable users to manage hospitals status and help locating hospitals in the areainventory.

1.1 PurposeThis document serves as a high-level description and detailed design for the Sahana Hospital Management Module.

1.2 ScopeThe Sahana Hospital Management Module is intended to supportthe management of hospitals in the disaster area including location, staffing, supply management and statusinventory tracking.

1.3 Definitions, Acronyms, and AbbreviationsSahana: the Sahana Free Open Source Software for Disaster Recovery (www.sahana.lk)SHM: Sahana Hospital Management ModuleSahana - <Define this.> NGO : Non-government organization. Site manager: Person in charge of a project. .

1.4 ReferencesSahana website: http://www.sahana.lk/Trinity College Sahana Project: http://www.cs.trincoll.edu/sahana_proj/wiki/Main_Page

44

1.5 Overview

The remainder of the document contains an overall description of the module designs as well as the detailed designs for the main functionality of the module.

55

2 Architectural DescriptionThe Sahana Hospital Management Module is a module in the larger Sahana project. Users will access the module via the main Sahana interface as an independent module. The module will incorporate some features similar to those inof the Camp Registry and.

2.1 Component DecompositionThe module is composed of 4 components:

View Hospitals: this will allow users to view all hospitals in the database or they can specify to view hospitals in a certain area

Add Hospitals: this allows administrators to add a new hospital. The administrator has to provide:

o Nameo Locationo Number of bedso Hospital managero Status

6

Sahana

SHM

CampRegistry

Sahana Form Library

Volunteer Management LibrarySahana Database

Database Library

Hospital Registry Library (owned)

6

Edit Hospitals: this allows administrators to edit an existing hospital’s information (as mentioned above).

Delete Hospitals: this allows administrators to delete an existing hospital.

3 Interface Description3.1 User interface

The module includes 10 pages as above. View Hospitals Page is reached by clicking View Hospital

on the navigation menu

77

View Specific Hospital is reached by clicking a hospital name in a list of hospitals

Administrator Submenu is on the navigation menu and only accessible to admin.

View/Edit/Delete Hospitals Page is reached by clicking View/Edit Hospital in the Administrator Submenu

Add Specific Hospital Page is reached by clicking on Add Hospital on the Administrative Submenu

Edit Specific Hospital Page is reached by clicking on Edit button in the View/Edit/Delete Hospitals Page.

Delete Specific Hospital Page is reached by clicking on Delete button in the View/Edit/Delete Hospital Page.

Confirmation Pages are reached upon successful alterationto the database including add/edit/delete.

3.2 Data Interface

There are two tables in the SHM module database. shm_hospital stores information about each specific

hospital and is uniquely identified by a hospital_id.

88

shm_status stores all possible values for hospital status and is linked to the shm_hospital table by status_id.

3.3 Programming InterfaceThe module does not provide any interfaces for other applications.

4 Detailed Design4.1 Home 1 – Homepage

4.1.1 TypeThis is the screenshot of the homepage

99

4.1.2 PurposeThis page introduces the SHM module. Users get to this page when clicking on the SHM module in the main menu. Users willbe presented with the 5 most available hospitals. There are 2 options on the menu and 1 submenu:

1. Home2. View Hospitals3. Manage Hospitals

a. Add Hospitalb. View/Edit Hospitals

4.2 View 1 – View/Edit/Delete Hospitals Page

4.2.1 TypeThis is the screenshot of the view hospitals page

1010

4.2.2 PurposeThe user gets to this page when clicking on the View Hospitals menu button. They will be presented with a list ofall possible hospitals with a link to View Specific Hospitalpage.

4.3 View 2 – View Specific Hospital Page

4.3.1 TypeThis is the screenshot of the view specific hospital page.

1111

4.3.2 PurposeThe user gets to this page when clicking on an individual hospital in View Hospitals page. This page will display the following information:

1. Name2. Location3. Number of beds4. Hospital Manager5. Status

4.4 Add 1 – Add Hospital Page

4.4.1 TypeThis is the screenshot of the add hospital page.

1212

4.4.2 PurposeThe administrator gets to this page when clicking on the AddHospitals menu button. The administrator has to provide:

1. Name2. Location3. Hospital Manager4. Number of beds5. Status

4.5 Add 2 – Confirmation Page

4.5.1 TypeThis is the screenshot of the confirmation page displayed when a hospital is added.

1313

4.5.2 PurposeThe administrator gets to this page when the hospital is successfully added.

4.6 Edit 1 – Edit Specific Hospitals Page

4.6.1 TypeThis is the screenshot of the edit specific hospital page.

4.6.2 PurposeThe user gets to this page when clicking on an individual hospital in View/Edit/Delete Hospitals page. This page will display and allow users to edit the following information:

1. Name2. Location

1414

3. Number of beds4. Hospital Manager5. Status

4.7 Edit 2 – Confirmation Page

4.7.1 TypeThis is the screenshot of the confirmation page displayed when a hospital is edited.

4.7.2 PurposeThe administrator gets to this page when the hospital is successfully edited.

1515

4.8 Delete 1 – Delete Specific Hospital Page

4.8.1 TypeThis is the screenshot of the delete specific hospitals page.

4.8.2 PurposeThe administrator gets to this page when clicking on the Delete link in the View/Edit/Delete Hospitals page. User will be asked to confirm the deletion, and then will be taken to a confirmation page (see below).

1616

4.9 Delete 2 – Delete Hospital Confirmation Page

4.9.1 TypeThis is the screenshot of the confirmation page displayed when a hospital is deleted.

4.9.2 PurposeThe administrator gets to this page when the hospital is successfully deleted.

1717