Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update link to go to OpenMRS Add-ons index instead

...

Installation and Configuration

  • Download from the module repository
  • Grant any required privileges
    • View Facility Data Reports: Allows users to view and analyze entered data
    • Enter Facility Data Reports: Allows users to enter facility data
    • Manage Facility Data Reports: Allows users to create, edit, delete forms, questions, and question types
  • Configure global properties
    • facilitydata.unsupportedFacilities: An optional comma-separated list of location ids. If supplied, this will hide those locations from within the user-interface. Otherwise, will show all
    • facilitydata.dailyReportDaysOfWeek: An optional comma-separated list of days of the week. If supplied, this will enable entry for DAILY reports only on the days specified. (Sunday = 1, Monday = 2, ... Saturday = 7). To support entry for weekdays only, you would enter 2,3,4,5,6
  • Navigate to the facility data dashboard, accessible from the Administration page

...

Using the facility data module is a fairly simple process. Your first step is to figure out what data you wish to collect and how often you wish to collect it. Currently the facility data module supports forms that are entered daily (either every day or a subset of days per week, per the global property above) or monthly. Each form can contain one ore or more sections to logically group questions together. Questions are defined independently of forms, and the same question can be added to multiple forms. Each form can customize the display label and question number that is associated with a particular question that has been added to it. Each question that you create must be associated with a particular user-defined question type. Question types fall into 2 broad categories - numeric or coded, and fully control the allowable answers for a given question. Users should define as many instances of numeric and coded question types as they need to meet their specific data collection requirements.

...

Steps for creating or editing a question type:

Screenshots

  1. From the facility data dashboard, click "Manage Question Types"
  2. To edit an existing Question Type, click the name of the Question Type from the displayed list
  3. To add a new Coded Question Type, select "Coded" from the list, and click "Add"
    • Name: A descriptive name for this type (eg. Boolean)
    • Description: An optional way to further describe what this represents
    • Coded Options: The allowable values for this Question Type. For each coded option, you can specify:
      • Name: The name of the answer (eg. True). This will be the value that is displayed in the form
      • Code: A label-agnostic code for the answer, that might be used in analysis applications to equate two otherwise different options
      • Description: A description that further clarifies what this option represents
  4. To add a new Numeric Question Type, select "Numeric" from the list, and click "Add"
    • Name: A descriptive name for this type (eg. Positive Integer)
    • Description: An optional way to further describe what this represents
    • Min Value: The minimum allowed value for this type (optional)
    • Max Value: The maximum allowed value for this type (optional)
    • Allow Decimal Values: If unchecked, only whole numbers are allowed



...

For the initial release of the module, this section contains a single tool, available by clicking "Export raw values to Excel". This tool allows you to choose either a form or a question, optionally limited by Facility, date range, and entered date range, and to export all entered values to Excel that match this criteria. This exported spreadsheet contains 2 sheets - one with the exported data, and one that contains the details of the export query. See screenshots below and to the right

Image Removed

Release Notes

  • 2.0: Initial release (NOTE: THIS IS NOT BACKWARDS COMPATIBLE WITH THE 1.0 RELEASE)
  • 1.0: Initial alpha release

Contacts

Project Lead:

~mseaton Mike Seaton

Contributers: ~dupuyrony

Dupuy Rony Charles

 

Robert O'Connor (Google Summer of Code 2009)

...