User Guide

UniNurse is a desktop app tailored for you, a private duty nurse, to:

• Manage your patients’ contact details.
• Organize your patient-related tasks.
• Keep track of your patients’ medical conditions.

UniNurse offers the following features:

• Add and edit patient details such as name, contact number, medical conditions, etc.
• Find and filter patients by their details.
• Add tasks to a patient.
• Show the tasks to be done on a specific day.
• Categorize patients using tags.

Using this guide

This guide walks you through all the features of UniNurse, as well as tips, so you can reap all the benefits of UniNurse!

If you are a new user, this guide equips you with the necessary know-how to get started with UniNurse.

If you are an experienced user, you can refer to the Command Summary at the end of this guide.

Here are some symbols used throughout this user guide:

Symbol	Meaning
	Important things you should take note of
	Useful information
	Warning

Table of Contents

1. Using this guide
2. Table of Contents
3. Quick start
4. Glossary
5. Command format
6. Patient parameter constraints
   1. Single-valued attributes
   2. Multi-valued attributes
   3. Patient parameter summary
7. Features
   1. Getting help: help
   2. Modifying patient contact details
      1. Adding a patient: add
      2. Editing a patient’s contact details: edit -p
      3. Deleting a patient: delete -p
   3. Modifying tags
      1. Adding a tag: add -p
      2. Editing a tag: edit -p -t
      3. Deleting a tag: delete -p -t
   4. Modifying tasks
      1. Adding a task: add -p
      2. Editing a task: edit -p -d
      3. Deleting a task: delete -p -d
   5. Modifying medical conditions
      1. Adding a medical condition: add -p
      2. Editing a medical condition: edit -p -c
      3. Deleting a medical condition: delete -p -c
   6. Modifying medications
      1. Adding a medication: add -p
      2. Editing a medication: edit -p -m
      3. Deleting a medication: delete -p -m
   7. Modifying remarks
      1. Adding a remark: add -p
      2. Editing a remark: edit -p -r
      3. Deleting a remark: delete -p -r
   8. Viewing patients
      1. Listing all patients: list
      2. Viewing all details of a patient: focus -p
      3. Finding patients: find
   9. Viewing tasks
      1. Viewing all tasks for a particular day: view
      2. Viewing all tasks for today: view --today
      3. Viewing all tasks of a patient: view -p
      4. Viewing all tasks of all patients: view -p --all
   10. Undoing previous command: undo
   11. Reversing undo command: redo
   12. Clearing all entries: clear
   13. Exiting UniNurse: exit
   14. Saving the data
   15. Editing the data file
8. FAQ
9. Command summary

Quick start

1. Ensure you have Java 11 or above installed on your computer. To check your Java version, open a Command Prompt or Terminal window and type:

java -version

1. Download the latest uninurse.jar here.
2. Move uninurse.jar to the folder you want to use as the home folder for UniNurse.
3. Double-click the file to start UniNurse. A user interface similar to the one below should appear in a few seconds.

1. Type your command in the command box and hit Enter to execute the command. Here are some example commands you can try:
   • help: Opens the help window.
   • add n/Jane Doe p/91234567 e/janed@example.com a/20 Anderson Road, block 123, #01-01: Adds a patient named Jane Doe to your patient list.
   • delete -p 3: Deletes the 3rd patient shown in the current list.
   • list: Lists all patients.
   • clear: Deletes all patients shown in the current list.
   • exit: Exits from UniNurse.
2. Refer to the Features below for details of each command. Alternatively, you may refer to the Command Summary at the end of this guide.

Back to Table of Contents ↑

Glossary

Here are some of the technical terminologies used:

Back to Table of Contents ↑

Command format

Back to Table of Contents ↑

Patient parameter constraints

A patient’s attributes can be categorized into two: single-valued attributes and multi-valued attributes. A patient’s single-valued attributes consist of their name, phone, email, and address, and their multi-valued attributes consist of their tags, tasks, conditions, medications, and remarks.

Single-valued attributes

A patient’s single-valued attributes are also referred to as the patient’s contact details, which consist of the following.

n/NAME

NAME should only contain alphanumeric characters and spaces.

NAME is specified by the prefix n/.

Example: n/John Doe

p/PHONE

