HealthBase - User Guide

By: Team W14-3 Since: September 2018 Licence: MIT

1. Introduction
2. Quick Start
3. Features
4. FAQ
5. Command Summary

1. Introduction

HealthBase is for hospital administrators, doctors, nurses, and pharmacists who prefer to use a desktop app to manage patients and their associated data. More importantly, HealthBase is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, HealthBase can get your hospital management tasks done faster than traditional GUI apps.

2. Quick Start

Ensure that your computer has Java version 9 or later installed.
Download the latest release of our application, healthbase.jar here.
Copy the file to the folder you want to use as the home folder for your HealthBase.
Double-click the file to start the app. The Graphical User Interface (GUI) should appear in a few seconds.

Figure 1. The GUI of HealthBase
Type the command in the command box and press Enter to execute it.
e.g. typing help and pressing Enter will open the help window. (The command box is shown in Fig. 1 above; it is the gray box with the words "Enter your commands here…" inside.)

Some example commands you can try:

exit : exits the app
select 1 : selects the first patient (Alex Yeoh in the image above) in the list of patients.

Refer to Section 3, “Features” for the details of each command.

3. Features

Command Format

Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.
Items in square brackets are optional e.g n/NAME [da/DRUG ALLERGY] can be used as da/aspirin da/insulin or as n/John Doe.
Items with … after them can be used multiple times including zero times e.g. [da/DRUG ALLERGY]… can be used as (i.e. 0 times), da/aspirin, da/aspirin da/insulin etc.
Parameters can be in any order e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

Features are sorted by their command word in lexicographical order.

3.1. Add appointment for patient: `addappt`

Add a scheduled appointment for a patient.

Format: addappt ic/NRIC type/TYPE pn/PROCEDURE_NAME dt/DD-MM-YYYY HH:MM doc/DOCTOR-IN-CHARGE

The only valid types are PROP (PROPAEDEUTIC), DIAG (DIAGNOSTIC), THP (THERAPEUTIC), SRG (SURGICAL). Other inputs are not allowed.

It is useful to note that HealthBase does not permit appointments of duplicate date and time for any one patient. This is to prevent appointment clashes.

The HealthBase System assumes that there are 31 days for all months. For the inputs of the dates 31 and 29 (for February), it is the onus of the user to ensure that the input month has 31 days (for months except February) and 29 days for February in a leap year.

Example(s):

addappt ic/S1234567A type/SRG pn/Heart Bypass dt/27-04-2019 10:30 doc/Dr. Pepper

Type the example command into the input box as shown in the figure below and hit the Enter key:

Figure 2. Adding an appointment for patient

The resulting output will be as shown in the figure below:

Figure 3. Appointment has been added

If you want to view the newly added appointments for a particular patient, simply enter view appt. You may have to enter select <patient index> or click on the patient panel card. To use the full capabilities of the view command, click here.

3.2. Add patient’s dietary needs: `adddiet`

Add a patient’s dietary requirements into the system.

Format: adddiet ic/NRIC alg/ALLERGY1 alg/ALLERGY2 cr/CULTURAL_REQUIREMENT pd/PHYSICAL_DIFFICULTY

There are three types of dietary requirements, which can be added to a patient with their own prefixes:

Type of dietary requirement

Prefix

Usage Example

Allergy

alg

alg/Egg

Cultural Requirement

cr

cr/Halal

Physical Difficulty

pd

pd/Hands cannot move

The number of dietary requirements in an adddiet command must adhere to the following rules:

All three types are optional to be included, but there must be at least one dietary requirement in the command.
For each type, more than one requirements can be specified in the command.

The following inputs are considered as invalid when entering a dietary requirement:

Input with non-alphabetical characters. Eg. alg/1Egg
Input with only empty whitespaces or blank input. Eg. cr/ pd/

Adding two same dietary requirements to a patient will only result in one copy of the requirements being saved to the patient.

Example(s):

adddiet ic/S1234567A alg/Egg alg/Crab cr/Halal pd/Hands cannot move
adddiet ic/S1234567A cr/Vegetarian

Result of executing the first example command above:

Figure 4. Adding dietary requirements for a patient

3.3. Add patient medication: `addmeds`

Add to a patient’s medication history.

Format: addmeds ic/NRIC d/DRUG_NAME q/QUANTITY_PER_DOSE u/DOSAGE_UNIT n/DOSES_PER_DAY t/DURATION_IN_DAYS

Example(s):

addmeds ic/S1234567A d/Paracetamol q/2 u/tablets n/4 t/14

3.4. Add to patient’s medical history: `addmh`

Add a non-blank diagnosis entry with the name of the doctor-in-charge to an existing patient’s medical history. The patient must be registered within the system and the doctor’s name should contain his title which is followed by his full name. For all words in the doctor’s name, the starting letter must be capitalised.

Format: addmh ic/NRIC mh/DIAGNOSIS doc/DOCTOR-IN-CHARGE

Example(s):

addmh ic/S1234567A mh/Patient shows symptoms of flu. Prescribed 2 weeks of panadol, advised patient to rest and rehydrate. doc/Dr. Zhang De
addmh ic/T9876543Z mh/Patient appears to have chronic cough. Referred to specialist. doc/Dr.Timothy

To try out the addmh command:

