Update user guide with all features

README.md

@@ -1,12 +1,12 @@
 [![CI Status](https://github.com/AY2324S2-CS2103T-T08-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-T08-1/tp/actions)
 
-![Ui](docs/images/Ui.png)
+![Ui](docs/images/GUI.png)
 
-* **ImmuniMate** is a JavaFX application with a GUI, aimed at helping General Practitioners and Healthcare Professionals better keep track of Patient Information.<br>
+* **ImmuniMate** is a JavaFX application with a GUI, aimed at helping General Practitioners and Healthcare Professionals better keep track of patient Information.<br>
   Main Features:
-  * Easily add and update patient information to Immunimate
+  * Easily create patient profile and update patient information to ImmuniMate
   * Keep track of infected patients and clusters of information
   * Search for patients and patient history with a breeze
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
+* The name `ImmuniMate` is chosen to reflect its purpose of enhancing and safeguarding community immunity.
 * For the detailed documentation and information on ImmuniMate, please visit our  **[website](https://ay2324s2-cs2103t-t08-1.github.io/tp/)**.
 * This project is currently being developed by a student team in NUS. Our Source code for the project can be found **[here on github.](https://github.com/AY2324S2-CS2103T-T08-1/tp)**

docs/UserGuide.md

@@ -3,7 +3,7 @@ layout: page
 title: User Guide
 ---
 ## Introduction
-As government databases grow, information management might prove complex for civil servants, especially so for personal data. **ImmuniMate** offers a way to record comprehensive information about every contact, while ensuring timely updates and avoiding duplications/contradictions. It also seeks to establish links between contacts for speedier information retrieval.
+As communities grow, information management might prove complex for General Practitioner Clinics and other small-scale healthcare clinics, especially so for personal data. **ImmuniMate** offers a way to record comprehensive information about every patient, while ensuring timely updates and avoiding duplications/contradictions. It also seeks to establish links between patients for cluster tracking.
 
 * Table of Contents
 {:toc}
@@ -14,22 +14,22 @@ As government databases grow, information management might prove complex for civ
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
-1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
+1. Download the latest `immuniMate.jar` from [here](https://github.com/AY2324S2-CS2103T-T08-1/tp/releases).
 
-1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+1. Copy the file to the folder you want to use as the _home folder_ for your ImmuniMate.
 
-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
+1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar immuniMate.jar` command to run the application.<br>
    A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
-   ![Ui](images/Ui.png)
+   ![Ui](images/GUI.png)
 
 1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
    Some example commands you can try:
 
    * `list` : Lists all contacts.
 
-   * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
+   * `create ic/S0123456A n/John Doe hp/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 dob/1990-01-01 s/M st/PENDING` : Adds a patient named `John Doe` to ImmuniMate.
 
-   * `delete 3` : Deletes the 3rd contact shown in the current list.
+   * `delete S0123456A` : Deletes the patient of respective NRIC.
 
    * `clear` : Deletes all contacts.
 
@@ -46,16 +46,16 @@ As government databases grow, information management might prove complex for civ
 **:information_source: Notes about the command format:**<br>
 
 * Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
-  e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.
+  e.g. in `update <NRIC> <field>/CONTENT`, `CONTENT` is a parameter which can be used as `update S0123456A hp/87654321`.
 
-* Items in square brackets are optional.<br>
-  e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
+* Items in angle brackets are mandatory.<br> 
+  e.g. `ic/<NRIC>` must be given.
 
-* Items with `…`​ after them can be used multiple times including zero times.<br>
-  e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
+* Items in square brackets are optional.<br>
+  e.g. `ic/<NRIC> [e/EMAIL]` can be used as `ic/S0123456A e/[email protected]` or as `ic/S0123456A`.
 
 * Parameters can be in any order.<br>
-  e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+  e.g. if the command specifies `n/<Patient_Name> hp/<Phone_Number>`, `hp/<Phone_Number> n/<Patient_Name>` is also acceptable.
 
 * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
   e.g. if the command specifies `help 123`, it will be interpreted as `help`.
@@ -65,85 +65,165 @@ As government databases grow, information management might prove complex for civ
 
 ### Viewing help : `help`
 
-Shows a message explaning how to access the help page.
+Shows a message explaining how to access the help page.
 
-![help message](images/helpMessage.png)
+<img src="images/helpMessage.png" alt="help message" width="500"/>
 
 Format: `help`
 
 
-### Adding a person: `add`
-
-Adds a person to the address book.
+### Creating a patient profile: `create`
 
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
+Creates a patient profile in ImmuniMate. 
 
-<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
-A person can have any number of tags (including 0)
-</div>
+Format: `create ic/<NRIC> n/<Patient_Name> hp/<Phone_Number> a/<Address> dob/<Date_of_birth> s/<Sex> st/<Status> [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]`
 
 Examples:
-* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal`
+* `create ic/S1234567A n/John Doe hp/98765432 a/311, Clementi Ave 2, #02-25 dob/1990-01-01 s/M st/PENDING`
+* `create ic/S0123456A n/Jane Doe hp/87654321 a/311, Clementi Ave 2, #02-25 dob/01-01-1990 s/F st/PENDING e/[email protected] bt/A+`
 
-### Listing all persons : `list`
+### Listing all patients : `list`
 
-Shows a list of all persons in the address book.
+Shows a list of all patients in ImmuniMate.
 
 Format: `list`
 
-### Editing a person : `edit`
+### Read specific patients : `read`
+
+Shows corresponding patient profile.
+
+Format: `read <NRIC>`
 
-Edits an existing person in the address book.
+Examples:
+* `read S1234567A`
+
+### Updating a patient's profile : `update`
+
+Updates information of an existing patient profile in ImmuniMate.
 
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
+Format: `update <NRIC> <Field>/CONTENT`
 
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
-* At least one of the optional fields must be provided.
+* Edits the patient of corresponding NRIC. 
+* At least one of the fields must be provided.
 * Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
-    specifying any tags after it.
 
 Examples:
-*  `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-*  `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+*  `update S1234567A hp/91234567 e/jd123@example.com` Edits the phone number and email address of the corresponding patient to be `91234567` and `jd123@example.com` respectively.
+*  `update S0123456A a/123 Serangoon Road` Edits the address of the corresponding person to be `123 Serangoon Road`
 
-### Locating persons by name: `find`
+### Locating patients by name: `find`
 
-Finds persons whose names contain any of the given keywords.
+Finds patients whose name contain any of the given keywords.
 
-Format: `find KEYWORD [MORE_KEYWORDS]`
+Format: `find n/KEYWORD [MORE_KEYWORDS]`
 
 * The search is case-insensitive. e.g `hans` will match `Hans`
 * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
 * Only the name is searched.
 * Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
+* Patients matching at least one keyword will be returned (i.e. `OR` search).
   e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
 
 Examples:
-* `find John` returns `john` and `John Doe`
-* `find alex david` returns `Alex Yeoh`, `David Li`<br>
-  ![result for 'find alex david'](images/findAlexDavidResult.png)
+* `find n/John` returns `john` and `John Doe`
+* `find n/alex david` returns `Alex Yeoh`, `David Li`<br>
+  <img src="images/findAlexDavid.png" alt="result for 'find alex david'" width="800"/>
+
+
+### Locating patients by address: `find`
+
+Finds patients whose address contain any of the given keywords.
+
+Format: `find a/KEYWORD`
+
+* The search is case-insensitive. e.g `serangoon` will match `Serangoon`
+* The order of the keywords does matter. e.g. `Clementi Ave` will not match `Ave Clementi`
+* Only the address is searched.
+* Partial words will be matched e.g. `Clem` will match `Clementi`
+* Patients matching at least one keyword will be returned (i.e. `OR` search). 
+  e.g. `Clementi Serangoon` will return patients with address containing `Serangoon` or `Clementi`.
+
+Examples:
+* `find a/Geylang` returns `Alex Yeoh`
+* `find a/Serangoon` returns `Bernice Yu`, `David Li`<br>
+  <img src="images/findSerangoon.png" alt="result for 'find serangoon'" width="800"/>
+
+
+### Locating patients by condition: `find`
+
+Finds patients whose condition contain any of the given keywords.
+
+Format: `find con/KEYWORD`
+
+* The search is case-insensitive. e.g `covid` will match `Covid`
+* The order of the keywords does matter. e.g. `Stomach FLu` will not match `Flu Stomach`
+* Only the condition is searched.
+* Partial words will be matched e.g. `Cov` will match `Covid`
+* Patients matching at least one keyword will be returned (i.e. `OR` search).
+  e.g. `Covid Dengue` will return patients with address containing `Covid` or `Dengue`.
+
+Examples:
+* `find a/Covid` returns `Alex Yeoh`
+
+### Deleting a patient : `delete`
+
+Deletes the specified patient from ImmuniMate.
+
+Format: `delete <NRIC>`
+
+* Deletes the patient with corresponding NRIC.
+
+Examples:
+* `delete S1234567A` deletes patient uniquely identified by NRIC S1234567A.
+
+### Deleting information of a patient : `deleteinfo`
 
-### Deleting a person : `delete`
+Deletes specified optional information from the specified person from ImmuniMate.
 
-Deletes the specified person from the address book.
+Format: `deleteinfo <NRIC> <Field>`
 
-Format: `delete INDEX`
+* Deletes specified information of the patient with corresponding NRIC.
 
-* Deletes the person at the specified `INDEX`.
-* The index refers to the index number shown in the displayed person list.
-* The index **must be a positive integer** 1, 2, 3, …​
+Examples:
+* `deleteinfo S1234567A e/` deletes the email of patient uniquely identified by NRIC S1234567A.
+* `deleteinfo S0123456A e/ bt/ c/` deletes the email, blood type and country of nationality of patient uniquely identified by NRIC S0123456A.
+
+### Add patient's visit to history : `addvisit`
+
+Adds visit to patient history. 
+
+Format: `addvisit ic/<NRIC> dov/<Date_of_Visit> sym/<Symptoms> d/<Diagnosis> st/<Status>`
 
 Examples:
-* `list` followed by `delete 2` deletes the 2nd person in the address book.
-* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.
+* `addvisit ic/S1234567A dov/2024-01-01 sym/Cough d/Covid st/UNWELL` adds a visit to history of patient uniquely identified by NRIC S1234567A. During this visit on 2024-01-01, the patient had cough and was diagnosed with Covid.
+* `addvisit ic/S0123456A dov/2024-02-02 sym/Fever,Rashes d/Dengue st/PENDING` adds a visit to history of patient uniquely identified by NRIC S0123456A. During this visit on 2024-02-02, the patient had fever and rashes, and was diagnosed with Dengue.
+
+### Check patient history : `check`
+
+Checks all visits in patient history. 
+
+Format: `check <NRIC>`
+
+Example:
+* `check S1234567A`displays all visits in history of patient uniquely identified by NRIC S1234567A.
+
+### Find cluster : `cluster`
+
+Finds cluster in location specified. 
+
+Format: `cluster <Size_of_cluster> loc/<Location>`
+
+* The search is case-insensitive. e.g `serangoon` will match `Serangoon`
+* The order of the keywords in location does matter. e.g. `Clementi Ave` will not match `Ave Clementi`
+* Only the address is searched.
+* Partial words will be matched e.g. `Clem` will match `Clementi`
+
+Example: 
+* `cluster 3 loc/Serangoon` finds clusters of at least 3 patients exhibiting the same symptoms in the Serangoon vicinity. 
 
 ### Clearing all entries : `clear`
 
-Clears all entries from the address book.
+Clears all profiles from ImmuniMate.
 
 Format: `clear`
 
@@ -155,19 +235,23 @@ Format: `exit`
 
 ### Saving the data
 
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+ImmuniMate data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
 
 ### Editing the data file
 
-AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+ImmuniMate data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
 
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br>
-Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
+If your changes to the data file makes its format invalid, ImmuniMate will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br>
+Furthermore, certain edits can cause ImmuniMate to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
 </div>
 
 ### Archiving data files `[coming in v2.0]`
 
+### Update patient's visit in history `[coming in v2.0]`
+
+### Infection cluster tracking `[coming in v2.0]`
+
 _Details coming soon ..._
 
 --------------------------------------------------------------------------------------------------------------------
@@ -189,10 +273,36 @@ _Details coming soon ..._
 
 Action | Format, Examples
 --------|------------------
-**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
+**Create** | `create ic/<NRIC> n/<Patient_Name> hp/<Phone_Number> a/<Address> dob/<Date_of_birth> s/<Sex> st/<Status> [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]` <br> e.g., `create ic/S1234567A n/John Doe hp/98765432 a/311, Clementi Ave 2, #02-25 dob/1990-01-01 s/M st/PENDING`
+**Read** | `read <NRIC>` <br> e.g., `read S1234567A`
+**Update** | `update <NRIC> <Field>/CONTENT` <br> e.g., `update S1234567A hp/91234567 e/[email protected]`
+**Find** | `find n/KEYWORD` <br> e.g., `find n/Alex` <br> `find a/KEYWORD` <br> e.g., `find a/Serangoon` <br> `find con/KEYWORD` <br> e.g., `find con/Covid`
+**Delete** | `delete <NRIC>`<br> e.g., `delete S1234567A`
+**Delete Information** | `deleteinfo <NRIC> <Field>` <br> e.g., `deleteinfo S1234567A e/`
+**Add Visit** | `addvisit ic/<NRIC> dov/<Date_of_Visit> sym/<Symptoms> d/<Diagnosis> st/<Status>` <br> e.g., `addvisit ic/S1234567A dov/2024-01-01 sym/Cough d/Covid st/UNWELL`
+**Check** | `check <NRIC>` <br> e.g., `check S1234567A`
+**Find Cluster** | `findcluster loc/<Location>` <br> e.g. `findcluster loc/Serangoon`
 **Clear** | `clear`
-**Delete** | `delete INDEX`<br> e.g., `delete 3`
-**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
-**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
 **List** | `list`
 **Help** | `help`
+**Exit** | `exit`
+
+## Field summary 
+Field | Prefix 
+--------|------------------
+**Name** | `n/`
+**NRIC** | `ic/`
+**Phone Number** | `hp/`
+**Address** | `a/`
+**Date of birth** | `dob/`
+**Sex** | `s/`
+**Status** | `st/`
+**Email** | `e/`
+**Country of nationality** | `c/`
+**Date of admission** | `doa/`
+**Blood type** | `bt/`
+**Allergies** | `al/`
+**Condition** | `con/`
+**Symptom** | `sym/`
+**Diagnosis** | `d/`
+