Merge branch 'Build7' Fixed #19, Fixed #5

Author: innershell

README.md

@@ -1,34 +1,35 @@
 # Triage Algorithm
     Contributors: innershell
-    Tags: triage, form, forms, custom form, form builder, survey, survey builder, questionnaire, questionnaire builder, quiz, quiz builder, exam, exam builder, test, test builder, planner, planning, screening
+    Tags: triage, form, forms, custom form, form builder, questionnaire, questionnaire builder, screening
     Requires at least: 5.0
     Tested up to: 5.2.2
     Requires PHP: 7.2
     Stable tag: trunk
     License: GPL2 or later
 
-Create a triage algorithm that pre-screen a patient and generate a physician SOAP note for clinical decision support.
+Create a triage algorithm that pre-screens a patient and generate a physician SOAP note for clinical decision support.
 
 # Description
-Design algorithms to screen and triage patients with chronic diseases at a medical facility. Questions are presented to the patient to gather information for their visit. The collected information are analyzed by the algorithm and presented to a clinician in the form of a medical assessment and/or treatment plan.
-
-**To publish a triage algorithm, place its shortcode in a post or page.**
+Design topics to screen and triage patients with chronic diseases. A series of questions for a topic is presented to the patient to gather information for their medical condition. The collected information is analyzed by the system and presented to a clinician in the form of a medical assessment and/or treatment plan.
 
 # Features
-#### Create algorithms to ask questions
-- An unlimited number of algorithms and questions are supported.
+#### Create topics to ask a series of questions.
+- An unlimited number of topics and questions are supported.
 
-#### Present questions in multiple formats
-- Generate user input forms by presenting single choice (radio buttons), multiple choice (checkboxes), single free text (textarea), or multiple free text (textarea) answers.
+#### Present questions in multiple formats.
+- Generate user input forms by presenting single choice (radio buttons), multiple choice (checkboxes), free text (textarea), and date answers.
 
-#### Decision tree modifies the algorithm in real-time
-- Define how the algorithm reacts based on intput to the question. Different paths are selected based on input received.
+#### Decision tree modifies the questionnaire in real-time
+- Define how the system reacts based on answers selected by the user. Different paths are selected based on user input.
 
 #### Analyze answers for clinical decision support
-- This is where the real magic happens. The algorithm processes answers for presentation to medical professionals in a clinical language and format. Provide the medical professional with an assessment of the patient and treatment plan for the patient.
+- This is where the real magic happens. The system processes answers for presentation to medical professionals in a clinical language and format. Provides the medical professional with an assessment of the patient's condition and personalized treatment plan for the patient.
+
+#### Points-based subsystem for scoring a questionnaire.
+- Assign points to answers and allow the system to calculate the final score of the questionnaire.
 
-#### Display dashboard of algorithm submissions
-- Present all submissions in a summary dashboard for presenter to review and provide feedback.
+#### Display dashboard of user submissions
+- Present all submissions in a summary dashboard for providers to review and provide feedback.
 
 #### Export submission data to a CSV file
 - Extract raw data into an external file for a variety of offline uses.
@@ -39,39 +40,42 @@ Design algorithms to screen and triage patients with chronic diseases at a medic
 2. Activate the plugin.
 3. Go to "Triage Algorithm" settings to manage the plugin and setup algorithms.
 4. Place the shortcode(s) in a post or page to publish the features.
-5. View the post or page to see the triage algorithm in action.
+5. View the post or page to see the system in action.
 
 **Attention Multi-Site (WP Network) Users!** 
 - The plugin is perfectly compatible with multi-site installations but it should be activated as **blog admin** and NOT as superadmin.
 
 # Upgrading
 1. Backup your data.
 2. Deactivate the plugin.
-3. Delete the plugin (Note: Your data will NOT be deleted);
+3. Delete the plugin (Note: Your data will **NOT** be deleted **UNLESS** you set it in the options.);
 4. Follow the installation steps above to install the new plugin.
-5. Make sure to activate the pluging.
+5. Make sure to activate the plugin.
 
 # Getting Started
-Once activated the plugin go to Triage Algorithm -> Algorithms in your WP dashboard and create your first algorithm. After entering the algorithm title, description and other settings you will be redirected to create the algorithm results / outcomes.
+Navigate to `Orchestra -> Configure Topics` in your WordPress dashboard and create your first topic. After giving the topic a title, description and other settings, you will be redirected to create the topic results / outcomes.
 
-Creating results is optional but very powerful because you can present completely different content to the user depending on what path they took through the algorithm. You can use the result description box for this result-dependent content or even redirect to another page.
+Creating results is optional, but very powerful, because you can present completely different content to the user depending on what path they took through the questionnaire. You can use the result description box for this result-dependent content or even redirect to another page.
 
-After you create your results you will be redirected to creating the actual questions in the algorithm. The answer to each question has an action which defines what happens if the user selects it: they can go to the next question, to a specific selected question (this is where the chaining magic happens), or to finalize the algorithm. 
+After you create your results you will be redirected to creating the actual questions in the algorithm. The answer to each question has an action which defines what happens if the user selects it: 
+- Go to the next question
+- Go to a specific selected question (this is where the chaining magic happens)
+- Finalize the algorithm. 
 
-Don't forget that the algorithm must be **published** before it becomes accessible. Publishing happens when you manually place the shortcode of the algorithm in a post or page or select the option "Automatically publish" when you save it.
+Don't forget that the algorithm must be **published** before it becomes accessible. Publishing happens when you manually place the shortcode of the topic in a post or page or select the option "Automatically publish" when you save it.
 
 # Frequently Asked Questions
-None yet.
-
-# Screenshots
-1. Creating a triage algorithm question.
-2. How the triage algorithm is displayed.
-3. The SOAP note processed by the triage algorithm for clinical decision support.
-4. The submissions dashboard to capture feedback for machine learning.
+See the online help in your WordPress dashboard.
 
 # Changelog
 ## 6.0 (Abort Algorithm)
-- Bug fixes.
+- Renamed 'Algorithms' to 'Topics' as algorithms sounded more technical and complex than necessary.
+- Questions can prematurely *abort* a topic when accumulated points are within the abort range. Multiple abort points per topic can be setup.
+- New *Patient Note* field to setup personalized notes for a patient for each answer selected.
+- New `{{patient-note}}` injection code to insert patient notes in the patient output or provider output.
+- Ability to delete all plugin data when uninstalling the plugin.  
+- User interface improvements.
+- Fixed various backend errors that did not affect frontend user functionality.
 
 ## 5.1 (Show Answers on Questions Page)
 - Show/hide answers in the questions listing page (admin only).