from a475cada78fb7d8f3edd411b91ac7a43035f63a4

msupply-foundation · Oct 2, 2024 · bd97f2e · bd97f2e
1 parent 9230bf2
commit bd97f2e
Show file tree

Hide file tree

Showing 29 changed files with 258 additions and 99 deletions.
diff --git a/content/docs/dispensary/encounters.md b/content/docs/dispensary/encounters.md
@@ -0,0 +1,22 @@
++++
+title = "Encounters"
+description = "Manage encounters (visits) with patients"
+date = 2024-09-30T18:20:00+00:00
+updated = 2024-09-30T18:20:00+00:00
+draft = false
+weight = 3
+sort_by = "weight"
+template = "docs/page.html"
+
+[extra]
+toc = true
+top = false
++++
+
+Encounters are the visits that patients make to your dispensary, under a specific Patient Program.
+
+You will only see this tab under the `Dispensary` menu if you have Patient Programs configured.
+
+![Encounter Navigation](/docs/programs/images/dispensary_gotoencounters.png)
+
+Learn more about Encounters in the [Patient Programs](/docs/programs/program-module/#encounter) documentation.
diff --git a/content/docs/dispensary/patients.md b/content/docs/dispensary/patients.md
@@ -98,3 +98,5 @@ Then click the `Create` button at the bottom right of the page to create the pat
 ### Edit a Patient
 
 To edit a patient, click on the patient's name in the list of patients.
+
+If there is more data in your Patient view, it's likely due to Patient Programs being configured. You can find out more in the [Patient Programs](/docs/programs/program-module) documentation.
diff --git a/content/docs/introduction/requirements.md b/content/docs/introduction/requirements.md
@@ -167,6 +167,7 @@ The table below shows which versions of mSupply and Open mSupply Central you wil
 | 2.0.00+             | 7.14.04+        | 2.0.00+              |
 | 2.1.00+             | 7.14.04+        | 2.1.00+              |
 | 2.2.00+             | 7.14.04+        | 2.2.00+              |
+| 2.3.00+             | 7.17.01+        | 2.3.00+              |
 
 If you attempt to connect to an incompatible server you'll get an error message like this:
 

diff --git a/content/docs/programs/images/edit_vaccination.png b/content/docs/programs/images/edit_vaccination.png
diff --git a/content/docs/programs/images/encounter_new_vaccination.png b/content/docs/programs/images/encounter_new_vaccination.png
diff --git a/content/docs/programs/images/encounter_vax_card.png b/content/docs/programs/images/encounter_vax_card.png
diff --git a/content/docs/programs/images/immunizations.png b/content/docs/programs/images/immunizations.png
diff --git a/content/docs/programs/images/immunizations_detail.png b/content/docs/programs/images/immunizations_detail.png
diff --git a/content/docs/programs/images/og_immunisation_program.png b/content/docs/programs/images/og_immunisation_program.png
diff --git a/content/docs/programs/images/past_vaccination_switch.png b/content/docs/programs/images/past_vaccination_switch.png
diff --git a/content/docs/programs/images/past_vaccination_switch_on.png b/content/docs/programs/images/past_vaccination_switch_on.png
diff --git a/content/docs/programs/images/patient_vaccinations_tab.png b/content/docs/programs/images/patient_vaccinations_tab.png
diff --git a/content/docs/programs/images/save_vaccination.png b/content/docs/programs/images/save_vaccination.png
diff --git a/content/docs/programs/images/vaccination_edit.png b/content/docs/programs/images/vaccination_edit.png
diff --git a/content/docs/programs/images/vaccination_given_batch_select.png b/content/docs/programs/images/vaccination_given_batch_select.png
diff --git a/content/docs/programs/images/vaccination_given_other_facility.png b/content/docs/programs/images/vaccination_given_other_facility.png
diff --git a/content/docs/programs/images/vaccination_not_given_reason.png b/content/docs/programs/images/vaccination_not_given_reason.png
diff --git a/content/docs/programs/images/vaccination_other_facility.png b/content/docs/programs/images/vaccination_other_facility.png
diff --git a/content/docs/programs/images/vaccination_revert_transaction.png b/content/docs/programs/images/vaccination_revert_transaction.png
diff --git a/content/docs/programs/images/vaccination_update_transactions.png b/content/docs/programs/images/vaccination_update_transactions.png
diff --git a/content/docs/programs/images/vaccination_view_prescription.png b/content/docs/programs/images/vaccination_view_prescription.png
diff --git a/content/docs/programs/images/vaccine_course_add.png b/content/docs/programs/images/vaccine_course_add.png
diff --git a/content/docs/programs/images/vaccine_course_add_button.png b/content/docs/programs/images/vaccine_course_add_button.png
diff --git a/content/docs/programs/images/vaccine_course_detail.png b/content/docs/programs/images/vaccine_course_detail.png
diff --git a/content/docs/programs/images/vaccine_course_dose_edit.png b/content/docs/programs/images/vaccine_course_dose_edit.png
diff --git a/content/docs/programs/images/vaccine_courses_select.png b/content/docs/programs/images/vaccine_courses_select.png
diff --git a/content/docs/programs/images/vax_card_view.png b/content/docs/programs/images/vax_card_view.png
diff --git a/content/docs/programs/immunizations.md b/content/docs/programs/immunizations.md
@@ -13,7 +13,22 @@ toc = true
 top = false
 +++
 
-Note: Immunization programs are only visible on the [Open mSupply Central Server](/docs/getting_started/central).
+## Setup
+
+Base Immunization Programs are configured in the mSupply central server.
+
+For GAPS functionality, you will only need to configure a new Master List, and mark it as an Immunization Program.
+
+<div align="center">
+    <img src="/docs/programs/images/og_immunisation_program.png" width="620">
+</div>
+<br />
+
+For Immunization [Patient Programs](/docs/programs/program-module), contact your administrator to get set up.
+
+Once the base Immunization Program is created, it can be further configured in the <a href='/docs/getting_started/central'>Open mSupply Central Server<a>. See the <a href="#permissions-restrictions">Permissions & Restrictions</a> section for more details.
+
+## Viewing Immunization Programs
 
 Choose `Programs` > `Immunizations` in the navigation panel.
 
@@ -30,40 +45,6 @@ The list of Immunization Programs is divided into 2 columns:
 | **Program Name**    | The name of the Immunization Program                             |
 | **Vaccine Courses** | The Vaccine Courses that are a part of that Immunization Program |
 
-## Adding a new Immunization Program
-
-To add a new Immunization Program, click the `New Program` button in the top right.
-
-![immunizations: new program button](/docs/programs/images/immunizations_new_program_button.png)
-
-This will open a new window, where you can enter the name of the new Immunization Program. Note that all programs must have a unique name.
-
-![immunizations: new program modal](/docs/programs/images/immunizations_new_program_modal.png)
-
-- Click `OK` once you are happy with your changes
-  - You will be redirected to the detail view for your new Immunization Program
-- OR: Click `Cancel` to close the window if you've changed your mind
-
-## Deleting an Immunization Program
-
-You can delete Immunization Programs from the list view.
-
-Select the Immunization Program that you wish to delete by checking the box on the right end of the list. You can select more than one Immunization Program to be deleted at once. You can even select them all using the master checkbox in the table header.
-
-![immunizations: select to delete](/docs/programs/images/immunizations_select.png)
-
-Open the `Actions` dropdown in the top right corner, above the list, and select `Delete selected lines`.
-
-![immunizations: actions](/docs/programs/images/immunizations_actions.png)
-
-You will be asked to confirm that you wish to delete the selected programs. Press `Cancel` to prevent deleting, or `Ok` to confirm.
-
-![immunizations: confirm delete](/docs/programs/images/immunizations_confirm_delete.png)
-
-A notification in the bottom left corner will confirm how many programs were deleted.
-
-![immunizations: delete success](/docs/programs/images/immunizations_delete_success.png)
-
 ## Viewing Immunization Program Details
 
 To view an Immunization Program in more detail, click on it. This will take you to the detail page for that program.
@@ -72,10 +53,6 @@ To view an Immunization Program in more detail, click on it. This will take you
 
 You can use the `Close` button in the bottom right to close the detail view, and go back to the list of Immunization Programs.
 
-If you need to edit the name of the Immunization Program, do so by updating the input field at the top of the detail screen.
-
-Once you are happy with your changes, use the `Save` button in the bottom right to save them.
-
 ### Vaccine Courses
 
 The Immunization Program detail view presents you with a list of Vaccine Courses that are a part of the program.
@@ -94,13 +71,40 @@ To add a new Vaccine Course, click the `Add vaccine course` button in the top ri
 
 ![vaccine course: add button](/docs/programs/images/vaccine_course_add_button.png)
 
-This will open a new window, where you can enter the name of the new Vaccine Course.
+This will open a new window, where you can enter the details of the new Vaccine Course, e.g. Vaccine course name, wastage rate, dose schedule.
 
 ![vaccine course: create modal](/docs/programs/images/vaccine_course_add.png)
 
-- Click `OK` once you are happy with your changes
-  - You will be redirected to the detail view of your newly created Vaccine Course
-- OR: Click `Cancel` to close the window if you've changed your mind
+#### Doses
+
+To add doses to the Vaccine Course, click the `(+) Dose` button. This will add a new row to the `dose schedule` table, where the details of the dose can be entered, including when the dose can administered.
+
+![vaccine course: dose edit table](/docs/programs/images/vaccine_course_dose_edit.png)
+
+The Dose Schedule table is divided into 6 columns:
+
+| Column                  | Description                                                                                                              |
+| :---------------------- | :----------------------------------------------------------------------------------------------------------------------- |
+| **Dose #**              | The number of the dose in the schedule                                                                                   |
+| **Label**               | The label of the dose, to appear in the [Vaccination Card](/docs/programs/program-module#vaccination-cards)              |
+| **From age**            | Minimum recommended age to receive the dose (in years and months)                                                        |
+| **To age**              | Maximum recommended age to receive the dose (in years and months)                                                        |
+| **Custom age label**    | Custom age label to be displayed in the Vaccination Card. If not defined, the default is the `From age` (e.g. `6 years`) |
+| **Min interval (days)** | Minimum number of days before the patient should receive the next dose                                                   |
+
+<div class="note">
+  If custom age labels are used, ensure that label is the same across all doses in the Immunization Program with the same <code>From age</code>. For example, if you want to replace "0 months" with "Birth", all doses across all Vaccine Courses with a <code>From age</code> of 0 months will need the custom age label of "Birth". This ensures correct grouping of doses in the Vaccination Card.
+</div>
+
+Once you are happy with the Vaccine Course details, click OK to save the new Vaccine Course.
+
+Click `Cancel` at any time to close the window and discard your changes.
+
+### Editing a Vaccine Course
+
+To view or edit the details of a Vaccine Course, click on the row in the list. This will re-open the editing window, for you to view or change any details.
+
+![vaccine course: edit modal](/docs/programs/images/vaccine_course_detail.png)
 
 ### Deleting a Vaccine Course
 
@@ -120,24 +124,12 @@ You will be asked to confirm that you wish to delete the selected Vaccine Course
 
 A notification in the bottom left corner will confirm how many courses were deleted.
 
-## Viewing Vaccine Course Details
-
-To view a Vaccine Course in more detail, click on it. This will take you to the detail page for that course.
-
-![vaccine course: detail](/docs/programs/images/vaccine_course_detail.png)
-
-You can use the `Close` button in the bottom right to close the detail view, and go back to the list of Vaccine Courses within this Immunization Program.
-
-From this view, you can edit all the relevant information for the Vaccine Course, including its name, details like its wastage rate, and the number of doses.
-
-Once you are happy with your changes, you can use the `Save` button in the bottom right to save them.
-
 ## Permissions & Restrictions
 
-Immunization Programs are only visible on the [Open mSupply Central Server](/docs/getting_started/central) and requires the [`mobile: Uses vaccine module`](https://docs.msupply.org.nz/cold_chain_equipment:mobile?s[]=vaccine#enable_the_vaccine_module_for_the_mobile_store) store preference.
+Immunization Programs can only be managed on the [Open mSupply Central Server](/docs/getting_started/central) and requires the [`mobile: Uses vaccine module`](https://docs.msupply.org.nz/cold_chain_equipment:mobile?s[]=vaccine#enable_the_vaccine_module_for_the_mobile_store) store preference.
 
 ![mSupply Store Preference Vaccine Module](/docs/programs/images/vaccine_module.png)
 
-To Create, Edit or Delete Immunization Programs or Vaccine Courses you need the `Can modify central data` permission, enabled in the [omSupply Permissions Tab](https://docs.msupply.org.nz/admin:managing_users?s[]=permission#omsupply_permissions_tab) on your Central Store.
+To configure Immunization Programs or Vaccine Courses, you need the `Can modify central data` permission enabled in the [Open mSupply Permissions Tab](https://docs.msupply.org.nz/admin:managing_users?s[]=permission#open_msupply_permissions_tab) on your Central Store.
 
 ![Can Modify Central Data Permission](/docs/programs/images/can_modify_central.png)