Simple Lab Entry Module

Overview

TBD

Installation and Configuration

The module requires the following global properties to be set before it can be used:

simplelabentry.supportedTests

What this does: This determines what Lab Tests may be ordered and entered within the module. This supports panels of tests (eg. Hematology, which includes multiple tests such as Hemoglobin, Hematocrit, etc.), or single Tests (eg. HIV Rapid Test Result). Examples of what this looks like are included in the Usage section below.

How you should enter it:: A comma-separated string of concept ids. Each concept id may either refer to a Concept of type "LabSet", in which case all of the Concepts of type "Test" within this set will be entered together, or may refer to a Concept of type "Test", which will allow for single test result entry.

simplelabentry.testFailureConcepts

What this does: TBD - need to clarify whether this is actually used by the module.

How you should enter it:: This should be a comma-separated string of entries in the form (labTestSetConceptId).(testFailureConceptId)

simplelabentry.conceptsInLabSetsThatAreNotTests

What this does: In the event that you have the "supportedTests" property configured to point at a Concept Set, and within that Concept Set you have a Concept of type "Test" which you do _not_ want to include for entry, you can specify that in this property here.

How you should enter it:: As a comma-separated string of concept ids

simplelabentry.labOrderType

What this does: Within the "Lab Order Entry" section, when a new Order is placed for a Lab Test, the Order Type that is created is determined from this property. So, this property should be configured with the Order Type that refers to a Lab Test order. From the Administration page, go to  Orders > Manage Order Types to list or add Order Types. 

How you should enter it:: An Order Type ID

simplelabentry.labTestEncounterType

What this does: This should be the EncounterTypeId of the EncounterType that represents a Lab Test. From the Administration page, go to  Encounters > Manage Encounter Types to list or add Order Types.

How you should enter it:: An Encounter Type ID

simplelabentry.patientIdentifierType

What this does: The system supports a primary identifier type to use when searching for patients, and also a single type which is displayed on the entry and view screens for each patient. You should enter here the PatientIdentifierType that you would like the system to use for this purpose here. From the Administration page, go to Patients > Manage Identifier Types to list or add Patient Identifier Types.

How you should enter it:: A Patient Identifier Type ID

simplelabentry.patientIdentifierTypesToSearch

What this does: The system supports additional identifier types that can be used when for searching for patients. These should be entered here.  From the Administration page, go to Patients > Manage Identifier Types to list or add Patient Identifier Types.

How you should enter it:: A comma delimited set of patient identifier type IDs.

simplelabentry.patientHealthCenterAttributeType

What this does: Used to display the patient's health center when viewing patient entries in the lab order and result entry interfaces, as well as when searching for patients. Although not all implementations will necessarily model this person identifier type, this module still requires this, as it was written specifically for use in Rwanda and this has not yet been generalized.

How you should enter it:: The PersonAttributeTypeId for the PersonAttributeType representing the Patient's Health Center

simplelabentry.programToDisplay

What this does: Used to display the patient's current state in the configured program workflow when viewing patient entries in the lab order and result entry interfaces, as well as when searching for patients. This is used in conjunction with the "workflowToDisplay" property. From the Administration page, go to Patients > ManagePrograms to list or add Programs.

How you should enter it:: The name of the program, not the id. For example - "HIV PROGRAM"

simplelabentry.workflowToDisplay

What this does: Used to display the patient's current state in the configured program workflow when viewing patient entries in the lab order and result entry interfaces, as well as when searching for patients. This is used in conjunction with the "programToDisplay" property. From the Administration page, go to Patients > ManagePrograms. Click on the program to see workflows.

How you should enter it:: This name of the workflow, not the id. For example - "ANTIRETROVIRAL TREATMENT GROUP"

simplelabentry.labReportConcepts

What this does: Determines which list of concepts that you want to see in the lab report, in order.

How you should enter it:: Comma-delimited list of concept ids

simplelabentry.cd4ConceptId

What this does: Allows you to configure what Concept in your dictionary refers to "CD4 Count". This is needed for the CD4 Count Report that the module provides. Again, this is specific to Rwanda needs and is a good candidate for refactoring out in a more generic way, but currently is required by the module. Go to the Concept Dictionary to find or create a CD4 concept.

How you should enter it:: The local conceptId of the CD4 concept

Usage

The module is written to support a particular workflow, namely one in which first an Order is entered for one or more lab tests, and later results are entered for these ordered tests. There is also an administrative interface for managing all lab orders and results, as needed, outside of this particular workflow, as well as some pre-built reports. These are described in more detail below.

Lab Order Entry

TBD.  Instructions and screenshots here

Lab Result Entry

TBD.  Instructions and screenshots here

Lab Data Management / Administration

TBD.  Instructions and screenshots here

Reports

TBD.  Instructions and screenshots here

Download

Download from the OpenMRS module repository

Release Notes

TBD