PHONE should only contain numbers, and it should be at least 3 digits long.

PHONE is specified by the prefix p/.

Example: p/91234567

e/EMAIL

EMAIL should be in the form of local-part@domain, where:

• local-part contains only alphanumeric characters and the special characters +, _, ., -, and may not start or end with any special characters.
• domain is made up of domain labels separated by periods, where domain must:
  • end with a domain label at least 2 characters long.
  • have each domain label start and end with alphanumeric characters.
  • have each domain label consist of alphanumeric characters, separated only by hyphens, if any.

EMAIL is specified by the prefix e/.

Example: johndoe@gmail.com

a/ADDRESS

ADDRESS accepts any values, excluding prefixes.

ADDRESS is specified by the prefix a/.

Example:a/John street, block 123, #01-01

Back to Table of Contents ↑

Multi-valued attributes

t/TAG

TAG accepts any values, excluding prefixes.

TAG is specified by the prefix t/, and its index by the flag -t.

Example:t/12-A nursing home

d/TASK_DESCRIPTION | DATE TIME | INTERVAL TIME_PERIOD

The task parameter has the following constraints:

• TASK_DESCRIPTION accepts any values, excluding prefixes and | separators.
• DATE TIME should be in the format of DD-MM-YY or DD-MM-YY HHMM.
  e.g. 2-7-22 1345, 09-4-22, 08-06-22 0900, 7-06-22 2130 and 28-10-22 are all valid DATE TIME.
• INTERVAL TIME_PERIOD should be in the format of X day(s)/week(s)/month(s)/year(s) where X is a positive integer.

TASK is specified by the prefix d/, and its index by the flag -d.

Example: d/Take CT scan | 23-11-22 1530 | 2 months

c/CONDITION

CONDITION accepts any values, excluding prefixes.

CONDITION is specified by the prefix c/, and its index by the flag -c.

Example:c/Parkinson's disease

m/MEDICATION_TYPE | DOSAGE

MEDICATION_TYPE accepts any values, excluding prefixes and | separators. DOSAGE should only contain alphanumeric characters, decimal points, and spaces.

MEDICATION is specified by the prefix m/, and its index by the flag -m.

Example:m/Amoxicillin | 0.5g every 8 hours

r/REMARK

REMARK accepts any values, excluding prefixes.

REMARK is specified by the prefix r/, and its index by the flag -r.

Example:r/Allergic to peanuts

Back to Table of Contents ↑

Patient parameter summary

Back to Table of Contents ↑

Features

Getting help: help

You can access the help page with the help command.

Format: help

Back to Table of Contents ↑

Adding a patient: add

You can add a patient to the patient list with the add command.

Format: add n/NAME p/PHONE e/EMAIL a/ADDRESS [t/TAG]… [d/TASK_DESCRIPTION | <DATE TIME> | <INTERVAL TIME_PERIOD>]… [c/CONDITION]… [m/MEDICATION | DOSAGE]… [r/REMARK]…

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 d/Administer 3ml of example medicine | 16-10-22 t/severe t/elderly adds a patient with the following details:
  • Name: John Doe
  • Phone number: 98765432
  • Email: johnd@example.com
  • Address: John street, block 123, #01-01
  • Tasks: Administer 3ml of example medicine | 16-10-22
  • Tags: elderly, severe
• add n/Betsy Crowe c/Dementia c/High blood pressure e/betsy@example.com a/Jane street blk 420 #01-69 p/87901234 adds a patient with the following details:
  • Name: Betsy Crowe
  • Phone number: 87901234
  • Email: betsy@example.com
  • Address: Jane street blk 420 #01-69
  • Medical conditions: Dementia, High blood pressure

Back to Table of Contents ↑

Editing a patient’s contact details: edit -p

You can edit the contact details of an existing patient in the patient list with the edit command.

Format: edit -p PATIENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS]

Example:

• edit -p 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.

Back to Table of Contents ↑

Deleting a patient: delete -p

You can delete a patient from the patient list with the delete command.

Format: delete -p PATIENT_INDEX

Examples:

• list followed by delete -p 2 deletes the 2nd patient in the patient list.
• find Betsy followed by delete -p 1 deletes the 1st patient in the results of the find command.

Back to Table of Contents ↑

