User Guide

• Symbols
• Installation Guide
  • System Requirements
  • Installation
• Quick start
• Features
• Creating Patient Info
  • Adding a patient: add
  • Editing a patient: edit
  • Deleting a patient: delete
  • Creating past appointment for patient: appt
  • Deleting past appointment for patient: delappt
  • Consulting a patient: consult
• Retrieving Patient Info
  • Listing all patients: list
  • Locating patients: get
    • by name: /n
    • next-of-kin data: /nok
    • by hospital wing: /hw
    • by floor number: /fn
    • by ward number: /wn
    • by long term medication: /m
    • by patient type: /inp
    • by patient type: /outp
    • by appointments: /appt
    • by appointment date: /appton
  • Obtaining total patient count: count
• General Commands
  • Viewing a Patient: view
  • Clearing all data : clear
  • Opening the Help Page : help
  • Exiting the program : exit
  • Saving the data
  • Editing the data file
  • Mouse Interactions
    • Patient List Panel
    • Patient Details Panel
  • Keyboard Shortcuts
• FAQ
• Command summary
• Troubleshooting
  • Checking your system’s Java version
• Glossary

Symbols

Symbol	Meaning
	Tips that may be useful to know. This symbol is followed by a label ‘Tip’.
	Information that may be useful to know. This symbol is followed by a label ‘Note’.
	Crucial information you need to know before using the command. This symbol is followed by a label ‘Caution’.
+	Required field.
-	Optional field.
*	Multiple inputs are allowed.

_{^{back to top}}

checkUp is the perfect desktop app for healthcare establishments. If you are a healthcare worker looking for an app to better manage your patients details then look no further! checkUp can boost your productivity with features to quickly retrieve patients details without the need of internet connection. Beyond that, checkUp also has features to help you manage your inventory so that you know when to restock certain medication!

checkUp is available for the Windows, macOS and Linux operating systems. To get started, simply head over to the Installation Guide. This user guide can also serve as a reference for experienced users, with a convenient Command Summary.

Installation Guide

System Requirements

Here is everything you need to install and set up checkUp. For the best possible experience, we recommend that you use checkUp on the following supported operating systems:

• Windows
• macOS
• Linux

You will also require Java 11 or above to run checkUp. If you don’t already have Java 11 or above on your system, head over to Oracle’s Java download page. To tell if you already have the correct version of Java installed on your system, refer to checking your system’s Java version.

Installation

1. Download the latest checkUp.jar from here.

2. Copy the file to the folder you want to use as the home folder for your checkUp app.

3. Double-click the file to start the app.

4. The user interface similar to the one below will appear in a few seconds. Note how the app contains some sample data.

_{^{back to top}}

Quick start

1. Type your desired command into the command input field and press <Enter> to execute it. e.g. typing help and pressing <Enter> will open the help window.
   Some example commands you can try:

   • add n/Amy Toh p/98765432 e/johnd@example.com nok/Jane Doe, Wife, 82858285 pt/inpatient hw/south fn/3 wn/D690 m/panadol m/ibuprofen : Adds a patient named Amy Toh to checkUp.

   • delete 3 : Deletes the 3rd patient shown in the current patient list panel.

   • get /n Alex: Retrieve patient’s information based on the prefix you provided. In this case, patients with the name Alex will be displayed.

   • view 1 : Views the 1st patient shown in the current patient list panel by displaying it on the patient details panel.

2. You can refer to the Features section for details of each command.
3. When you come across an unfamiliar term used, refer to the Glossary section.

^{_{back to top}}

Features

This section guides you on how to use features available in checkUp.

Do take some time to read the following note to better understand how you can use this section!

The features of CheckUp can be split into 3 main categories:

• Creating Patient Info
• Retrieving Patient Info
• General Commands

_{^{back to top}}

Creating Patient Info

The commands in this segment are focused on creating, editing and removing data to and from the application. These commands are:

