Skip to content

Latest commit

 

History

History
1414 lines (912 loc) · 47.4 KB

UserGuide.adoc

File metadata and controls

1414 lines (912 loc) · 47.4 KB

QuickDocs - User Guide

1. Introduction

QuickDocs is an all in one solution where doctors can have greater control in facilitating patient consultations, organizing appointments, and monitoring financial and inventory records in private clinics.

Let us explore how QuickDocs can facilitate and expedite clinical operations in your neighbourhood clinic.

2. Quick Start

  1. Ensure you have Java version 9 or later installed in your Computer.

  2. Download the jar file and put it into a folder you desire.

  3. Type a command into the command box and press enter to execute it.

    ℹ️
    For the full list of commands, you can head to Section 6, “Command Summary”

2.1. Interacting with QuickDocs

ui explanation
Figure 1. The user interface for QuickDocs
  1. This is the command input box , this is where you can type and execute the various commands QuickDocs possesses to perform clinical operations.

  2. If you make mistakes and enter an invalid command, instructions on how you can rectify your commands will be shown in this input feedback box.

  3. After the execution of your command, you can view the results on the main display area

  4. You can view your upcoming appointments for the day, or urgent reminders that you made earlier in the reminders and appointments panel

    • Appointments are coloured blue, medicine alarms are coloured red and other reminders are coloured beige.

  5. During a consultation session, QuickDocs will also indicate that a session is ongoing through this current consultation label

3. Notations used

Here are some notations used in this user guide:

💡
This is a tip. Useful information pertaining to the features will be written here.
ℹ️
This is a note. Additional information that further explains a feature will be written here.

command This is a user input to the application. It is formatted with a gray background. Example: help

4. Features

QuickDoc’s Command Format

command prefix/VALUE [prefix/OPTIONAL VALUE] …​

  • Command represent the operation you want to perform such as adding patients, listing medicine inventory and so on.

  • Values are the mandatory user input required for the execution of commands.

  • Optional values are non-compulsory values that can be added in certain commands. They can be added multiple times after the command, prefixes and values.

💡
All commands have aliases, which can be used to execute the same command with fewer keystrokes e.g. statistics can be replaced by stats.

 

4.1. Viewing help

Whenever you want to find out in-depth explanation on how to execute a specific command, you can always refer to this user guide by entering the help command on QuickDocs.

Format: help

 


4.2. Patient Management

The Patient Management module features commands involving the registration, update, searching and removal of patient records in QuickDocs.

Using just a few keystrokes, you can manage your patient records in a more organized and efficient manner.


4.2.1. Adding patient: addpat

You can register new patients and start storing their records in QuickDocs using the addpat command.

Patient details that can be stored include: name, NRIC, email, address, gender, date of birth, contact number.

💡
You can add a tag to a patient to indicate his or her long term illnesses. You can add multiple tags to the patient to ease searching.


Format: addpat n/NAME r/NRIC e/EMAIL a/ADDRESS g/GENDER d/DATE OF BIRTH c/CONTACT [t/tag]…​

Alias    : ap

💡
The order of input does not matter as long as all the necessary fields are captured.


Examples:

  • addpat n/Gary Goh r/S7332803I g/M d/1973-04-01 a/20 Upper Changi Road c/92347654 e/[email protected] t/highbloodpressure t/diabetes

  • addpat n/Chan Mei Hua r/S8865281I d/1998-05-09 g/F c/92341221 a/2 Simei Street e/[email protected]


Result:

After entering the addpat command, QuickDocs will show the details of the recently added patient on the main display as demonstrated in the diagram below:

ap after
Figure 2. The main display after addpat command

4.2.2. Editing patient : editpat

If you made a mistake when registering a patient, fret not! You can always make changes to the patient record with the editpat command. All the fields in the record can be edited, including the NRIC and tags.

ℹ️
The tags entered during an edit patient command will override all the tags a patient record currently possess.


Format: editpat NRIC [n/NAME] [a/Address] [r/NRIC] …

Alias    : ep

ℹ️
The first NRIC to specify the record does not require a prefix.
The prefixes used for the editpat command is the same as the ones used in the Add patient section.


Example:


Result:

After the editpat is performed, you can view the changes made to the patient record in the main display.

ep after
Figure 3. Result of an edit command, on a patient’s name and email


Since every citizen, permanent residents or foreigners in Singapore have their unique NRIC / FIN numbers, duplicate NRIC are not allowed in QuickDocs.