Type out a valid addmh command which follows the stated format into the command box. Such an example can be seen in the figure below.
Submit the input into HealthBase by pressing Enter. The result display panel will show a successful addmh command message, and should show the further figure below.

Figure 5. Command box and result display panel before entering an addmh command.

Figure 6. Command box and result display panel after entering the valid addmh command.

The following invalid inputs will result in a command failure, and the display of an appropriate error message.

Invalid NRIC
- The patient NRIC does not match to an existing patient in the system. The person will first need to be registered.
Incorrect format of the doctor’s name.
- Doctor’s title must be included.
- The first letter of all words in doctor’s name must be captalised.
Blank diagnosis
- An empty diagnosis will not be accepted as a valid diagnosis.
Missing prefixes
- Not all the prefixes in the stated command format have been included.

If you want to view the newly added diagnoses to a particular patient, simply enter view mh. You may have to enter select <patient index>` or click on the patient panel card. To use the full capabilities of the view command, click here.

3.5. Check in a returning patient: `checkin`

Check in a returning patient back to the HealthBase system, and retrieve his/her information from backend and display them in the left panel of the application window. The patient being checked in must have been previously registered to the system and were checked out of the system sometime before by using the checkout command.

Format: checkin ic/NRIC

If there is no record of this patient in our system (which means that the patient with the specified NRIC has not visited the hospital and not been registered in the system, the application will direct the user to use the register command to register this new patient with his/her necessary information.

If the patient with the specified NRIC is still active in the system (which means that the patient in the system has not been checked out yet), the command is considered as invalid.
The checkin command is only considered valid when the patient with the NRIC specified were checked out before by using the checkout command.

Example(s):

checkin ic/S1234567A
Note that the patient with NRIC S1234567A must have been previously registered to the system and were checked out of the system sometime before by using the checkout command.

3.6. Check out a patient: `checkout`

Check out a patient from the HealthBase system, while still keeping the information of the patient at the backend. Upon checking out a particular patient, this patient will not be displayed in the left panel of the application.

Format: checkout ic/NRIC

If the NRIC does not match that of any checked in patient in the system, an error message will be displayed.

After a patient has been checked out from the system, all commands with the NRIC of this patient as parameter (except the checkin command) will be considered as invalid commands.

Example(s):

checkout ic/S1234567A

3.7. View help : `help`

Open this page.

Format: help

3.8. Register a new patient to the system: `register`

Format: register ic/NRIC n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS da/DRUG_ALLERGIES

If the patient is already registered, the command will not be allowed.

The prefix da/ must be separated from the last input by a whitespace

Example(s):

register ic/S1234567A n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 da/aspirin da/insulin

Type the example command into the input box as shown in the figure below and hit the Enter key:

Figure 7. Registering a new patient

The resulting output will be as shown in the figure below:

Figure 8. Patient has been registered

3.9. Sort user view : `sort`

Sort the current view, if it is sortable.

Format: sort SORT_TYPE SORT_ORDER

SORT_TYPE refers to the order in which the sorting should be done (ascending, descending). It can be either 'a' for ascending, or 'd' for descending.

SORT_ORDER refers to the order in which the sorting should be done. How this affects the sorting exactly depends on each view, and will be explained in greater detail below.

View Name

Sortable?

What SORT_ORDER refers to

Default

Apppointment

Yes

The columns of the table in the view, one-indexed.

Diet

Medication

Yes

The columns of the table in the view, one-indexed.

Medical History

Yes

The columns of the table in the view, one-indexed.

Example(s):

sort a 123 where the current view is Medication
- Sorts the table in the medication view by the first column (Drug Name). Any entries with the same drug name will be further sorted by the second column (Dosage), with any entries with the same drug name and dosage being further sorted by the third column (Dosage Unit).
sort a 1 where the current view is the default view (blank view).
- Does nothing (the current view is not sortable).

3.10. Select patient: `select`

Select a patient through pure command-line functionality. The alternative is to click on the patient’s card.

Format: select INDEX

where INDEX refers to the index of the patient’s card (listed in the card)

Figure 9. Indication of the location of the index on the patient’s card

Example(s):

select 1

3.11. View patient’s information: `view`

View a selected patient’s information in the panel on the right. Exactly what information is displayed depends on the choice of view.

Selected here refers to the use of the select command. To view the information of a given patient, he must first be select ed.

Format: view VIEW_NAME

Current choices for views include:

default (This is the default blank view, which is displayed when the application is started)
appt (Appointment view, contains patient’s appointments)
diets (Diet view, contains patient’s dietary requirements)
meds (Medication view, contains information about the patient’s medications)
mh (Medical history view, contains patient’s previous medical diagnoses)
visitors (Visitor list view, contains patient’s visitors' names)

This command switches the user’s view (right panel of the UI, indicated in the figure directly below) to a chosen view.

Figure 10. Indication of the location of the user view

Example(s):

view default

Figure 11. Default view

view appt

Figure 12. Appointment view

view diets

Figure 13. Diet view

view meds

Figure 14. Medication view

view mh

Figure 15. Medical history view

When a user clears all the stored entries with the clear command, the view panels of the last selected person (if any) are still accessible via the view command.

For example, the following view commands will function fine for the last selected person.
- view default
- view meds
- view appt
- view mh
- view diet

view visitors