Contents 1 High-Level Specification 1.1 Overview 1.2 Requirements 1.2.1 Report Design 1.2.2 Report Generation 1.3 Example of Usage 2 Functional Requirements 2.1 Use Cases 2.2 API

High-Level Specification

Overview

Requirements

Report Design

• FR1 - Ability to create a new report
  • FR1.1 - If report design XML (.rptdesign) is not specified, the module will create a default BIRT Report Design (.rptdesign)
• FR2 - Ability to select multiple Dataset Definitions for a single report
  • FR2.1 If the Dataset Definition does not have an associated Report Element Type (such as a table, graph, chart) we will create a default report element (see FR2.2)
  • FR2.2 The default Report Element will be a table which displays Dataset Definition
  • FR2.3 The module will support the "Table" Report Element
    • All other Report Element types should be created within the BIRT Report Designer
• FR3 - Ability to add multiple report elements to report (including, dataset definitions)
• FR4 - Ability to upload BIRT report design XML (.rptdesign)
  • FR4.1 Module should check to make sure that Dataset(s) bound to Report Elements match the Dataset definition in the database.
• FR5 - Ability to download BIRT report design XML (.rptdesign)
• FR6 - Ability to modify an existing report
• FR7 - Ability to duplicate an existing report definition
• FR8 - Ability to add multiple Report Elements (chart, graph, table)
• FR9 - Ability to bind Dataset Definition to Report Elements
• FR10 - Ability to verify that Dataset Definition matches data elements in Report Design (.rptdesign)

Report Generation

• FR1 - Ability to choose a CohortDefinition and DatasetDefinition at report runtime
  • FR1.1 - Data retrieved during this step should be 'injected' into the report
  • FR1.2 - User can choose to "save" the new configuration (as a replacement or as a copy)
• FR2 - Ability to enter parameter(s) at report runtime
• FR3 - Ability to produce report output in multiple formats (HTML, PDF)
  • Note to all: Please specify other formats if required (i.e. Word Doc)

Example of Usage

The following section is an example of the expected workflow for creating a new report in OpenMRS. This workflow is actually the combination of multiple use cases (Create Report, Generate Report). The workflow described below will be realized by several tools, including the OpenMRS Cohort Builder, OpenMRS Data Set Definition tool, and the OpenMRS BIRT Reporting Module. The following is not meant to serve as a use case as the use case for creating a report will only consist of the the first few steps. However, this should give OpenMRS implementors a better idea of how a report will be defined and generated within OpenMRS.

1. Define Cohort using the OpenMRS Cohort Definition tool.
2. Define data columns using the OpenMRS Data Set Definition tool.
3. Export data using the OpenMRS Data Export tool.
4. Design report using the Eclipse BIRT RCP Designer.
5. Upload report using the OpenMRS BIRT Reporting Module.
6. Generate report using the OpenMRS BIRT Reporting Module (user may select different cohort during this step).

Functional Requirements

Use Cases

• Use Case 1: Manage Reports
• Use Case 2: Create Report
• Use Case 3: Update Report
• Use Case 4: Upload Report
• Use Case 5: Duplicate Report
• Use Case 6: Delete Report
• Use Case 7: Preview Report
• Use Case 8: Generate Report

API