From 0ea165604ca40e342c81f339ee352cdd78540062 Mon Sep 17 00:00:00 2001 From: Kyler Wong Date: Mon, 25 Mar 2019 20:26:24 +0800 Subject: [PATCH 1/4] Updated record related methods information --- docs/UserGuide.adoc | 82 +++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 47 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 3fe27542093e..a3d5c803f274 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -300,78 +300,66 @@ the current patient list with a copy tag. === Patient Records Management ==== record add -Adds a new dental record for the patient. +* Adds a new dental record to the patient. -Format: `record add n/NRIC d/DATE_DDMMYYYY t/TIME_HHMM p/PROCEDURE -doc/SERVING_DENTIST det/DETAILS` +* Record contains the patient's personal information, name of the dentist on duty, the date of the record, and the description of the dental treatment the patient has went through during that session. -Example -* `record add n/S1234567H d/10022019 t/1705 p/Cleaning doc/Kyler det/Mouth -was noticeably smelly, might have halitosis` - -==== record delete +* Note: `recordadd` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. -Format: `record delete n/NRIC INDEX` +Format: `recordadd desc/DETAILS` -* Deletes the patient’s dental record at the specified index. +* The program assigns the name of the dentist stored in the dentist information -* The index refers to the index number shown in the displayed dental -record list. +* The program assigns the date of record as the date the record is created. -* The given index must be a positive integer (e.g 1, 2 or 3…) - -Examples: +* When records of a patient is accessed, the stored records are sorted from newest to oldest. -* `<> dental Jon` + -`record delete n/NRIC 1` + -Deletes the 1st record from the displayed list +* New dental records will appear on the top of the list upon entry. +Example +* `goto 1` - Displays dental records of the first patient in the list and hides the patient list. +* `recordadd desc/Mouth was noticeably smelly, might have halitosis` - Adds a new dental record. +* `back` - Go back to the patient list. -==== record edit -Edits a patient’s dental record. +==== record delete -Format: `record edit n/NRIC INDEX` +* Deletes a dental record of a specified patient. +* Note: `recorddelete` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. -* Goes into record edit mode for the specified patient at the specified -index shown from list or find command. Must be a positive integer (e.g -1, 2 or 3). +Format: `recorddelete INDEX` -* Input the field followed by the new value to replace the existing data. +* Deletes the patient’s dental record at the specified index. -* Multiple fields can be edited in a single input or across multiple -inputs. +* The index refers to the index number shown in the displayed dental record list. -* When editing tags, the existing tags of the patient will be removed i.e -adding of tags is not cumulative. +* The given index must be a positive integer (e.g 1, 2 or 3…) -* All tags can be removed by keying in t/ without specifying any tags -following it. +Example: +* `goto 1` - Displays dental records of the first patient in the list and hides the patient list. +* `recorddelete 1` - Delete the latest dental record of the specified patient +* `back` - Go back to the patient list. -* Exit the edit mode by entering "done". +==== record edit -Example: +* Edits a patient’s dental record. -* `<> dental n/Jon + -record edit n/S1234567H 1 + -doc/Debang + -det/new details + -done` + -Edits the first dental record under the patient Jon and replaces the old -doctor and detail fields with the new Debang and new details data. +* Note: `recordedit` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. -==== record copy -Makes an exact copy of a patient’s dental record. +Format: `recordedit INDEX desc/DETAILS` -Format: `record copy n/NRIC INDEX` +* Edits the patient's dental record at the specified index. -Example: +* The index refers to the index number shown in the displayed dental record list. +* The given index must be a positive integer (e.g 1, 2 or 3…) -* `record copy n/S1234567H 2` + -Makes a copy of the patient’s dental record at index 2 and inserts it at -the bottom of the current dental records with a copy tag. +* The new description stated in the command will replace the old description in the specified dental record. +Example: +* `goto 1` - Displays dental records of the first patient in the list and hides the patient list. +* `recordedit 1 desc/corrected description` - Modifies the description of the first dental record of the specified patient. +* `back` - Go back to the patient list. === Teeth Management From 7b6813a9c29ed91891752e138e1c923389e1482d Mon Sep 17 00:00:00 2001 From: Kyler Wong Date: Mon, 25 Mar 2019 20:45:28 +0800 Subject: [PATCH 2/4] Updated the teeth system information --- docs/UserGuide.adoc | 92 ++++++++++++++++----------------------------- 1 file changed, 32 insertions(+), 60 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index a3d5c803f274..8c7004ad26c6 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -173,21 +173,21 @@ Writes all entries from the address book to patients1.json. + Adds a patient to the patients list. -Format: `add PARAMETERS [t/TAG] …` +Name, NRIC, and Date of Birth fields are compulsory. The rest are optional fields. + +Format: `add PARAMETERS …` Parameters: [cols=",",options=""] |=== -|Tag |Example |n/NAME |n/Keith Choo Shen Hao |s/SEX |s/Male |p/PHONE_NUMBER |p/98765432 |e/EMAIL |e/KeithCSH@debang.com |a/ADDRESS |a/1 Pulau Tekong Besar 508449 |ic/NRIC |ic/S1234567Z -|age/AGE |age/25 -|dob/DATE_OF_BIRTH_DDMMYYYY |dob/28061994 +|dob/DATE_OF_BIRTH_DD-MM-YYYY |dob/28-06-1994 |da/DRUG_ALLERGY |da/Insulin |nokn/NEXT_OF_KIN_NAME |nokn/Choo Debang |nokp/NEXT_OF_KIN_PHONE_NUMBER |nokp/97654321 @@ -195,35 +195,26 @@ Parameters: |noka/NEXT_OF_KIN_ADDRESS |noka/21 Lower Kent Ridge Rd 119077 |=== - -A patient can have any number of tags. - -Note: If a patient’s next of kin lives at the same address, use `same` to -indicate that. +Note: If a patient’s next of kin lives at the same address, use `same` to indicate that. Examples: - * `add n/John Choo p/98425871 e/jonC@example.com a/IDA street block 13 #02-05 ic/S1234567H age/32 dob/26021987 nokn/Jacky Choo nokp/84875215 nokr/Father noka/same` - ==== delete - Deletes the specified patient from the patients list. Format: delete INDEX - * Deletes the patient at the specified index. * The index refers to the index number shown in the displayed patient list. * The given index must be a positive integer (e.g 1, 2 or 3…). - Examples: * `delete 1` + @@ -233,15 +224,12 @@ Deletes the patient shown with index 1 from the displayed list. `delete 2` + Deletes the patient shown with index 2 found using the find command. - ==== edit - Edits data from an existing patient. Format: `edit INDEX` - * Goes into edit mode for the patient at the specified index shown from list or find command. Must be a positive integer (e.g 1, 2 or 3). @@ -276,7 +264,6 @@ Edits the phone number and email of the first patient listed to become Edits the phone number and email of the first patient listed to become 987654 and mymail@gmail.com respectively with a single input. - ==== copy Makes an exact copy of a patient and adds them to the patient list. @@ -298,13 +285,14 @@ Makes 4 copies of the patient at index 3 and inserts them at the bottom of the current patient list with a copy tag. === Patient Records Management + ==== record add -* Adds a new dental record to the patient. +Adds a new dental record to the patient. -* Record contains the patient's personal information, name of the dentist on duty, the date of the record, and the description of the dental treatment the patient has went through during that session. +Record contains the patient's personal information, name of the dentist on duty, the date of the record, and the description of the dental treatment the patient has went through during that session. -* Note: `recordadd` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. +Note: `recordadd` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. Format: `recordadd desc/DETAILS` @@ -317,15 +305,18 @@ Format: `recordadd desc/DETAILS` * New dental records will appear on the top of the list upon entry. Example + * `goto 1` - Displays dental records of the first patient in the list and hides the patient list. + * `recordadd desc/Mouth was noticeably smelly, might have halitosis` - Adds a new dental record. + * `back` - Go back to the patient list. ==== record delete -* Deletes a dental record of a specified patient. +Deletes a dental record of a specified patient. -* Note: `recorddelete` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. +Note: `recorddelete` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. Format: `recorddelete INDEX` @@ -336,15 +327,18 @@ Format: `recorddelete INDEX` * The given index must be a positive integer (e.g 1, 2 or 3…) Example: + * `goto 1` - Displays dental records of the first patient in the list and hides the patient list. + * `recorddelete 1` - Delete the latest dental record of the specified patient + * `back` - Go back to the patient list. ==== record edit -* Edits a patient’s dental record. +Edits a patient’s dental record. -* Note: `recordedit` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. +Note: `recordedit` requires the program to first be in `goto` mode, where a patient is specified for his or her dental information to be modified. Format: `recordedit INDEX desc/DETAILS` @@ -357,19 +351,18 @@ Format: `recordedit INDEX desc/DETAILS` * The new description stated in the command will replace the old description in the specified dental record. Example: + * `goto 1` - Displays dental records of the first patient in the list and hides the patient list. + * `recordedit 1 desc/corrected description` - Modifies the description of the first dental record of the specified patient. + * `back` - Go back to the patient list. === Teeth Management ==== Brief Description - -TeethHub complies with the most popular standard of the -three the Dental Numbering Systems utilised in Dentistry - The -Universal Numbering System. - +TeethHub complies with the most popular standard of the three the Dental Numbering Systems utilised in Dentistry - The Universal Numbering System. ==== The Universal Numbering System @@ -385,40 +378,29 @@ mandibular left third molar, designated number 17, and continues along the bottom teeth to the right side. Each tooth has a unique number or letter, allowing for easier use on keyboards. - ==== Creating and Editing Teeth Layout -There are two templates provided by TeethHub: primary and -permanent. -All primary or permanent teeth in template will all be present and -healthy by default. +There is one template provided by TeethHub: permanent teeth. +All permanent teeth in template will all be present and healthy by default. * To create a new teeth layout for patient: -** `teeth add n/NRIC