• Adding a patient
• Editing a patient
• Deleting a patient
• Creating an appointment
• Deleting an appointment
• Consulting a patient

Adding a patient: add

Adds a patient to checkUp.

Format: add {Prefix}/{Parameter}…​

The prefixes and their respective parameters are as follows:

Email Format

• Must follow the format username@domain.
• Username: Alphanumeric characters and +, _, ., - only.
• Domain: Consists of domain labels separated by - or .. Domain labels consist of alphanumeric characters only and each domain label must be present (i.e. johndoe@yahoo-.gmail is not allowed as the domain label after yahoo and before gmail is empty).
• Examples: john@checkup.com, john-doe@checkup.com, john.doe@checkup.com, john_doe@check-up.com.

Tip:
A patient can have any number of medications (including 0)!

Reasons for usage:

• You want to register a new patient to the hospital.
• You want to add the personal information of the patient such as their name and contact details (phone number and email) for record purposes.
• You want to add the personal information of a patient’s next-of-kin such as their next-of-kin’s name, relationship to the patient and contact number for record purposes.
• You want to add a patient’s type according to overnight stay or daytime visit (inpatient/outpatient).
• If the patient is an inpatient, you want to add the hospitalisation details (hospital wing, floor number and ward number) for record purposes.
• You want to add any upcoming appointments that a patient has.
• You want to add any long-term medication that a patient has been prescribed.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

If patient type is inpatient:
add n/John Doe p/98765432 e/johnd@example.com nok/Jane Doe, Wife, 82858285 pt/inpatient hw/south fn/3 wn/D690 m/panadol m/ibuprofen

If patient type is outpatient:
add n/John Doe p/98765432 e/johnd@example.com nok/Jane Doe, Wife, 82858285 pt/outpatient m/panadol m/ibuprofen

_{^{back to top, back to features, back to segment top}}

Editing a patient: edit

Edits the details of the patient specified by the index number used in the patient list panel.

Format: edit INDEX {Prefix}/{Parameter}...

The prefixes and their respective parameters are as follows:

Email Format

• Must follow the format username@domain.
• username: Alphanumeric characters and +, _, ., - only.
• domain: Consists of domain labels separated by - or .. Domain labels consist of alphanumeric characters only and each domain label must be present (i.e. johndoe@yahoo-.gmail is not allowed as the domain label after yahoo and before gmail is empty).
• Examples: john@checkup.com, john-doe@checkup.com, john.doe@checkup.com, john_doe@check-up.com.

Requirements:

• At least one of the optional fields must be provided.
• Existing values will be updated to the input values.
• To remove all patient’s medications, just type m/ without specifying any medication after it.
• To remove all upcoming appointments, just type ua/ without specifying any date after it.

Reasons for usage:

• You want to correct any typos when adding a patient’s details into checkUp.
• You want to edit the personal information of the patient such as their name and contact details (phone number and email).
• You want to edit the personal information of a patient’s next-of-kin as they want to pass the responsibility to another member of the family.
• A patient is discharged, and you want to change their patient type from inpatient to outpatient.
• If the patient is an inpatient, you want to edit the hospitalisation details as they are transferring wards.
• You want to edit any upcoming appointments that a patient has as they are unable to make it.
• A patient is on a new long-term medication for his new diagnosis, and you want to edit the long-term medication prescription of a patient.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

• edit 1 p/91234567 e/johndoe@example.com edits the phone number and email address of the 1st patient to be 91234567 and johndoe@example.com respectively.

• edit 2 n/Betsy Crower m/ edits the name of the 2nd patient to be Betsy Crower and clears all existing medication.

_{^{back to top, back to features, back to segment top}}

Deleting a patient: delete

Deletes the patient specified by the index number used in the patient list panel.

Format: delete INDEX

• The index must be a positive integer 1, 2, 3, …​

Reasons for usage:

• You want to remove any personal information or data of a patient in checkUp.
• You want to remove any erroneous information added into checkUp. e.g. You accidentally added an extra patient into checkUp and wish to remove it.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

