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 or any later version published by the Free Software Foundation. Table of Contents Introduction ......................................................................................................................... 3 1.1 Purpose................................................................................................................ 3 1.2 Scope ................................................................................................................... 3 1.3 Definitions, Acronyms, and Abbreviations ........................................................ 3 1.4 References ........................................................................................................... 3 1.5 Overview . ........................................................................................................... 3 2 Architectural Description ............................................................................................ 4 2.1 Component Decomposition ................................................................................ 4 3 Interface Description ................................................................................................... 5 3.1 User interface ...................................................................................................... 5 3.2 Data Interface ...................................................................................................... 6 3.3 Programming Interface ....................................................................................... 6 4 Detailed Design ........................................................................................................... 6 4.1 Home 1 – Homepage .......................................................................................... 6 4.1.1 Type ............................................................................................................ 6 4.1.2 Purpose........................................................................................................ 7 4.2 View 1 – View/Edit/Delete Hospitals Page ........................................................ 7 4.2.1 Type ............................................................................................................ 7 4.2.2 Purpose........................................................................................................ 8 4.3 View 2 – View Specific Hospital Page ............................................................... 8 4.3.1 Type ............................................................................................................ 8 4.3.2 Purpose........................................................................................................ 9 4.4 Add 1 – Add Hospital Page ................................................................................ 9 4.4.1 Type ............................................................................................................ 9 4.4.2 Purpose...................................................................................................... 10 4.5 Add 2 – Confirmation Page .............................................................................. 10 4.5.1 Type .......................................................................................................... 10 4.5.2 Purpose...................................................................................................... 11 4.6 Edit 1 – Edit Specific Hospitals Page ............................................................... 11 4.6.1 Type .......................................................................................................... 11 4.6.2 Purpose...................................................................................................... 12 4.7 Edit 2 – Confirmation Page............................................................................... 12 4.7.1 Type .......................................................................................................... 12 4.7.2 Purpose...................................................................................................... 13 4.8 Delete 1 – Delete Specific Hospital Page ......................................................... 13 4.8.1 Type .......................................................................................................... 13 4.8.2 Purpose...................................................................................................... 14 4.9 Delete 2 – Delete Hospital Confirmation Page ................................................. 14 4.9.1 Type .......................................................................................................... 14 4.9.2 Purpose...................................................................................................... 15 2 Introduction The Sahana Hospital Management Module is a system that keeps track of available medical facilities in the area of the disaster. It will enable users to manage hospitals status and help locating hospitals in the area. 1.1 Purpose This document serves as a high-level description and detailed design for the Sahana Hospital Management Module. 1.2 Scope The Sahana Hospital Management Module is intended to support the management of hospitals in the disaster area including location and status. 1.3 Definitions, Acronyms, and Abbreviations Sahana: the Sahana Free Open Source Software for Disaster Recovery (www.sahana.lk) SHM: Sahana Hospital Management Module 1.4 References Sahana website: http://www.sahana.lk/ Trinity College Sahana Project: http://www.cs.trincoll.edu/sahana_proj/wiki/Main_Page 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. 3 2 Architectural Description The 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 in Camp Registry. CampRegistry Sahana Form Library Sahana SHM Volunteer Management Library Hospital Registry Library (owned) Sahana Database Database Library 2.1 Component Decomposition The 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 Name o Location o Number of beds o Hospital manager o Status 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. 4 3 Interface Description 3.1 User interface The module includes 10 pages as above. View Hospitals Page is reached by clicking View Hospital on the navigation menu 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 5 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 alteration to 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. shm_status stores all possible values for hospital status and is linked to the shm_hospital table by status_id. 3.3 Programming Interface The module does not provide any interfaces for other applications. 4 Detailed Design 4.1 Home 1 – Homepage 4.1.1 Type This is the screenshot of the homepage 6 4.1.2 Purpose This page introduces the SHM module. Users get to this page when clicking on the SHM module in the main menu. Users will be presented with the 5 most available hospitals. There are 2 options on the menu and 1 submenu: 1. Home 2. View Hospitals 3. Manage Hospitals a. Add Hospital b. View/Edit Hospitals 4.2 View 1 – View/Edit/Delete Hospitals Page 4.2.1 Type This is the screenshot of the view hospitals page 7 4.2.2 Purpose The user gets to this page when clicking on the View Hospitals menu button. They will be presented with a list of all possible hospitals with a link to View Specific Hospital page. 4.3 View 2 – View Specific Hospital Page 4.3.1 Type This is the screenshot of the view specific hospital page. 8 4.3.2 Purpose The user gets to this page when clicking on an individual hospital in View Hospitals page. This page will display the following information: 1. Name 2. Location 3. Number of beds 4. Hospital Manager 5. Status 4.4 Add 1 – Add Hospital Page 4.4.1 Type This is the screenshot of the add hospital page. 9 4.4.2 Purpose The administrator gets to this page when clicking on the Add Hospitals menu button. The administrator has to provide: 1. Name 2. Location 3. Hospital Manager 4. Number of beds 5. Status 4.5 Add 2 – Confirmation Page 4.5.1 Type This is the screenshot of the confirmation page displayed when a hospital is added. 10 4.5.2 Purpose The administrator gets to this page when the hospital is successfully added. 4.6 Edit 1 – Edit Specific Hospitals Page 4.6.1 Type This is the screenshot of the edit specific hospital page. 11 4.6.2 Purpose The 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. Name 2. Location 3. Number of beds 4. Hospital Manager 5. Status 4.7 Edit 2 – Confirmation Page 4.7.1 Type This is the screenshot of the confirmation page displayed when a hospital is edited. 12 4.7.2 Purpose The administrator gets to this page when the hospital is successfully edited. 4.8 Delete 1 – Delete Specific Hospital Page 4.8.1 Type This is the screenshot of the delete specific hospitals page. 13 4.8.2 Purpose The 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). 4.9 Delete 2 – Delete Hospital Confirmation Page 4.9.1 Type This is the screenshot of the confirmation page displayed when a hospital is deleted. 14 4.9.2 Purpose The administrator gets to this page when the hospital is successfully deleted. 15