Patient Programs

View and Manage Patient Programs

You can manage Patients by programs in Open mSupply. This involves some special settings. Please see Patients for more information on how to view and create patients.

To use Patient Programs, ensure that your store is set to Dispensary mode (see the virtual stores documentation for how to do this).

You will also need to enable the store preference for Open mSupply: Uses program module. This preference is compatible with Open mSupply v1.2.0+ and mSupply v7-07-00-beta9+.

Store preference

You will also need to enable the user permissions shown below on the central server:

This is an example of the permissions required for a user to view and manage program specific features. The permissions required may vary depending on your configurations.

User permissions

The Patient Programs module is highly customisable and may look different depending on your configurations. Please contact your administrator for customisations.

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.

Program Enrolments

Viewing a Patient

There are five tabs on the patient detail page:

  1. Patient Details: This tab contains the patient details.

The patient detail page will look very different from the standard patient detail page. This view is highly customisable and can be tailored to specific needs. Please contact your administrator if you would like to customise this view.

Patient detail

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.

Patient History

  1. 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 for more information.

This program tab will display 5 columns:

ColumnDescription
ProgramThe name of the program
Enrolment Patient IDThe patient's program ID
Additional InfoDisplays program specific information. E.g. LTFU lost to follow up
Program StatusThe status of the program
Enrolment DateThe date the patient was enrolled in the program

Programs

  1. Encounters: This tab contains the encounters that the patient has had.

Clicking on an encounter will take you to the encounter details. See Encounter for more information.

This encounters tab will display 6 columns:

ColumnDescription
TypeThe encounter type
ProgramThe program the encounter is associated with
DateThe date of the encounter appointment
StartThe start time of the encounter appointment
EndThe end time of the encounter appointment
Additional InfoDisplays additional information about the encounter. E.g. Encounter Scheduled means that the appointment for this encounter has been scheduled.

Encounters

  1. Contact Tracing: This tab contains the contact tracing information for the patient.

Clicking on a contact will take you to the contact details. See Contact Tracing for more information.

This contact tracing tab will display 7 columns:

ColumnDescription
ProgramThe name of the program this contact is associated with
Date CreatedThe date the contact was created
First nameFirst name of the contact
Last nameLast name of the contact
GenderGender of the contact
RelationshipThe relationship of the contact to the patient
AgeThe age of the contact

Contact Tracing

  1. 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 for more information.

This Vaccinations tab will display 4 columns:

ColumnDescription
ProgramThe name of the program
Enrolment Patient IDThe patient's program ID
Program StatusThe status of the program
Enrolment DateThe date the patient was enrolled in the program

Vaccinations Tab

Program

Patients can be enrolled in a program that is relevant to their health condition. A patient can be enrolled in multiple programs.

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.

Add Program

Add Program

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.

Program Enrolment

Encounter

An Encounter is a recorded visit of the patient and their treatment under a specific program.

Viewing the Encounter List

Go to Dispensary > Encounters to view the list of encounters.

Encounter Navigation

The list of encounters is divided into 8 columns:

ColumnDescription
TypeThe encounter type
ProgramThe program the encounter is associated with
DateThe date of the encounter appointment
StartThe start time of the encounter appointment
EndThe end time of the encounter appointment
PatientThe patient the encounter is associated with
Additional InfoDisplays additional information about the encounter. E.g. Encounter Scheduled means that the appointment for this encounter has been scheduled.
StatusThe status of the encounter

Clicking on an encounter will take you to the encounter details.

Encounter List

Add an Encounter

To add an Encounter for the patient, click the Add Encounter button on the top right corner of the screen. Click on the down arrow next to the button and select Add Encounter if the button does not say Add Encounter.

Add Encounter

A window will open for you to select the encounter (this selection will vary depending on what programs the patient is enrolled in), visit date, clinician and add notes for this encounter.

In the below example, we are creating a HIV Care Encounter

Add Encounter

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.

Encounter

  • The side panel (opened by clicking More on the top right corner) will contain additional information such as previous encounters.

Encounter

In this example, we are viewing the HIV Care Encounter

Encounter

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.

Add a Contact

To add a contact for a patient, click the Add Contact button on the top right corner of the screen. Click on the down arrow next to the button and select Add Contact if the button does not say Add Contact.

Add Contact

A window will open, inviting you to select the type of contact you want to add. Currently, only HIV Partner Testing is available. Click Ok to proceed.

Add Contact

Edit a Contact

Edit Contact

Linking a Contact to a Patient

Once a contact has been added to mSupply, they can then be linked to patient who came into contact with them. Do this by clicking the Link to Patient button on the top right of the screen.

Link to Patient

This will open a search window where you can search for the patient you want by their first name, last name or patient ID. Once you have found the patient, click on the patient to link them to the contact.

Link to Patient

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.

Unlink Patient

Vaccination Cards

If the patient is enrolled in an Immunization Program, you can view their progress through the program by viewing their Vaccination Card.

The Vaccination Card can only be viewed from the facility where the patient was enrolled in the program. If the patient was enrolled in the program at a different facility, you will not be able to view their Vaccination Card.

From the Vaccinations tab in the patient detail view, select the Immunization Program you want to view the Vaccination Card for.

Vaccinations Tab

You will be redirected to the patient's Vaccination Card for that program.

Vaccination Card

The Vaccination Card includes the following columns:

ColumnDescription
AgeThe minimum age the patient should be to receive the dose
DoseThe name of the dose
StatusThe vaccination status (see below)
Suggested dateThe earliest recommended date to give the dose (based on the patient's age, and the minimum interval since their last dose)
Date givenThe date of the recorded vaccination
BatchThe batch of the vaccine item given to the patient
FacilityThe 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.

Vaccination Card - 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.

Vaccination Modal

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.

Vaccination Modal - other 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.

Vaccination Modal - given batch select

Note that if you selected an Other facility, you will not receive the option to select an item and batch.

Vaccination Modal - given other facility

If you selected a Date in the past, a switch will appear to Record stock transaction for past vaccination.

Vaccination Modal - given historic

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.

Vaccination Modal - given historic with transaction

  • Reason: If you instead select Vaccine not given, you will be able to select a reason why the vaccine was not given.

Vaccination Modal - not given reason

  • 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.

Vaccination Modal - save

If a vaccine item and batch were selected, the system will automatically create and finalise a Prescription. 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.

Vaccination Modal - view prescription

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.

Vaccination Modal - edit

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 will be created for the vaccine item that was previously administered (note that the prescription will continue to exist - finalised prescriptions cannot be deleted)

Vaccination Modal - revert transaction

  • 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 will be created for the vaccine item that was previously administered
    • A Prescription will be created for the new vaccine item/batch
    • Note that the previous prescription will continue to exist - finalised prescriptions cannot be deleted

Vaccination Modal - update transaction