• list followed by delete 2 deletes the 2nd patient in checkUp.

• get /n Betsy followed by delete 1 deletes the 1st patient displayed in the patient list panel after the get /n command.

_{^{back to top, back to features, back to segment top}}

Creating past appointment for patient: appt

Creates a past appointment for the patient specified by the index number used in the patient list panel.

Format: appt INDEX {Prefix}/{Parameter}...

The prefixes and their respective parameters are as follows:

Reasons for usage:

• You want to create a past appointment record for a patient.
• You want to record the diagnosis for a patient during a past appointment.
• You want to record the medication prescribed to a patient during a past appointment.
• You want to record the date of the past appointment.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

• get /n John displays John Doe at index 1 and John at index 2.
• Following this, appt 1 on/12-06-2022 diag/Common cold, viral flu m/Panadol m/Lozenges will create a past appointment for John Doe.

_{^{back to top, back to features, back to segment top}}

Deleting past appointment for patient: delappt

Deletes the most recent past appointment of the patient specified by the index number used in the patient list panel.

Format: delappt INDEX

• The index must be a positive integer, eg. 1, 2, 3…

Reasons for usage:

• You want to delete the most recent past appointment record for a patient.
• The most recent past appointment record is no longer relevant due to an inaccurate diagnosis or medication.
• The most recent past appointment data should be recorded under another patient.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

• get /n John displays John Doe at index 1 and John at index 2.
• Following this, delappt 1 will remove John Doe’s most recent past appointment.

_{^{back to top, back to features, back to segment top}}

Consulting a patient: consult

Adds the diagnostic report of a patient after the consultation.

Format: consult INDEX {Prefix}/{Parameter}...

The prefixes and their respective parameters are as follows:

Reasons for usage:

• You want to record the diagnosis for a patient during a consultation.
• You want to record the medication prescribed for a patient during a consultation.
• You want to record the date of the consultation.
• You want to indicate that a patient’s upcoming appointment today has been completed.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

Examples:

• Assume Alex Yeoh is currently the first displayed person.
• consult 1 diag/Migraine m/Panadol will create a past appointment for Alex Yeoh for the current date and also clear his upcoming appointment which was scheduled for the current date.

_{^{back to top, back to features, back to segment top}}

Retrieving Patient Info

The commands in this segment are focused on filtering, processing then retrieving patient information in meaningful ways. These commands are:

• Listing all patients
• Locating patients
• Counting all patients

Listing all patients: list

Lists all the patients in checkUp.

Format: list

Reasons for usage:

• You want to have a full list of all patients in checkUp before using one of the get commands.
• You want a clear view of all the patients in checkUp.

_{^{back to top, back to features, back to segment top}}

Locating patients: get

Finds patients based on the predicates and parameters you input.

Format: get /PREDICATE PARAMETER

The predicates you can use to get the patients by are as follows:

by name: /n

Finds patients whose names contain any of the given keywords.

Format: get /n NAME

• Number of patients in the filtered list will be displayed in the command result box.
• The search is case-insensitive. e.g. get /n hans matches get /n Hans.
• The order of the keywords does not matter. e.g. get /n Hans Bo matches get /n Bo Hans.
• Only full words will be matched e.g. get /n Han will not match get /n Hans.
• Patients with names that match at least one keyword will be displayed. e.g. get /n Hans Bo will display Hans Gruber and Bo Yang.

Reasons for usage:

• You want to view the long-term medication(s) a patient is taking.
• You want to view the appointments a patient has.
• You want to obtain the phone number of a patient to call them for their upcoming appointment.
• You want to obtain the hospitalisation details of a patient.
• You want to edit the patient’s details.
• You want to check if a patient is registered in your clinic.

Examples:

• get /n john displays john and John Doe.
• get /n alex david displays Alex Yeoh, David Li.

_{^{back to top, back to features, back to segment top}}

