Developers Getting Started With i2b2
Space shortcuts
Space Tools
Developers Getting Started With i2b2 getstarted

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. User logs into the web client and accesses create data table for export tool under the Tools plugin

  2. The DESIGN TABLE panel displays list of predefined variables that will be included by default in the data export file. These predefined variables are (by default) Gender, Age, Race

  3. From the Ontology Terms tab, drag and drop additional variables of interest onto the DESIGN TABLE grid. These variables will be added as a list of variables included in the data export. The predefined variables are locked and cannot be unchecked since they are required for every data table.  Other variables can be deleted under Actions column to exclude them from the data file.

  4. Aggregation method for the variable can be applied by clicking on the drop down box in the Aggregation Method column to assign aggregate options to each variable 

Aggregate Options

The availability of aggregation options depends on the type of concept it aggregates on.

...

Aggregation Options

Explanation

Existence (Yes/No)

Whether the patient has an observation of this concept. This is the default option.

Count: Number of Concepts

Total number of concepts

Count: Number of Dates

Total number of dates for the participant

Count: Number of Encounters

Total number of encounters for the participant

Count: Number of Facts

Total number of observations

Count: Number of Providers

Total number of providers for the participant

Date: First Date

Date of earliest observation

Date: Last Date

Date of the most recent observation

Calc: First Value

Minimum value of all numeric values observations

Calc: Last Value

Maximum value of all numeric values observations

Calc: Number of Values

count no Total numbe of all numeric values observations

Calc: Average Value

Average value of all numeric values observations

Calc: Minimum Value

lowest Lowest value of all numeric values observations

Calc: Maximum Value

Highest value of all numeric values observations

Calc: Median Value

Median value of all numeric values observations

...

Status is updated as the Data File is processed. from Submitted to File in Progress to File Available.


Example Export files (all data are fake)

Two files are generated for each data table exported. 

...

  • RPDO_TABLE_REQUEST table stores the default data table parametersdefinitions
  • HIVE_CELL_PARAMS has new parameters for global and email configurations and the data file generation location (defaults to the server's drive)
  • QT_RESULT_TYPE table will contain a new entry for each data table definition
  • QT_BREAKDOWN_PATH will contain a new entry for each data table definition which has the data export execution details.
  • QT_XML_RESULT contains metadata about each data request, such as status and e-mail details.  

...

Below is the list of Actions available based on the User role. (future implementation) 


User RoleCreate Data TableData RequestData Request Manager View DetailsData Export/Generate Data file Change Request Status
ObfuscatedEnabledEnabledEnabledDisabledDisabled




AggregateEnabledEnabledEnabledDisabledDisabled




ProtectedEnabledEnabledEnabledDisabledDisabled

LDSEnabledEnabledEnabledDisabledDisabled

Manager/No LDSEnabledEnabledEnabledDisabledDisabled

Manager/LDSEnabledEnabledEnabledEnabledEnabled
AdminEnabledEnabledEnabledEnabledEnabled

...

RPDO_TABLE_REQUEST PARAMETERSDATA TABLE Values
TABLE_REQUEST_ID

auto generated incremental value, corresponding to each concept in the data table. Unique for each concept

example: 1282,1283, 1284

TABLE_INSTANCE_ID

unique for each Data table ( same value for all the concepts underneath)

example: 17

TABLE_INSTANCE_NAMEData table definition name
USER_IDdata request user
GROUP_IDproject id
SET_INDEXauto incremented for each concept row for the table instance
C_FACTTABLECOLUMN"concept_cd" for the fact table or "patient_num" for the patient_dimension
C_TABLENAMEcorresponds to table storing concept_cd/patient_num( concept_dimension or patient_dimension )
COLUMN_NAMEThe column name of the data table definition
C_FULLPATHcorresponds to the concept's c_fullname in the ontology table
C_COLUMNNAMEusually "concept_path" for concept_dimension
C_COLUMNDATATYPEcorresponds to ontology table  column value
C_OPERATORcorresponds to ontology table  column value
C_DIMCODEcorresponds to ontology table  column value
AGG_TYPEcorresponds to Aggregate option selection in data table definition
CONSTRAIN_BY_DATE_TOcorresponds to date constraint option selection in data table definition
CONSTRAIN_BY_DATE_TOcorresponds to date constraint option selection in data table definition
CONSTRAIN_BY_DATE_FROMcorresponds to date constraint option selection in data table definition
CONSTRAIN_BY_VALUE_OPERATORcorresponds to set value constraint selection in data table definition
CONSTRAIN_BY_VALUE_CONSTRAINTcorresponds to set value constraint selection in data table definition
CONSTRAIN_BY_VALUE_UNIT_OF_MEASUREcorresponds to set value constraint selection in data table definition
CONSTRAIN_BY_VALUE_TYPEcorresponds to set value constraint selection in data table definition
CREATE_DATEcorresponds  data table definition creation date
SHAREDY (for project and system shared table definitions); N (User table definition)
DELETE_FLAGY (if deleted) or N 
C_VISUALATTRIBUTESvalues are LA  or LH  (based on visibility table definitions in the panel)
REQUIREDY for default variables ( race, age, sex); N for other variables
JASON_DATA

logs the table definition variables details needed for the  execution of the stored procedure to create the data file

GENERATED_SQLlogs the SQL query that is generated by stored procedure call  for each variable
DELETE_DATEdate of table definition deletion
CREATE_DATEdate of table definition creation
USE_AS_COHORTN by default; not used currently

...

QT_QUERY_RESULT_TYPE

The data table definition is logged as a breakdown type  in the QT_QUERY_RESULT_TYPE table when the user saves the data table definition.

...

RESULT_TYPE_IDNAMEDESCRIPTIONDISPLAYTYPE_IDVISUAL_ATTRIBUTE_TYPE_IDUSER_ROLE_CDCLASSNAME

Auto generated number

example : 144

RPDO_<TABLE_INSTANCE_ID>

example: RPDO_17

User-created <Table_Name>RequestCATNUM

LU (User and  system shared tables)

LP (Project shared tables)


DATA_LDSedu.harvard.i2b2.crc.dao.setfinder.QueryResultPatientRequest

...

Developers Getting Started With i2b2 getstarted