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.

...

  • Query Name (Click on Query ID number to display the previous query in the Find Patients window)
  • Data Table Definition (Click on View under Data Request Type drop down Request item
  • Option to Withdraw Request 
  • Option to enter Comments
  • Log info box displays the User's actions. and log of the Request status


...


...

Data

...

Data Export - Manager process

The User-created data requests are managed by the data Data Manager using the Data Request Manager tool. 

...

Data Request StatusData column Value
SubmittedSubmitted
WithdrawnCancelled
DeniedIncomplete
File in ProgressQueued
File availableFile available

I DON'T UNDERSTAND THIS TABLE - JEFF


Example Export files (all data are fake)

2 sets of Two files are generated for each data exporttable exported

Definition file: has the  the variable names and data types for the data file

...

User-created Demographics

Definition file

Example:1969_Definition_For_Demographics_8_5_25.csv

TABLE_INSTANCE_IDTABLE_INSTANCE_NAMEUSER_IDGROUP_IDSET_INDEXC_FACTTABLECOLUMNC_TABLENAMECOLUMN_NAMEC_FULLPATHC_COLUMNNAMEC_COLUMNDATATYPEC_OPERATORC_DIMCODEAGG_TYPECONSTRAIN_BY_DATE_TOCONSTRAIN_BY_DATE_FROMCONSTRAIN_BY_VALUE_OPERATORCONSTRAIN_BY_VALUE_CONSTRAINTCONSTRAIN_BY_VALUE_UNIT_OF_MEASURECONSTRAIN_BY_VALUE_TYPECREATE_DATE
7DEM_6_27demoManagerSQLServerLarge0sex_cdpatient_dimensionGender@@@@@Value





37:14.3
7DEM_6_27demoManagerSQLServerLarge1age_in_years_numpatient_dimensionAge@@@@@Value





37:14.3
7DEM_6_27demoManagerSQLServerLarge2race_cdpatient_dimensionRace@@@@@Value





37:14.3
7DEM_6_27demoManagerSQLServerLarge3patient_numpatient_dimension(children) < 18 years old\\ACT_DEMO\ACT\Demographics\Age\< 18 years old\birth_dateN>dateadd(YY, -18, GETDATE()) Exists





37:14.3


Data file

Example: 1969_Demographics_8_5_25_08052025.cscsv

patient_numGenderAgeRace(children) < 18 years old75-84 years old>= 65 years old
26M72@NoYesYes
53F55WHITENoNoNo
87F59WHITENoNoNo
92F88DECLINEDNoNoYes
94F67ASIANNoNoYes
153M77@NoYesYes
User-created Labs

Definition file

Example: 2282_Definition_For_LAB_TESTS_HUGEPT_AGGOPTIONS

TABLE_INSTANCE_IDTABLE_INSTANCE_NAMEUSER_IDGROUP_IDSET_INDEXC_FACTTABLECOLUMNC_TABLENAMECOLUMN_NAMEC_FULLPATHC_COLUMNNAMEC_COLUMNDATATYPEC_OPERATORC_DIMCODEAGG_TYPECONSTRAIN_BY_DATE_TOCONSTRAIN_BY_DATE_FROMCONSTRAIN_BY_VALUE_OPERATORCONSTRAIN_BY_VALUE_CONSTRAINTCONSTRAIN_BY_VALUE_UNIT_OF_MEASURECONSTRAIN_BY_VALUE_TYPECREATE_DATE
310LAB_TESTS_HUGEPT_AGGOPTIONSactNODE90sex_cdpatient_dimensionGender@@@@@Value





25:57.3
310LAB_TESTS_HUGEPT_AGGOPTIONSactNODE91age_in_years_numpatient_dimensionAge@@@@@Value





25:57.3
310LAB_TESTS_HUGEPT_AGGOPTIONSactNODE92race_cdpatient_dimensionRace@@@@@Value





25:57.3
310LAB_TESTS_HUGEPT_AGGOPTIONSactNODE93race_cdpatient_dimensionEthnicity@@@@@Value





25:57.3
310LAB_TESTS_HUGEPT_AGGOPTIONSactNODE94concept_cdconcept_dimensionCholesterol (Group:CHOL)\\i2b2_LABS\i2b2\Labtests\LAB\(LLB16) Chemistry\(LLB17) Lipid Tests\CHOL\concept_pathNlike\i2b2\Labtests\LAB\(LLB16) Chemistry\(LLB17) Lipid Tests\CHOL\NumFacts




25:57.3


Data file:

Example: 2282_LAB_TESTS_HUGEPT_AGGOPTIONS_08122025

...

The i2b2 breakdown architecture is modified to  support  to support the data table definition and new breakdown types for User created data requests. The database tables have been modified to support the data table definition parametersdefinitions.

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

...

In order to support the data Table design, a new table RPDO_TABLE_REQUEST is added.  The metadata in Data Table design is stored in the table when the data Table is saved.


Four patient_dimension Three default rows are initially loaded into the RPDO_TABLE_REQUEST, defining patient_dimension columns which are required in every export table. These are:  vital_status_cd, race_cd, age_in_years_num, and sex_cd and gender

Info

The default rows insert script is provided in the data install folder of the release 

Reeta - update this screenshot, the Github does not do Vital Status.

QT_BREAKDOWN_PATH

QT_Breakdown_Path table has been modified to include a new column Group_id. It logs stores the Project _id valueID, in order to support project-scoped data table definitions.

Column NameData Type
Group_IdVarchar (50)

...

Database updates- Data table definition creation

New rows are dynamically logged in db tables The database is dynamically modified when the user creates the data table definition or submits a data request 

RPDO_TABLE_REQUEST 

Data Rows for the data table design variables and values are dynamically inserted in the RPDO_TABLE_REQUEST at the time of when a data table Definition Saveis saved.  

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 name row for the table instance
C_FACTTABLECOLUMN"concept_cd value in " for the fact table or "patient_num value in " for the patient_dimension
C_TABLENAMEcorresponding corresponds to table storing concept_cd/patient_num( concept_dimension or patient_dimension )
COLUMN_NAMEcorresponds to value in The column _ name of the data table definition
C_FULLPATHcorresponds to metadata table  column valuethe concept's c_fullname in the ontology table
C_COLUMNNAMEvalue in usually "concept_path column in concept_dimension/patient" for concept_dimension
C_COLUMNDATATYPEcorresponds to metadata ontology table  column value
C_OPERATORcorresponds to metadata ontology table  column value
C_DIMCODEcorresponds to metadata 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 panel)

This is missing a couple of columns (e.g., REQUIRED)

Example:

QT_QUERY_RESULT_TYPE

...

QT_BREAKDOWN_PATH 

A new row is logged  also added here when the user saves the data table definition. 

  •  Name Name column logs references the  Table_instance_id when the user saves the table_definition. 
  • Value column logs the EXEC statement of contains the command to run the stored procedure that generates the data file.
  • Group_id has the value of project _idID
  • The result_instance_id variable parameter gets updated with the numeric value from the QUERY_RESULT_INSTANCE  where the  INSTANCE for the patientset (result_type_id  (Ptset) =1 at the time of creation of Data file) when the export file is created.


Example:

NAMEVALUEGroup_id

RPDO_<Table_instance_id>

Example: RPDO_17

EXEC i2b2synthea8.dbo.usp_rpdo2 @TABLE_INSTANCE_ID=<Table_instance_id> @RESULT_INSTANCE_ID={{{RESULT_INSTANCE_ID}}} @MIN_ROW=0 @MAX_ROW=10000

SQLServerLarge

...

Developers Getting Started With i2b2 getstarted