next-of-kin data: /nok

Finds next-of-kin data for patients matching the input PATIENT_NAME, and is hence similar to the get /n command.

Format: get /nok PATIENT_NAME

• Number of patients in the filtered list will be displayed in the command result box.
• The search is case-insensitive. e.g. get /nok hans matches get /nok Hans.
• The order of the keywords does not matter. e.g. get /nok Hans Bo matches get /nok Bo Hans.
• Patients with names that match at least one keyword will have their next-of-kin details displayed. e.g. get /nok Hans Bo will display Sarar, 12345678, Mom.

Reason for usage:

• You want to contact a patient’s next-of-kin to seek consent.

_{^{back to top, back to features, back to segment top}}

by hospital wing: /hw

Finds all the patients in that particular hospital wing.

Format: get /hw HOSPITAL_WING

• Number of patients in the filtered list will be displayed in the command result box.
• HOSPITAL_WING only allows the following values: South, North, West, East.
• The search is case-insensitive. e.g get /hw souTh matches get /hw South.
• Only fully input values will be used. e.g. get /hw South No matches get /hw south as No does not match South, North, West or East.
• get /hw south /hw north matches get /hw south north, which will return all the patients in the south and north wing.
• All the patients in that hospital wing will be displayed. e.g. get /hw SOUTH will display John Peter Mary.

Reasons for usage:

• You want to know how many patients are in a hospital wing for better resource allocation.
• You want a quick way to group patients according to hospital wing for zoning or isolation.
• You forgot a patient’s name and vaguely remember the hospital wing they are in, narrowing down your search.

_{^{back to top, back to features, back to segment top}}

by floor number: /fn

Finds all the patients in that particular floor number.

Format: get /fn FLOOR_NUMBER

• Number of patients in the filtered list will be displayed in the command result box.
• FLOOR_NUMBER only allows positive integers.
• All the patients in that floor number will be displayed. e.g. get /fn 2 will display John Peter Mary.
• Multiple FLOOR_NUMBER can be input. e.g. get /fn 1 3 will display all patients staying in the 1st and 3rd floor.

Reasons for usage:

• You want to know how many patients are on a particular floor for better resource allocation.
• You want a quick way to group patients according to floor number for zoning or isolation.
• You forgot a patient’s name and vaguely remember the floor number they are in, narrowing down your search.

_{^{back to top, back to features, back to segment top}}

by ward number: /wn

Finds all the patients in that particular ward number.

Format: get /wn WARD_NUMBER

• Number of patients in the filtered list will be displayed in the command result box.
• All the patients in that ward number will be displayed. e.g. get /wn D123 will display John Peter Mary.
• Multiple WARD_NUMBER can be input. e.g. get /wn D001 E301 will display all patients staying in the ward number D001 and E301.
• get /wn D123 /wn E133 matches get /wn D123 E133.

Reasons for usage:

• You want to know how many patients are in the ward you are in charge of.
• You want to know how many patients are in a particular ward for better resource allocation.
• You want a quick way to group patients according to ward number for zoning or isolation.
• You want to get familiar with the name of the list of patients you are in charge of for the day.

_{^{back to top, back to features, back to segment top}}

by long term medication: /m

Finds all the patients by the long term medication prescribed to them.

Format: get /m LONG_TERM_MEDICATION

• Number of patients in the filtered list will be displayed in the command result box.
• The search is case-insensitive. e.g. get /m paracetamol matches get /m Paracetamol.
• The order of the keywords does not matter. e.g. get /m Paracetamol Aspirin matches get /m Aspirin Paracetamol.
• Only full words will be matched e.g. get /m Paracet will not match get /m Paracetamol.
• Patients with long term medication that match at least one keyword will be displayed. e.g. get /m Paracetamol Aspirin will display John and Mary who are taking Paracetamol and Aspirin respectively.

Reasons for usage:

