+ If custom age labels are used, ensure that label is the same across all doses in the Immunization Program with the same From age. For example, if you want to replace "0 months" with "Birth", all doses across all Vaccine Courses with a From age of 0 months will need the custom age label of "Birth". This ensures correct grouping of doses in the Vaccination Card.
+
+
+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.
+
+
### 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.
-
-
-
-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.
-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.
diff --git a/content/docs/programs/program_module.md b/content/docs/programs/program_module.md
index 9d85893..2808858 100644
--- a/content/docs/programs/program_module.md
+++ b/content/docs/programs/program_module.md
@@ -33,13 +33,13 @@ You will also need to enable the user permissions shown below on the central ser
### Patients List
-A new column named `Program Enrolments` will be added to the patient list to show the programs that the patient is enrolled in if the patient programs module has been enabled.
+A new column named `Program Enrolments` will be added to the patient list to show the programs that the patient is enrolled in if the patient programs module has been enabled.
#### Viewing a Patient
-There are four tabs on the patient detail page:
+There are five tabs on the patient detail page:
1. **Patient Details**: This tab contains the patient details.
@@ -47,19 +47,23 @@ The patient detail page will look very different from the standard patient detai
+There is also a `History` button on the bottom left corner of the patient detail page. Clicking on this button will show you a simple history of changes made to the patient record.
+
+
+
2. **Programs**: This tab contains the programs that the patient is enrolled in.
Clicking on a program will take you to the patient's program enrolment details. See [Program Enrolment](/docs/programs/program-module/#program) for more information.
-This program tab will display 5 columns:
+This program tab will display 5 columns:
-| Column | Description |
-| :---------- | :---------------------------------- |
-| **Program** | The name of the program |
-| **Enrolment Patient ID** | The patient's program ID |
-| **Additional Info** | Displays program specific information. E.g. _LTFU_ lost to follow up |
-| **Program Status** | The status of the program |
-| **Enrolment Date** | The date the patient was enrolled in the program |
+| Column | Description |
+| :----------------------- | :------------------------------------------------------------------- |
+| **Program** | The name of the program |
+| **Enrolment Patient ID** | The patient's program ID |
+| **Additional Info** | Displays program specific information. E.g. _LTFU_ lost to follow up |
+| **Program Status** | The status of the program |
+| **Enrolment Date** | The date the patient was enrolled in the program |
@@ -69,13 +73,13 @@ Clicking on an encounter will take you to the encounter details. See [Encounter]
This encounters tab will display 6 columns:
-| Column | Description |
-| :---------- | :---------------------------------- |
-| **Type** | The encounter type |
-| **Program** | The program the encounter is associated with |
-| **Date** | The date of the encounter appointment |
-| **Start** | The start time of the encounter appointment |
-| **End** | The end time of the encounter appointment |
+| Column | Description |
+| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **Type** | The encounter type |
+| **Program** | The program the encounter is associated with |
+| **Date** | The date of the encounter appointment |
+| **Start** | The start time of the encounter appointment |
+| **End** | The end time of the encounter appointment |
| **Additional Info** | Displays additional information about the encounter. E.g. _Encounter Scheduled_ means that the appointment for this encounter has been scheduled. |
@@ -86,21 +90,32 @@ Clicking on a contact will take you to the contact details. See [Contact Tracing
This contact tracing tab will display 7 columns:
-| Column | Description |
-| :---------- | :---------------------------------- |
-| **Program** | The name of the program this contact is associated with |
-| **Date Created** | The date the contact was created |
-| **First name** | First name of the contact |
-| **Last name** | Last name of the contact |
-| **Gender** | Gender of the contact |
-| **Relationship** | The relationship of the contact to the patient |
-| **Age** | The age of the contact |
+| Column | Description |
+| :--------------- | :------------------------------------------------------ |
+| **Program** | The name of the program this contact is associated with |
+| **Date Created** | The date the contact was created |
+| **First name** | First name of the contact |
+| **Last name** | Last name of the contact |
+| **Gender** | Gender of the contact |
+| **Relationship** | The relationship of the contact to the patient |
+| **Age** | The age of the contact |
-There is also a `History` button on the bottom left corner of the patient detail page. Clicking on this button will show you a simple history of changes made to the patient record.
+5. **Vaccinations**: This tab contains the list of Immunization Programs that the patient is enrolled in.
-
+Clicking on an Immunization Program will take you to the patient's Vaccination Card for that program. See [Vaccination Cards](/docs/programs/program-module/#vaccination-cards) for more information.
+
+This Vaccinations tab will display 4 columns:
+
+| Column | Description |
+| :----------------------- | :----------------------------------------------- |
+| **Program** | The name of the program |
+| **Enrolment Patient ID** | The patient's program ID |
+| **Program Status** | The status of the program |
+| **Enrolment Date** | The date the patient was enrolled in the program |
+
+
### Program
@@ -108,13 +123,13 @@ Patients can be enrolled in a program that is relevant to their health condition
#### Enrolling a Patient in a Program
-To enrol a patient in a program, click on the `Add Program` button in the top right corner of the screen or click the down arrow next to the button and select `Add Program` if the button does not say `Add Program`. A new window will appear for you to select the program you want to enrol the patient in. Programs that the patient is already enrolled in will be greyed out.
+To enrol a patient in a program, click on the `Add Program` button in the top right corner of the screen or click the down arrow next to the button and select `Add Program` if the button does not say `Add Program`. A new window will appear for you to select the program you want to enrol the patient in. Programs that the patient is already enrolled in will be greyed out.
-After selecting the program, another window will appear for you to enter program specific information.
+After selecting the program, another window will appear for you to enter program specific information.
In this example, we are enrolling the patient into the HIV Care and Treatment Program.
@@ -124,7 +139,7 @@ In this example, we are enrolling the patient into the HIV Care and Treatment Pr
### Encounter
-An Encounter is a recorded visit of the patient and their treatment under a specific program.
+An Encounter is a recorded visit of the patient and their treatment under a specific program.
#### Viewing the Encounter List
@@ -132,18 +147,18 @@ Go to `Dispensary` > `Encounters` to view the list of encounters.
-The list of encounters is divided into 8 columns:
+The list of encounters is divided into 8 columns:
-| Column | Description |
-| :---------- | :---------------------------------- |
-| **Type** | The encounter type |
-| **Program** | The program the encounter is associated with |
-| **Date** | The date of the encounter appointment |
-| **Start** | The start time of the encounter appointment |
-| **End** | The end time of the encounter appointment |
-| **Patient** | The patient the encounter is associated with |
+| Column | Description |
+| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **Type** | The encounter type |
+| **Program** | The program the encounter is associated with |
+| **Date** | The date of the encounter appointment |
+| **Start** | The start time of the encounter appointment |
+| **End** | The end time of the encounter appointment |
+| **Patient** | The patient the encounter is associated with |
| **Additional Info** | Displays additional information about the encounter. E.g. _Encounter Scheduled_ means that the appointment for this encounter has been scheduled. |
-| **Status** | The status of the encounter |
+| **Status** | The status of the encounter |
Clicking on an encounter will take you to the encounter details.
@@ -164,9 +179,11 @@ A window will open for you to select the encounter (this selection will vary dep
If the encounter is within the last hour, then you will be re-directed to the encounter page, otherwise, you will be re-directed to the encounter tab in the patient detail view.
Every encounter document will look differently, however there are some common features:
+
- The top of every encounter will contain common encounter details. Some of these details may be editable like _Clinician_ and _Visit Date and Time_.
An encounter can have three statuses:
+
- **Pending**: The encounter has been scheduled but not yet completed.
- **Visited**: The encounter has been completed.
- **Cancelled**: The encounter has been cancelled.
@@ -181,6 +198,10 @@ An encounter can have three statuses:
+
+ Immunization Program Encounters will have an additional
Vaccinations tab, which displays the patient's Vaccination Card for that program. See
Vaccination Encounters for more information.
+
+
### Contact tracing
Contact tracing is the process of identifying people who might have been exposed to a disease through the patient. The contact can then be contacted, registered and enrolled into a matching program if needed.
@@ -211,4 +232,125 @@ This will open a search window where you can search for the patient you want by
If the patient is already linked to the contact, but you want to change the patient because you linked the wrong patient, click the `Unlink Patient` button on the top right of the screen.
-
\ No newline at end of file
+
+
+### Vaccination Cards
+
+If the patient is enrolled in an Immunization Program, you can view their progress through the program by viewing their Vaccination Card.
+
+From the `Vaccinations` tab in the patient detail view, select the Immunization Program you want to view the Vaccination Card for.
+
+
+
+You will be redirected to the patient's Vaccination Card for that program.
+
+
+
+The Vaccination Card includes the following columns:
+
+| Column | Description |
+| :----------------- | :-------------------------------------------------------------------------------------------------------------------------- |
+| **Age** | The minimum age the patient should be to receive the dose |
+| **Dose** | The name of the dose |
+| **Status** | The vaccination status (see below) |
+| **Suggested date** | The earliest recommended date to give the dose (based on the patient's age, and the minimum interval since their last dose) |
+| **Date given** | The date of the recorded vaccination |
+| **Batch** | The batch of the vaccine item given to the patient |
+| **Facility** | The facility where the vaccination was administered |
+
+**Vaccination statuses:**
+
+- **Given**: The patient has received the vaccination
+- **Not Given**: The patient has not received the vaccination (e.g. refused, no stock available)
+- **Pending**: The patient is eligible for this dose - they have received the previous dose and are above the minimum age
+- **Overdue**: The patient is older than the recommended max age for this dose
+
+To view the details of a specific vaccination, click on that row in the card. This will open a new window containing all the vaccination information.
+
+
+
+
+
+
+Note that only the rows where a vaccination has been recorded (as `Given` or `Not given`) will be clickable in this view. New vaccinations are administered from within an encounter.
+
+#### Vaccination Encounters
+
+Immunization Program Encounters will have an additional `Vaccinations` tab, which displays the same Vaccination card as in the patient view above. However, new doses can also be administered from within the encounter.
+
+
+
+#### Adding Vaccination Records
+
+To add a new vaccination record, click the row in the Vaccination Card that corresponds to the dose you want to administer. You can only add vaccination records for a dose if the previous dose in that Vaccine Course has been `Given`. Rows for future doses will be disabled.
+
+Clicking the dose row will open a new window where you can enter the details of the vaccination.
+
+
+
+Let's step through each section.
+
+- `Facility`: will be pre-populated with the logged in facility. This can be changed if the vaccination was administered at a different facility.
+
+
+
+- `Clinician`: will be pre-populated with the clinician for the encounter, if selected. Can be changed if the vaccination was administered by a different clinician. This field is not available for vaccinations recorded at `Other` facilities.
+
+- `Date`: defaults to today's date, but can be changed to add historic vaccination records as needed.
+
+- `Given`/`Not given`: based on whether you select `Vaccine given` or `Vaccine not given`, some more fields will appear.
+
+- `Vaccine item` and `Batch`: If you select `Vaccine given`, you will be able to select the `Item` and `Batch` of the vaccine administered. If there is only one item/batch available, these fields will be pre-populated. Otherwise they can be selected from a dropdown.
+
+
+
+Note that if you selected an `Other facility`, you will not receive the option to select an item and batch.
+
+
+
+If you selected a `Date` in the past, a switch will appear to `Record stock transaction for past vaccination`.
+
+
+
+Switch this on if you want to record a stock transaction for this vaccination (see more below). This will enable the item and batch inputs.
+
+
+
+- `Reason`: If you instead select `Vaccine not given`, you will be able to select a reason why the vaccine was not given.
+
+
+
+- `Comment`: an optional comment field is also available for any observations or notes about the vaccination.
+
+When you are happy with your changes, you can click the OK button to save the vaccination record. If you want to discard your changes, click the Cancel button.
+
+
+
+If a vaccine item and batch were selected, the system will automatically create and finalise a [Prescription](/docs/dispensary/prescriptions). Prescriptions are created for each vaccination record to track stock usage.
+
+Note that the prescription will always be created for today's date, regardless of the date you selected for the vaccination.
+
+You can view the created prescription by clicking on the dose row again in the vaccination record. If a prescription was created, you will see a `View prescription` link in the info box at the top of the window.
+
+
+
+#### Editing Vaccination Records
+
+Vaccination records should be entered at the time of vaccination, so there shouldn't be a need to edit them. However, if you need to correct a mistake, you can do so by clicking on the row in the Vaccination Card that corresponds to the dose you want to edit, to open the edit window.
+
+
+
+All fields are editable. Some things to note:
+
+- Changing the date will not change the prescription date
+- If you change from `Given` to `Not given`, and a Prescription was previously created from the vaccination, you will have the option to `revert the existing stock transaction`
+ - If enabled, a [Customer Return](/docs/distribution/customer-returns) will be created for the vaccine item that was previously administered (note that the prescription will continue to exist - finalised prescriptions cannot be deleted)
+
+
+
+- If you change the item or batch, and a Prescription was previously created from the vaccination, you will have the option to `update stock transactions`. If enabled:
+ - A [Customer Return](/docs/distribution/customer-returns) will be created for the vaccine item that was previously administered
+ - A [Prescription](/docs/dispensary/prescriptions) will be created for the new vaccine item/batch
+ - Note that the previous prescription will continue to exist - finalised prescriptions cannot be deleted
+
+
+