When you edit a patient’s NRIC/FIN and there is an existing patient with that NRIC, the current edit will not be executed. You will also be notified of the detection of duplicated NRIC entries through the input feedback box, in the manner shown in the following picture.

ep conflict
Figure 4. Error message shown when QuickDocs detected a duplicate NRIC in the patient records

4.2.3. List patient details : listpat

To view a patient’s detail, you can use the listpat command. You can search and filter patient records by their names, NRIC and even their tags.

  • QuickDocs only support one filter per search currently.

  • If more than one filter is entered (i.e. listpat n/NAME r/NRIC, only the first search criteria will be used (in this case, name)

For example, if you want to check the patient’s NRIC, you can always turn to listpat to help narrow down your search. Entering listpat with r/S92 and QuickDocs will present you with patient records whose NRIC starts with S92.

  • You can similarly filter down your search using tags or parts of a patient name in the same manner.

  • A specific patient’s record can be displayed by calling listpat with the full name or full nric

ℹ️
Each patient record stored within QuickDocs have a record number, known as an INDEX. The Index can also be used to narrow down patient searches to a single record.


Format: listpat [PREFIX / KEYWORD] …

Alias    : lp


Examples and Results:

  • listpat

If no keywords are entered, listpat will simply display the first 50 patients record stored.

lp noargs
Figure 5. executing the listpat command without any matching criteria


* listpat n/P

Suppose you want to find a patient record whose name starts with "P", you can use listpat along with a sequence of characters to search for the specific patient record you are interested in.

lp name after
Figure 6. Listing patients with matching name


* listpat r/S92

You can narrow down your patient search by providing a NRIC sequence as well. For example, in the figure below, you can retrieve all the patients whose NRIC starts with "S92".

lp nric after
Figure 7. Listing patients with matching NRIC


After narrowing down your search, you will be able to use the specific NRIC number of a particular patient to view the in-depth patient particulars.

lp nric specific
Figure 8. Showing specific patient’s record using the full NRIC


* listpat t/diabetes

The tags you assigned to each patient can also be used to expedite the listpat command. For example, diabetic patients can be listed using the listpat command along with "t/diabetes" value.'

ℹ️
Tags specified for the search must be full sequences (i.e. Diabetes, highbloodpressure/, etc). QuickDocs do not permit partial tag search as of v1.4.
lp tag after
Figure 9. Listing patients by specific tag


* listpat 5

Did you notice that when QuickDocs display multiple patient records during filtering, each record starts with a number? This is the index of the patient record, indicating the position the record is stored within QuickDoc’s patient record storage.

You can make use of the index number to view specific patient records as well.

lp index
Figure 10. Patient search using record index

4.2.4. Deleting patient deletepat

When a patient is no longer visiting your clinic (i.e. moved residency), you can choose to remove their details from QuickDocs.


Format: deletepat r/NRIC

Alias    : dp


Example: deletepat r/S7338031I


Result:

By specifying the NRIC along with the deletepat command, you will delete the patient with that specific NRIC. If you have difficulty finding the specific NRIC, you can refer to the List patients command section to help you retrieve the patient’s NRIC.

dp after
Figure 11. Deleting patient records using the specific NRIC

 


4.3. Consultation Management

With QuickDocs, you no longer need to navigate to different menus just to record symptoms of the patient’s illness, or assigning medicine to tackle the patient’s current condition.

Using the Consultation Management module, you can now handle the prescription and diagnosis stages of each consultation session in one go.


4.3.1. Start consultation: consult

After a patient is registered, whenever he or she visits your clinic, you can start recording the diagnosis and medicine prescribed by starting a consultation session on QuickDocs.

Consultation is started after the NRIC of the patient is provided, you can revisit the List patients section to help identify the NRIC of specific patients

ℹ️
QuickDocs only permit one ongoing consultation session at any given time. The Diagnose patient and Prescribe medicine steps must be completed before a consultation can end. Otherwise you can always use the Abort consultation command to exit an ongoing session without saving any details recorded.


Format: consult r/NRIC

Alias    : c


Example:

  • consult r/S9876542C

Result:

Once you started a consultation session for the patient, a message will be displayed on the main display area to indicate that the consultation session have started for the current patient.

consult after
Figure 12. Starting a consultation session on QuickDocs


A text indicating that the consultation session have started for the particular patient will also appear at the bottom right corner of QuickDocs, so that you will be aware that a current consultation session is ongoing even after subsequent commands.


ℹ️
While a consultation session is ongoing, It does not mean that you are limited to just entering the consultation commands. You can still enter command that are not within the consultation module (i.e. listing patients, checking the medicine inventory, etc).

4.3.2. Diagnosing a patient: diagnose

After the consultation session has began, you can start recording the patient’s ailments. The various symptoms the patients have can be recorded down, along with the final assessment of the illness the patient is currently having.

To complete the diagnosis, the record must have one assessment and at least one symptom.

ℹ️
This command requires you to have a consultation session already active. See: Start consultation.


Format: diagnose s/SYMPTOM [s/SYMPTOM] …​ a/ASSESSMENT

Alias    : d


Example:

  • diagnose s/runny nose s/sore throat s/phlegmy cough a/influenza

The order of symptoms and assessment does not matter here. You record as many symptoms per diagnosis.


Results:

After entering the command, QuickDocs will show the symptoms and assessment recorded on the main display as demonstrated in the following diagram.

diagnose after
Figure 13. Result of the diagnose command


If you made a mistake when entering the diagnosis, you can always rectify it by re-entering the diagnose command with the correct symptoms and assessment. This will replace the current erroneous diagnosis with the one you have just entered.

diagnose edit after
Figure 14. Editing the diagnosis


💡
Whenever you make a mistake entering a command, you can always press the UP and DOWN buttons on your keyboard to cycle through the past commands you have entered into QuickDocs. This allow you to easily navigate to the erroneous command you have entered, make changes and then re-enter the command again to rectify your errors.

4.3.3. Prescribing medicine for a patient: prescribe

After you are done recording the symptoms and assessing the illness of the patient, you can start prescribing medicine to your patient.

For each medicine prescribed, the quantity must be specified. Like the Diagnose patient command, you can always reenter the command to override the current prescription should there be any errors made.

A minimum of one medicine and one quantity is required to record a prescription entry. The order of quantity entered corresponds to the order of the medicine entered.

ℹ️
This command requires you to have a consultation session already active. See: Start consultation.
ℹ️
The medicine to be prescribed must be present in the inventory and its quantity must be sufficient for the assignment during the presciption stage.
Check out the Add medicine section for information on adding medicine to the inventory, and List medicines section on the steps to check a medicine’s amount.


Format: prescribe m/MEDICINE [m/MEDICINE] …​ q/QUANTITY [q/QUANTITY]
or         : prescribe m/MEDICINE q/QUANTITY [m/MEDICINE] [q/QUANTITY] …​

Alias    : p


Example:

  • prescribe m/penicillin q/1 m/Afrin spray q/1 m/ibuprofen q/2
    Prescription now consist of 1 unit of penicillin, 1 unit of afrin spray and 2 units of ibuprofen.

  • prescribe m/penicillin m/Afrin spray m/ibuprofen q/1 q/1 q/2
    Same as above example, quantity ordered based on medicine order.


Results:

After the medicine-quantity pairings are entered, the prescription to address the patient’s current condition will be displayed on the main display area of QuickDocs. Changes can still be made to the prescription as long as the consultation session is still ongoing.

prescription after
Figure 15. Prescribing medicines to tackle the patient’s current conditions

4.3.4. End consultation: endconsult

Once the diagnosis and prescription are finalized, you can end the consultation with a simple endconsult command. No further changes to the diagnosis and prescription details can be made after this point.


Format: endconsult

Alias    : ec


Result:

Once you entered the endconsult command, a message to indicate the end of the consultation session is also shown on the main display area. The label for the ongoing consultation session is also removed after the command is entered.

Most importantly, the consultation record (diagnosis and prescription) is now stored.

endconsult
Figure 16. Results of an endconsult command

4.3.5. Aborting a consultation session: abort

If you started a consultation session by mistake, or the patient does not seemed to require a consultation, you can always abort the consultation session without providing the diagnosis and prescription details.


Format: abort

Alias    : ab


Result:

When you enter the abort command, a message is also shown on the main display area to indicate that the current session is aborted. The label for the ongoing consultation session is also removed.

abortconsult
Figure 17. Results of an abort command

4.3.6. List consultation: listconsult

Whenever you want to revisit a specific consultation record, you can filter it down by the patient before narrowing it down to the specific session.

You can use QuickDocs to list out all the past consultation sessions of a single patient by first specifying his or her NRIC, and then view the consultation details by passing in the session’s index.


Format: listconsult INDEX
or         : listconsult r/NRIC

Alias    : lc


Examples and Results:

  • listconsult r/S9876542C

Specifying the NRIC after the listconsult command will display a list of consultation records belonging to the patient with the specified NRIC.

Note that the indexes are prepended on each of the past consultation records listed.

listconsult after
Figure 18. Displaying past visits of a particular patient


  • listconsult 1

listconsult index

You can then call listconsult again with the consultation record’s index to view the specific consultation session details. QuickDocs will display the time of the consultation, and also the diagnosis and prescription given to the patient.

listconsult index
Figure 19. Revisiting a specific consultation session



4.4. Medicine Management

You can manage your medicine storage all by your wishes! QuickDocs allows you to organise your medicines in a directory format much like the folders in Windows OS!

You can design and name your directories by functionalities, pricing, classifications or anything in your mind!

Initially, the medicine storage only contains one root directory named as "root" by default. All the rest is then up to you to decide!

💡
Through QuickDocs, you could place the same medicine under different directories. For example, medicine paracetamol could be placed under "fever" and "headache" simultaneously.
💡
Following the same logic, you may not be able to store two different medicine with the same name in QuickDocs. All instances of medicine with the same name will refer to the same medicine.

4.4.1. Suggestion mode in command typing

In QuickDocs, as medicines are stored in directories format, you will need to key in the path to your interested directory/medicine from time to time.

For your convenience, QuickDocs actually provides a quick cut to key in these paths so that you do not need to type in every character by yourself!

As long as you are typing a command in medicine module and you have typed the name of the first parent directory followed by a \ character, the suggestion mode is automatically turn on!

So what is suggestions mode? Why is that useful? The following example will illustrate the convenience it brings to you.

  • Suppose you have a directory 'Flu' under directory 'General' under directory 'Internal' under the root directory 'root' as illustrated below:

suggestion ug1
Figure 20. Display of detailed information
  • Now you want to type this command listmed root\Internal\General\Flu , which is a command to see detailed information about that directory, from scratch.

  • What you can do is to first type listmed root\ to trigger the suggestion mode.

suggestion ug2
Figure 21. To trigger the suggestion mode
  • You can then press the page-down key to iterate through all subdirectories under 'root'. The input box will automatically be filled for you.

suggestion ug3
Figure 22. After pressing Page Down once
  • In this example, you can arrive at listmed root\Internal in just two Page Down keys.

suggestion ug4
Figure 23. After pressing Page Down twice
  • Doing this recursively at every stage, you can quickly arrive at the desired listmed root\Internal\General\Flu.

  • Suppose now you want to view the detailed information about a medicine called 'guaifenesin' under directory 'Flu'. You entered listmed root\Internal\General\Flu\guai only to realize that you forget the spelling of guaifenesin.

  • Do not worry! You can press page-up / page-down as well. Page up will bring you to the last valid sub-directory / medicine name as compared to your input according to alphabetic order. Page down will bring you to the next valid input.

suggestion ug5
Figure 24. Before pressing Page Up / Page Down
suggestion ug6
Figure 25. After pressiong Page Up, brings you to the last valid medicine: diphenhydramine
suggestion ug7
Figure 26. After pressing Page Down, brings you to your desired : guaifenesin

 

In short, instead of typing out every characters, you can iterate through your directories fast and easy when typing commands using the page-up and page-down keys!

ℹ️
In QuickDocs, names of directories and medicines are case-insensitive. So what appears in the suggestions may be in different cases from the actual name, but they will work the same.

4.4.2. Add new directory into storage: adddirec

By providing the path pointing to a specific directory, you can add a new directory under that directory.

The new directory will be an empty directory whose name is up to you to decide.

ℹ️
The new directory’s name should not contain white spaces or "\" characters.


Format: adddirec [PATH OF THE PARENT DIRECORY] [NAME OF NEW DIRECTORY]

Alias    : ad


Example:

  • adddirec root fever followed by adddirec root\fever oral

Result:

These commands add a new directory called fever to root, and then add another new directory called oral under fever.

There will be success messages confirming every successful addition of directories.

adddirec after
Figure 27. Result of sample add directory command

4.4.3. Add medicine into storage: addmed

Through this command, you can either add a new medicine into the storage, or to place an existing medicine under another directory.


You can add a new medicine by specifying where it should go to, its initial quantity and its price

Format: addmed [PATH OF DIRECTORY TO ADD TO] [MEDICINE_NAME] [q/QUANTITY] [p/PRICE]

Alias    : am

ℹ️
Directories and medicines under the same directory are now allowed to share the same name (case-insensitive).


Example:

addmed root\fever paracetamol q/50 p/9.99

Result:

After you enter the command, if it is executed successfully, a confirmation message will appear.

addmed newmedicien after
Figure 28. Success message of sample addmed command


ℹ️
If you entered a medicine name that already exists in the storage in this format, a error message will pop up.
addmed newMedicine existing
Figure 29. Error message of adding an existing medicine in wrong format


You can also place an existing medicine into a directory.

Format: addmed [PATH] [MEDICINE_NAME]


Example:

addmed root\headache paracetamol

Assuming there already exists a medicine called paracetamol in the storage, you can place this medicine under root\headache via this command.

Result:

After you enter the command, if it is executed successfully, a confirmation message showing the detailed information of that medicine will appear.

addmed existing
Figure 30. Success message of sample addmed command


ℹ️
If you entered a medicine name that has not existed in the storage in this format, an error message will pop up.
addmed existing nonExisting
Figure 31. Error message for adding new medicine in wrong format

In this case, no medicine called aspirin has yet existed in the storage.


4.4.4. List medicine storage: listmed

Whenever you want to see what is inside your medicine storage, you can always use this command to view the detailed information about any directory or medicine through this command.


Format: listmed [PATH]

Alias    : lm


Example:

listmed root\fever

Result:

You will be able to view a detailed description of all the medicines and directories under root\fever.

listmed after
Figure 32. Response for a sample listmed command viewing a directory


Example:

listmed root\fever\paracetamol

Result:

You will be displayed a detailed description of medicine paracetamol which is placed under root\fever.

listmed med after
Figure 33. Response for a sample listmed command viewing a medicine

4.4.5. Setting automatic notification for low stock: alarm

To further ease your management of the clinic, QuickDocs could automatically alert you should any of your medicine is running low in storage!

All you need to do is to set an alarm level for the medicine you are concerned with.

💡
In addition, QuickDocs can make your life even easier! You can set an alarm level for a directory so that every medicine placed under that directory and all its sub-directories will immediately have that alarm level.


Format: alarm [PATH OF DIRECTORY OR MEDICINE]


Example:

alarm root\fever 60


Result:

As the path points to a medicine, the sample command set the alarm level for aspirin to 60.

As the storage only has 50 units of aspirin, a reminder is shown on the right.

alarm medicine after
Figure 34. Response for the sample alarm command


Example:

alarm root\high_blood_pressure\aspirin


Result:

As the path points to a directory, the sample command set the alarm level for all medicine under "fever" directory and all its subdirectories to 60.

As the medicine paracetamol under "fever" has only 50 units, which is below the limit, a reminder is shown on the right.

alarm directory after
Figure 35. Responses for the sample alarm command

4.4.6. Recording purchases of medicine: buymed

As a doctor running your own clinic, you will certainly purchase medicine from time to time to keep your medicine storage updated.

This command allows you to record every purchase you made in the simplest way!

💡
You can access the medicine via two ways. You can either provide the full path to the medicine, or provide the name of medicine only.

Format: buymed [MEDICINE_NAME] [AMOUNT] [UNIT_COST]
or         : buymed [PATH_OF_MEDICINE] [AMOUNT] [UNIT_COST]

Alias    : bm


Example:

buymed aspirin 20 4.3


Result:

Using this command, you update the amount of aspirin in the storage form 34 to 54.

As the amount of aspirin now exceed the minimum threshold set, which is 50, the reminder for low storage automatically disappears.

The following figures illustrates the states of QuickDocs before and after you executing that command.

buymed before
Figure 36. The state before purchasing medicine


buymed after
Figure 37. The state after purchasing medicine. Note that the reminder is gone.


ℹ️
To make your life easier, QuickDocs automatically records every purchase you made via this command so that you can check your clinic’s statistics any time.

4.4.7. Setting Price for a medicine: setprice

Through QuickDocs, you have hundred percent freedom to set the price of your medicine via this simple command!

The price you set will be used in your prescriptions.

💡
Similar to buymed command, you can either provide the full path to your interested medicine or the name of it only.

Format: setprice [PATH_OF_MEDICINE] [PRICE]
or         : setprice [NAME_OF_MEDICINE] [PRICE]

Alias    : sp


Example:

setprice aspirin 10.50


Result:

This command sets the unit price of aspirin to $10.50. You will then have no need to key in the price during each prescription, this price will automatically be used.

setprice after
Figure 38. Response for the sample setprice command

4.4.8. View the detailed information about any medicine: [coming in V2.0]

Using external APIs, the users could view more detailed information about any medicine.


4.5. Appointments and Reminders

The Appointment and Reminder module give you more control over your busy schedule, featuring commands such as adding, removing, and searching appointments and reminders. There is also a command to list out all free appointment timings to help you choose your appointment timings more wisely.

You will never forget about any appointments or tasks again!


4.5.1. Adding appointments: addapp

After a consultation session, you may want to schedule a follow-up appointment with your patient. You can do so with addapp to create an appointment with an existing patient in QuickDocs to add to your schedule.

💡
The freeapp command may be useful for you to first list out all free appointment timings for a given range of dates before choosing an appropriate appointment timing!
ℹ️
To ensure that you do not forget about any future appointments, QuickDocs will automatically create a reminder for the added appointment. You may not notice this reminder as it will only appear on your reminder sidebar closer to the date of the actual appointment (on the week of the appointment date).


Format: addapp r/NRIC d/DATE s/START e/END c/COMMENT

Alias    : aa

ℹ️
The format for a valid date is strictly YYYY-MM-DD (including the dashes) and a valid time is strictly HH:MM (including the colon). If unsure, you may refer to the example below.


Example and results:

  • addapp r/S6394980I d/2019-07-23 s/16:00 e/17:00 c/Weekly checkup

This adds an appointment allocated to the patient with NRIC S6394980I, on 23rd July 2019, from 4pm to 5pm. You can include any comments or notes you want to this appointment, which is 'Weekly checkup' in this case.

If the addition of the appointment was successful, QuickDocs will show the details of the added appointment on the main display as demonstrated in the diagram below:

addapp success
Figure 39. The main display after adding an appointment


The addition of the appointment could have failed as there is a conflict in timing with another existing appointment. QuickDocs will display a message in the input feedback box notifying you of this error, as demonstrated in the diagram below.

addapp clash
Figure 40. Adding an appointment that has conflicting timing with an existing appointment


Another reason for failing to add an appointment could be due to the appointment timing being outside of office hours which is from 9am to 6pm. QuickDocs will alert you of this error, as demonstrated in the diagram below:

addapp officehour
Figure 41. Adding an appointment that is not within the office hours, from 9am to 6pm

4.5.2. Listing appointments: listapp

You can list all past and future appointments that you have added using the listapp command. The appointments will be ordered and listed, with the earliest appointment at the top and the latest at the bottom. You can filter the appointments you want to see either by specifying a FORMAT and a DATE, or by specifying an existing patient’s NRIC.


Format: listapp f/FORMAT d/DATE
or        : listapp r/NRIC
Alias    : la

ℹ️
The valid keywords for FORMAT are only day, week, or month.


Examples:

  • listapp

By default, listapp will list all appointments scheduled in the current week if there are no keywords provided.

  • listapp f/day d/2019-07-23

Lists all appointments scheduled on 23rd July 2019.

  • listapp f/week d/2019-07-23

Lists all appointments scheduled on the given week of 23rd July 2019, which is from 22nd to 28th July. A week starts on a Monday and ends on a Sunday.

  • listapp f/month d/2019-07-23

Lists all appointments scheduled in the month of the given date, July 2019.

  • listapp r/S9123456A

Lists all appointments allocated to the patient with NRIC S9123456A, if this patient is registered in QuickDocs.

Result:

The filtered appointments will be ordered by time and listed on the main display of QuickDocs, as demonstrated in the diagram below:

listapp week
Figure 42. Listing appointments scheduled on the week of 23rd July 2019.

4.5.3. Deleting appointments: deleteapp

If the patient would like to change the appointment date, or if there is a mistake in the appointment details, you can delete the existing scheduled appointment with deleteapp and then create a new appointment. Deletion of an appointment is final!

ℹ️
QuickDocs will automatically delete the corresponding reminder created for the deleted appointment, if it still exists, so you don’t have to worry about any discrepancies with your reminder sidebar!


Format: deleteapp d/DATE s/START

Alias    : da

ℹ️
Since there cannot be any overlapping appointment timings, you are able to uniquely identify any appointment with just the DATE and START time of the appointment.


Example and results:

  • deleteapp d/2019-07-23 s/16:00

This command will delete the appointment created on 23rd July 2019 with a start time of 4pm, if it exists. If successful, QuickDocs will display the details of the deleted appointment on the main display, as demonstrated in the diagram below:

deleteapp success
Figure 43. Deleting an existing appointment in QuickDocs successfully


If the given appointment was not found, QuickDocs will display an error message on the input feedback display, as demonstrated in the diagram below. Use the listapp command to find existing appointments for a given date!

deleteapp failure
Figure 44. Deleting a non-existent appointment in QuickDocs

4.5.4. List free appointment slots: freeapp

Unsure of what appointment timings are available in your schedule? Instead of using listapp to display all existing appointments, use freeapp instead to display a more intuitive list of free appointment slots - QuickDocs does the thinking for you!

The free appointment slots will be ordered and listed, with the earliest date at the top and the latest at the bottom. You can filter the free slots you want to see by specifying a FORMAT and a DATE.


Format: freeapp f/FORMAT d/DATE

Alias    : fa

ℹ️
Similar to listapp, the valid keywords for FORMAT are only day, week, or month.


Examples:

  • freeapp

By default, freeapp will list all free appointment slots for the next month if there are no keywords provided.

  • freeapp f/day d/2019-07-23

Lists all free appointment slots on 23rd July 2019.

  • freeapp f/week d/2019-07-23

Lists all free appointment slots on the given week of 23rd July 2019, which is from 22nd to 28th July. A week starts on a Monday and ends on a Sunday.

  • freeapp f/month d/2019-07-23

Lists all free appointment slots in the month of the given date, July 2019.

Result:

The free appointment slots will be ordered by date and time and will be listed on the main display of QuickDocs, as demonstrated in the diagram below:

freeapp week
Figure 45. Listing free appointment slots on the week of 23rd July 2019.

4.5.5. Adding reminders: addrem

Need to take note of a task to do in the future? You can create a reminder for an event or task with addrem, and the reminder will show up on your sidebar closer to the date of the event (the week of the reminder date). Never forget about your tasks ever again!


Format: addrem t/TITLE d/DATE s/START [e/END] [c/COMMENT]

Alias    : ar

ℹ️
END time and COMMENT are optional fields for a reminder.


Example:

  • addrem t/Check financial records d/2019-07-31 s/18:00 e/18:30 c/Monthly check

This command will create a reminder to 'Check financial records' which is a 'Monthly check', on 31st July 2019 from 6pm to 6:30pm.

Result:

If the addition of the reminder was successful, QuickDocs will show the details of the added reminder on the main display as demonstrated in the diagram below:

addrem success
Figure 46. The main display after adding a reminder

4.5.6. Listing reminders: listrem

To view your past or future reminders on the sidebar, you can do so using the listrem command. The reminders will be ordered and listed, with the earliest reminder at the top and the latest at the bottom. You can filter the reminders you want to see by specifying a FORMAT and a DATE.

ℹ️
On startup, QuickDocs will automatically display the reminders for the current week on the sidebar.

Are the titles or comments too long to be displayed fully on the sidebar? You can also use listrem to display all the details of a single reminder by specifying its INDEX that is shown on the sidebar.

💡
If you are tired of typing, you could also click the reminder with your mouse and all its details will be displayed as well!


Format: listrem f/FORMAT d/DATE
or        : listrem i/INDEX
Alias    : lr


Examples and results:

  • listrem

By default, listrem will list all reminders in the current week if there are no keywords provided.

  • listrem f/day d/2019-07-31

Lists all reminders on 31st July 2019.

  • listrem f/week d/2019-07-31

Lists all reminders on the given week of 31st July 2019, which is from 29th July to 4th August. A week starts on a Monday and ends on a Sunday.

  • listrem f/month d/2019-07-31

Lists all reminders in the month of the given date, July 2019.

The filtered reminders will be ordered by date and time and will be listed on the reminder sidebar, as demonstrated in the diagram below:

listrem week
Figure 47. Listing reminders scheduled on the week of 31st July 2019.


  • listrem i/3

In the screenshot above, the details of the third reminder is not fully displayed! Use the above command to display, on the main display, the details of the third reminder listed on the sidebar as demonstrated in the diagram below:

listrem single
Figure 48. Displaying details of the third reminder.

4.5.7. Deleting reminders: deleterem

If you would like to clear out your reminder sidebar after a task is completed, you can do so using the deleterem command. Each reminder on the sidebar are identified with an INDEX, which you can use to specify the reminder to be deleted. Deletion of a reminder is final!


Format: deleterem INDEX

Alias    : dr

ℹ️
We do not need to include the INDEX prefix, i/, as opposed to the listrem command. This is because deleterem only accepts one parameter, INDEX, while listrem can accept more than one.


Example and results:

  • deleterem 3

This command will delete the third reminder listed on the sidebar, if it exists. If successful, QuickDocs will display the details of the deleted reminder on the main display, as demonstrated in the diagram below:

deleterem success
Figure 49. Deleting an existing reminder in QuickDocs successfully


If the given INDEX is not present in the sidebar, QuickDocs will display an error message on the input feedback display, as demonstrated in the diagram below.

deleterem failure
Figure 50. Invalid index provided to deleterem

4.5.8. Timing of notification: ntime [coming in v2.0]

Did you know that QuickDocs displays a pop-up notification for you when a reminder is approaching? You can adjust how long before the actual reminder start time to receive this notification using ntime.


Format: ntime t/TIME

Alias    : nt

ℹ️
TIME is specified in minutes.


Example:

  • ntime t/30

Receives pop-up notifications 30 minutes before the actual reminder start time.


4.5.9. Sending email reminders to patients: sendemail [coming in v2.0]

With QuickDoc’s reminder sidebar, you will never forget about your appointments - however your patients still might! To prevent this, sendemail allows you to send an auto-generated email reminder to patients regarding an approaching appointment date.


Format: sendemail d/DATE s/START

Alias    : se


Example:

  • sendemail d/2019-07-23 s/16:00

Sends an email to the patient allocated to the appointment on 23rd July 2019 at 4pm.


4.6. Administration and Statistics

The Administration and Statistics module feature commands that are related to any Administrative tasks such as setting the clinic’s consultation fee, and the Statistics command to get information about your clinic recorded through the use of QuickDocs.


4.6.1. Setting consultation fee: setconsultfee

This command allows you to change your consultation fee in QuickDocs to what you charge for each consultation. Setting up of your consultation fee is necessary for QuickDocs to generate accurate financial statistics pertaining to your consultation sessions. Once your consultation fee is set, QuickDocs will remember it for you. Hence, you only need to enter this command once, until you decide to change your consultation fee.

ℹ️
The default consultation fee in QuickDocs in S$30.00.


Format: setconsultfee AMOUNT

Alias    : setfee

Examples:

  • setconsultfee 30
    Sets the consultation fee to $30.00.

  • setconsultfee $32.50
    Sets the consultation fee to $32.50.


4.6.2. Viewing statistics: statistics

You are able to view the statistics of the clinic for a specific month, or between a range of months.
This command will show you 6 items in order:

  1. Number of consultations

  2. Most common medicines prescribed

  3. Most common symptoms diagnosed

  4. Revenue

  5. Expenditure

  6. Profit

ℹ️
In order for the calculated statistics pertaining to consultation finances to be accurate, you must have already entered your clinic’s consultation fee beforehand. See: Set consultation fee.
ℹ️
When there is a tie between the most commonly prescribed medicine, or most commonly diagnosed symptoms, all of them will be listed.


Format: statistics FROM_MMYYYY [TO_MMYYYY]

Alias    : stats

ℹ️
If TO_MMYYYY is not specified, it will be defaulted to be equal to FROM_MMYYYY.

Examples and Results:

  • statistics 012019
    View the statistics for January 2019.

  • stats 012019 042019
    View the statistics from January 2019 to April 2019.
    In the image below, the display area will return the statistics of the queried range of months.

    1. The result will show the range of months that were queried, followed by the 6 items mentioned earlier in order.

    2. When there are more than one most common symptom diagnosed, QuickDocs will list them all out.

statistics sample
Figure 51. Result example for command statistics 012019 042019

4.6.3. Generate prescription list [coming in v2.0]

The prescription list can be printed out for the pharmacists to expedite medicine preparation. The pharmacists can refer to the printed prescription list and prepare the medicines for the patient to collect after payment.


4.6.4. Generate medical certificate: [coming in v2.0]

You can print out a customised medical certificate for the patient, listing the symptoms and also the number of sick leave days.


4.6.5. Generate invoice: [coming in v2.0]

Generates the invoice for a given prescription. After selecting the patient, select the consultation to view in detail and then select the desired prescription.


5. Frequently Asked Questions (FAQ)

  1. How do I save the data after I add or change something?

    Saving is done automatically in QuickDocs. Whenever a command that adds, modifies, or deletes data is executed, the result of the execution is automatically saved. Hence, there is no need to save manually.


6. Command Summary

The Command Summary lists down all the possible commands that can be entered in QuickDocs. This section is meant to be a reference point for ease of search. The words in command format are the input to QuickDocs.

ℹ️
This is the summary of all the possible commands for QuickDocs. For detailed explanations of each command, you should head to Section 4, “Features”, or click on the links of each commands.

General Commands

Patient Management

Consultation Management

Medicine Management

Appointment and Reminders

Administration and Statistics