• You want to know how many patients are taking a particular long term medication for better resource allocation.
• You want to know how many of each long-term medication you have to administer to patients.
• You want to closely keep track of the size of a group of patients who are on a more serious medication.

_{^{back to top, back to features, back to segment top}}

by patient type: /inp

Finds all the inpatients in checkUp.

Format: get /inp

• Number of patients in the filtered list will be displayed in the command result box.

Reasons for usage:

• You want to track how many patients are staying in the hospital for better resource allocation.
• You want to split the patients into a list of inpatients and outpatients for zoning or isolation.

by patient type: /outp

Finds all the outpatients in checkUp.

Format: get /outp

• Number of patients in the filtered list will be displayed in the command result box.

Reason for usage:

• You want to check how many patients are only here for their appointment and not staying overnight.

_{^{back to top, back to features, back to segment top}}

by appointments: /appt

Finds all past appointments of a patient specified by the index number used in the patient list panel.

Format: get /appt INDEX

• The index must be a positive integer 1, 2, 3, …​

Example: get /appt 3 on a patient with 2 past appointments will display

Obtained Past Appointments of Patient:
On: 12 Jun 2022; Diagnosis: Common viral flu; Prescribed Medication: [lozenges][panadol].
On: 01 Jan 2001; Diagnosis: headache, medicine given for 3 days; Prescribed Medication: [ibuprofen]

in the command result box.

Reasons for usage:

• You want to check the history of past appointments of a patient.
• You want to check the previous diagnosis records of a patient in a past appointment.
• You want to know the previous medication prescriptions of a patient in a past appointment in order to administer the right medication for the current appointment.
• You want to track if the patient has been to the hospital on a particular date for record keeping.

_{^{back to top, back to features, back to segment top}}

by appointment date: /appton

Finds all the patients that have an appointment on a particular date.

Format: get /appton APPOINTMENT_DATE

• APPPOINTMENT_DATE must be in dd-MM-yyyy format.
• The appointment date refers to the date a patient has an appointment with the clinic or hospital.
• Filtering by appointment date applies for both past and upcoming appointments.
• Multiple APPOINTMENT_DATE can be input. e.g. get /appton 14-12-2020 15-12-2020 will display all patients having appointments on 14th December 2020 and 15th December 2020.
• All the patients having appointments on that date will be displayed. e.g. get /appton 12-12-2020 will display John Peter Mary.

Reasons for usage:

• You want to know how many patients have appointments on a particular date for better resource allocation.
• You want to contact the list of patients with an upcoming appointment to remind them of their appointment.
• You want to know the number of patients who have been to the hospital on a particular date for record keeping.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

_{^{back to top, back to features, back to segment top}}

Obtaining total patient count: count

Gets total number of patients. Also gets the total number of types of long-term medications prescribed to patients, and a breakdown of the number of patients taking each type of long-term medication.

Format: count

• The count will be a non-negative number (>= 0). e.g. count displays 452 when there are 452 patients noted within the hospital.
• If 32 of those patients are on long-term antidepressants, the count will also display antidepressants: 32.

Reasons for usage:

• You want to know if the hospital is currently oversubscribed.
• You want to keep track of the hospital’s medicine inventory.
• You want a breakdown of the number of patients taking each type of long-term medication for stock-taking.

_{^{back to top, back to features, back to segment top}}

General Commands

The commands in this segment are essential commands needed for the app to run correctly and quality of life commands to improve the user experience. These commands are:

• Viewing a patient
• Clearing all data
• Opening the help page
• Exiting the program
• Mouse interactions
• Keyboard shortcuts

Viewing a Patient: view

Displays the details of a patient specified by the index number from the patient list panel.

Format: view INDEX

• The index must be a positive integer 1, 2, 3, …​
• Details are displayed on the patient details panel.

Reason for usage:

• You want to view all of a patient’s information in detail.

Notes about the view command :
On startup, the patient details panel will always default to the first patient if present.
It will also automatically focus onto the most recent patient added or edited.
When the current person displayed on the patient details panel is removed, it defaults to viewing the first patient in the patient list panel if present, and empty otherwise.