Adding a tag: add -p

You can add a tag to a patient with the add command.

Format: add -p PATIENT_INDEX t/TAG

Examples:

• list followed by add -p 1 t/high-risk adds the high-risk tag to the 1st patient in the patient list.
• find Betsy followed by add -p 2 t/high-risk adds the high-risk tag to the 2nd patient in the results of the find Betsy command.

Back to Table of Contents ↑

Editing a tag: edit -p -t

You can edit a tag of a patient with the edit command.

Format: edit -p PATIENT_INDEX -t TAG_INDEX t/TAG

Examples:

• list followed by edit -p 2 -t 3 t/high-risk edits the 3rd tag of the 2nd patient in the patient list to high-risk.
• find Betsy followed by edit -p 1 -t 2 t/high-risk edits the 2nd tag of the 1st patient in the results of the find Betsy command to high-risk.

Back to Table of Contents ↑

Deleting a tag: delete -p -t

You can delete a tag of a patient with the delete command.

Format: delete -p PATIENT_INDEX -t TAG_INDEX

Examples:

• list followed by delete -p 2 -t 3 deletes the 3rd tag of the 2nd patient in the patient list.
• find Betsy followed by delete -p 1 -t 2 deletes the 2nd tag of the 1st patient in the results of the find Betsy command.

Back to Table of Contents ↑

Adding a task: add -p

You can add a task or recurring task to a patient with the add command.

Format: add -p PATIENT_INDEX d/TASK_DESCRIPTION | <DATE TIME> | <INTERVAL TIME_PERIOD>

Examples:

• list followed by add -p 1 d/Administer 3ml of example medicine adds a task to the 1st patient in the patient list.
• find Betsy followed by add -p 2 d/Change dressing on left arm | 12-7-22 adds a task to the 2nd patient in the results of the find command, on 12th July 2022 0000 hours.
• add -p 3 d/Take X-rays | 23-4-22 1345 | 3 weeks adds a recurring task to the 3rd patient for every 3 weeks starting from 23rd April 2022 1345 hours.

Back to Table of Contents ↑

Editing a task: edit -p -d

You can edit a task of a patient with the edit command.

Format: edit -p PATIENT_INDEX -d TASK_INDEX d/<TASK_DESCRIPTION> | <DATE TIME> | <INTERVAL TIME_PERIOD>

Examples:

• list followed by edit -p 1 -d 1 d/Administer 3ml of example medicine edits the description of the 1st task of the 1st patient in the patient list to Administer 3ml of example medicine, while retaining the original date and time for the task.
• find Betsy followed by edit -p 2 -d 3 d/| 23-10-22 0800 edits the date and time of the 3rd task of the 2nd patient in the results of the find command to 23rd October 2022 0800 hours, while retaining the original description for the task.
• list followed by edit -p 1 -d 1 d/| | 3 days edits the recurrence of the 1st task of the 1st patient if the task was a recurring task to every 3 days, while keeping the original description, date, and time. If the task was a non-recurring task, then this edit transforms the task into a recurring task with a recurrence of every 3 days.
• list followed by edit -p 2 -d 3 d/| 25-10-22 | 2 weeks edits the date and recurrence of the 3rd task for the 2nd patient in the patient list to 25th October 2022 and every 2 weeks, while keeping the original description and time. If the task was a non-recurring task, then this edit transforms the task into a recurring task with a recurrence of every 2 weeks.
• find David followed by edit -p 1 -d 2 d/Change bandage | | 4 days edits the description and recurrence of the 2nd task of the 1st patient in the results of find command to Change bandage and every 4 days, while keeping the original date and time. If the task was a non-recurring task, then this edit transforms the task into a recurring task with a recurrence of every 4 days.

Back to Table of Contents ↑

Deleting a task: delete -p -d

You can delete a task of a patient with the delete command.

Format: delete -p PATIENT_INDEX -d TASK_INDEX

Examples:

• list followed by delete -p 2 -d 3 deletes the 3rd task of the 2nd patient in the patient list.
• find Betsy followed by delete -p 1 -d 2 deletes the 2nd task of the 1st patient in the results of the find command.

Back to Table of Contents ↑

Adding a medical condition: add -p

You can add a medical condition to a patient with the add command.

