Dataset Definition Tool Requirements

Contents

[edit]

High-Level Specification

[edit]

Overview

[edit]

Requirements

  • FR1 - Ability to choose the primary entity of the Dataset definition
  • FR2 - Ability to choose data items about the primary entity
    • pre-defined columns or attributes exposed through the API (hard-coded?)
    • concepts exposed through the Concept Service
    • tokens and rules exposed through the Logic Service (eventually this will be the only choice)
    • other entities related to the primary entity
    • meta-data about other entities
  • FR3 - Ability to store Dataset definition (set of data items defined in FR1)
  • FR4 - Ability to apply functions/transformations over the data points
    • This might need to be moved to another service layer component
  • FR5 - Ability to update Dataset definition
  • FR6 - Ability to delete Dataset definition
  • FR7 - Ability to duplicate Dataset definition


[edit]

Example of Usage

Dataset definitions will be passed the Data Export tool in order to inform the tool which columns or data points it needs to retrieve from the database. The Data Export tool will also need to know information about the desired cohort in order to retrieve the appropriate rows. Dataset definitions will also be bound to report elements.


[edit]

Functional Requirements

[edit]

Entities

This section describes the entities that are involved in the Data Set definition tool.

NOTE: The entity relationships for the dataset tool are currently being re-designed. --Jmiranda 13:55, 27 May 2007 (EDT)

'''Report Definition''' 

   ââââââ¬'''Report Element Definition''' 
        ââÅâââ¬'''Dataset Definition'''
        ââââââ¬'''Cohort Definition'''
[edit]

Use Cases

  • Manage Dataset Definitions
  • Create/Update Dataset Definition Image:Define_Data_Set.png
    • Edit Column/Token
    • Move Column/Token
  • Duplicate Dataset Definition
  • Preview Dataset Instance (calls Data Export tool)
  • Save Dataset Instance
    • Darius and I discussed this on Wednesday and decided that it might be a bad idea to save the data. If necessary, we can save the CSV to the filesystem.

NOTE: I need to figure out the naming convention for instances a dataset definition. We discussed this in Indiana and it was determined that Dataset, by itself, means "instance of". However, I just want to make sure we all agree with that as I don't want to cause confusion between dataset definitions and dataset instances.

[edit]

API

Retrieved from "http://openmrs.org/wiki/Dataset_Definition_Tool_Requirements"