Upon Execution:

If the command was successfully executed, you should see something similar to the image below in the Command Result Box:

If not, please follow the error message given and format above to enter the correct command.

_{^{back to top, back to features, back to segment top}}

Clearing all data : clear

Empties checkUp of all patients stored.

Format: clear

• All patients will be removed from storage.
• This command is nuclear, and cannot be reversed. It should only be executed when absolutely necessary.
• This command is provided for privacy reasons, or to start afresh.

Reasons for usage:

• You want to reset the app completely.
• You want to clear all patient data from your application.

Opening the Help Page : help

Opens the Help Window, which allows you to copy the link to the User Guide to your clipboard.

Format: help

Reason for usage:

• You are unsure of the commands available and want to access the User Guide.

Exiting the program : exit

Exits checkUp.

Format: exit

• User interface settings (window height and width) are preserved during this process.

Reason for usage:

• After you have completed your tasks using the app, you want to close the program.

_{^{back to top, back to features, back to segment top}}

Saving the data

checkUp has been created in such a manner that you do not need to manually save data. Simply executing commands saves any data created or deleted from the application.

Editing the data file

• checkUp stores data in the JSON format, improving readability and allowing for manually editing the data file.
• The data file can be found in data/checkup.json in the home folder where checkUp’s jar file is stored.
• Care needs to be taken to follow data storage formats properly, or else the application will reject the data file.
  • Rejected data files will be replaced with a new, empty data file when saving data.

Mouse Interactions

Although CheckUp is built as a Command Line Interface application, it also supports the following mouse interactions:

Patient List Panel

• Double-clicking on patients in the Patient List Panel will automatically open their info in the Patient Details Panel.

Reason for usage:

• You want to quickly view all of a patient’s information in detail without having to enter a command.

Example:

• Double-clicking on the first patient Alex Yeoh will display his details on the Patient Details Panel.

Patient Details Panel

• Double-clicking on the fields in the Patient Details Panel will automatically prepare them for editing in the Command Input Box.

Reason for usage:

• You want to quickly edit a single field in the patient’s details.

Example:

• If the patient is Alex Yeoh, double-clicking on his email will set the text in the Command Input Box to edit 1 e/.

Keyboard Shortcuts

Similar to other Command Line Interface applications, CheckUp supports a few keyboard shortcuts:

• Navigate past commands with the UP and DOWN arrow keys.
• Clear the text currently in the command box with Ctrl + Shift + C.

Reasons for usage:

• You want to quickly access a previously entered command without having to retype it.
• You want to quickly clear the input line of a long command without having to manually delete it.

_{^{back to top, back to features, back to segment top}}

FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous checkUp home folder.

Command summary

_{^{back to top}}

Troubleshooting

Checking your system’s Java version

This section covers the technical issues you may run into while using checkUp.

Checking your system’s Java version

To check that your system has the correct Java version (Java 11 and above) to run checkUp, you can follow the steps below:

Open your terminal.

• Windows
  • Use Win + S to open search.
  • Type in Terminal to open the terminal.
  • In your terminal, type in java --version and click enter.
• macOS
  • Use Cmd + Space to open Spotlight search.
  • Type in Terminal to open the terminal.
  • In your terminal, type in java --version and click enter.
• Linux
  • Use Ctrl + Alt + T to open the Terminal.
  • In your terminal, type in java --version and click enter.
    

The following image shows an example what will show up in Windows, but you can expect a similar result in other operating systems.

The number in the red highlight rectangle tells you the Java version installed. For example, the Java version installed on the example system is Java 11.0.9, which is sufficient to run checkUp as it is greater than Java 11.

If you do not see a similar result in the terminal after Step 3, or have an earlier version of Java, head over to Oracle’s Java download page to install Java.

_{^{back to top}}

Glossary

_{^{back to top}}