Format: add -p PATIENT_INDEX c/CONDITION

Examples:

• list followed by add -p 1 c/Diabetes adds the Diabetes condition to the 1st patient in the patient list.
• find Betsy followed by add -p 2 c/Alzheimer's disease adds the Diabetes condition to the 2nd patient in the results of the find Betsy command.

Back to Table of Contents ↑

Editing a medical condition: edit -p -c

You can edit a medical condition of a patient with the edit command.

Format: edit -p PATIENT_INDEX -c CONDITION_INDEX c/CONDITION

Examples:

• list followed by edit -p 2 -c 3 c/Diabetes edits the 3rd condition of the 2nd patient in the patient list to Diabetes.
• find Betsy followed by edit -p 1 -c 2 c/Diabetes edits the 2nd condition of the 1st patient in the results of the find Betsy command to Diabetes.

Back to Table of Contents ↑

Deleting a medical condition: delete -p -c

You can delete a medical condition of a patient with the delete command.

Format: delete -p PATIENT_INDEX -c CONDITION_INDEX

Examples:

• list followed by delete -p 2 -c 3 deletes the 3rd condition of the 2nd patient in the patient list.
• find Betsy followed by delete -p 1 -c 2 deletes the 2nd condition of the 1st patient in the results of the find Betsy command.

Back to Table of Contents ↑

Adding a medication: add -p

You can add a medication to a patient with the add command.

Format: add -p PATIENT_INDEX m/MEDICATION_TYPE | DOSAGE

Examples:

• list followed by add -p 1 m/Paracetamol | 2 tabs every 6 hours adds the Paracetamol medication with the dosage 2 tabs every 6 hours to the 1st patient in the patient list.
• find Alice followed by add -p 2 m/Amoxicillin | 0.5g every 8 hours adds the Amoxicillin medication with the dosage 0.5g every 8 hours to the 2nd patient in the results of the find Alice command.

Back to Table of Contents ↑

Editing a medication: edit -p -m

You can edit a medication of a patient with the edit command.

Format: edit -p PATIENT_INDEX -m MEDICATION_INDEX m/<MEDICATION_TYPE> | <DOSAGE>

Examples:

• list followed by edit -p 1 -m 1 d/Amoxicillin edits the medication type of the 1st medication of the 1st patient in the patient list to Amoxicillin, while retaining the original dosage.
• find Alice followed by edit -p 2 -m 3 d/| 2 tabs every 6 hours edits the dosage of the 3rd medication of the 2nd patient in the results of the find Alice command, while retaining the original medication type.

Back to Table of Contents ↑

Deleting a medication: delete -p -m

You can delete a medication of a patient with the delete command.

Format: delete -p PATIENT_INDEX -m MEDICATION_INDEX

Examples:

• list followed by delete -p 2 -m 3 deletes the 3rd medication of the 2nd patient in the patient list.
• find Alice followed by delete -p 1 -m 2 deletes the 2nd medication of the 1st patient in the results of the find Alice command.

Back to Table of Contents ↑

Adding a remark: add -p

You can add a remark to a patient with the add command.

Format: add -p PATIENT_INDEX r/REMARK

Examples:

• list followed by add -p 1 r/Requires wheelchair to move around adds the Requires wheelchair to move around remark to the 1st patient in the patient list.
• find Rachel followed by add -p 2 r/Allergic to Peanuts adds the Allergic to Peanuts remark to the 2nd patient in the results of the find Rachel command.

Back to Table of Contents ↑

Editing a remark: edit -p -r

You can edit a remark of a patient with the edit command.

Format: edit -p PATIENT_INDEX -r REMARK_INDEX r/REMARK

Examples:

• list followed by edit -p 2 -r 3 r/Allergic to Amoxicillin edits the 3rd remark of the 2nd patient in the patient list to Allergic to Amoxicillin.
• find Rachel followed by edit -p 1 -r 2 r/Allergic to Amoxicillin edits the 2nd remark of the 1st patient in the results of the find Rachel command to Allergic to Amoxicillin.

Back to Table of Contents ↑

Deleting a remark: delete -p -r

You can delete a medical condition of a patient with the delete command.

Format: delete -p PATIENT_INDEX -r REMARK_INDEX

Examples:

• list followed by delete -p 2 -r 3 deletes the 3rd remark of the 2nd patient in the patient list.
• find Rachel followed by delete -p 1 -r 2 deletes the 2nd remark of the 1st patient in the results of the find Rachel command.

Back to Table of Contents ↑

Listing all patients: list

You can view a list of all patients using the list command.

Format: list

Back to Table of Contents ↑

Viewing all details of a patient: focus -p

You can view all details of a specified patient using the focus command.

Format: focus -p PATIENT_INDEX

Examples:

• list followed by focus -p 2 shows all details of the 2nd patient in the patient book.
• find Fiona followed by focus -p 1 shows all details of the 1st patient in the results of the find command.

Back to Table of Contents ↑

Finding patients: find

You can find specific patients using the find command.

Format: find [KEYWORD]… [xyz/XYZ_KEYWORD]…

Examples:

• find key n/John n/Betsy n/Charlie e/@example.com e/@u.nus.edu displays all patients who fulfill all conditions below:
  • The patient’s name must contain either John or Betsy or Charlie.
  • The patient’s email address must contain either @example.com or @u.nus.edu.
  • At least one of the patient’s details must contain key (e.g., one of their tags contains key).
• find jo displays patients with names Joe and John, patients with emails jo@example.com, and patients with tag joints.
• find n/alice n/meier displays patients Alice Tan and Benson Meier.

Back to Table of Contents ↑

Viewing all tasks for a particular day: view

You can view the list of tasks for a particular day using the view command.

Format: view DATE

Examples:

• view 5-9-22 lists the tasks on 5th September 2022
• view 25-11-22 lists the tasks on 25th November 2022

Back to Table of Contents ↑

Viewing all tasks for today: view --today

You can view the list of tasks that are due today using the view command with the special flag --today.

Format: view --today

Examples:

Let’s say you added the following patients and their tasks:

• Physiotherapy appointment for Alex Yeoh at 12:00pm on 2022-11-04
• Administer insulin dose for Charlotte Oliveiro at 11:45am on 2022-11-04

If today’s date is 2022-11-04, view --today will display those 2 tasks.

Back to Table of Contents ↑

Viewing all tasks of a patient: view -p

You can view the list of tasks for a particular patient using the view command.

Format: view -p PATIENT_INDEX

Examples:

• list followed by view -p 2 will show the list of tasks for the 2nd patient in the patient list.

Back to Table of Contents ↑

Viewing all tasks of all patients: view -p --all

You can view the list of tasks for all patients using the view command with the special flag --all.

Format: view -p --all

Examples:

• view -p --all will show a list of all tasks belonging to patients with tasks.

Back to Table of Contents ↑

Undoing previous command: undo

You can undo the last command which modifies the application data with the undo command.

Format: undo

Examples:

• delete -p 2 followed by undo has the same effect as not doing the delete command.
• delete -p 2 followed by list, then followed by undo will undo the delete command.

Caution: Only the last 100 commands which modify the application data can be undone. data file at the next run.

Back to Table of Contents ↑

Reversing undo command: redo

You can undo the last undo command with the redo command.

Format: redo

Example:

• undo followed by redo has the same effect as not using the undo command.
• Two consecutive undo commands followed by redo has the same effect as using the undo command once.

Back to Table of Contents ↑

Clearing all entries: clear

You can clear all patient entries in the displayed patient list with the clear command.

Format: clear

Examples:

• list followed by clear will delete all patients.
• find Betsy followed by clear deletes all patients in the results of the find Betsy command.

Back to Table of Contents ↑

Exiting UniNurse: exit

You can exit UniNurse with the exit command.

Format: exit

Back to Table of Contents ↑

Saving the data

UniNurse automatically saves its data on the hard disk after any command that changes the data. You do not need to save manually.

Back to Table of Contents ↑

Editing the data file

UniNurse data are saved as a JSON file [JAR file location]/data/uninurse.json. If you are an advanced user, feel free to update data directly by editing that data file.

Caution: If your changes to the data file make its format invalid, UniNurse will discard all data and start with an empty data file at the next run.

Back to Table of Contents ↑

FAQ

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

Back to Table of Contents ↑

Command summary

Back to Table of Contents ↑