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.

...

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.cs

...

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

...

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


Example:

Database updates- Data request

...

submission/Data file creation

QT_QUERY_RESULT_INSTANCE

When the User runs a query with User created Data Request breakdown option selected, a row is logged in the QT_Query_Result_Instance for the  result_type_id generated in the QT_RESULT TYPE

...

The EXEC statement in Value column is updated with values value for table_instance_id and result_instance_id  to generate the Data file is executedid 

Example:

NAMEVALUE

RPDO_<Table_instance_id>

Example: RPDO_144

EXEC i2b2synthea8.dbo.usp_rpdo2 @TABLE_INSTANCE_ID=17 @RESULT_INSTANCE_ID=1729@MIN{{{RESULT_INSTANCE_ID}}},@MIN_ROW=0 @MAX_ROW=1000099999999


{{{RESULT_INSTANCE_ID}}} gets replaced with QT_

...

QUERY_RESULT_INSTANCE.Result_instance_id  as the stored-procedure in the back-end gets executed.

at the time of data file creation.

QT_XML_RESULT:

A row is logged for the result_instance_id of the data request submitted at the time of query run. Metadata about data request

...

Metadata about data request queries are stored in the QT_XML_RESULT table, in the XML_VALUE field.  The metadata  gets updated as the data export process is completed (from data request submission to data file creation)

Column Name Value (example)
Result_Instance_Id1729
XML_Value <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns10:i2b2_result_envelope xmlns:ns6="http://www.i2b2.org/xsd/cell/crc/psm/analysisdefinition/1.1/" xmlns:ns5="http://www.i2b2.org/xsd/hive/msg/1.1/" xmlns:ns8="http://www.i2b2.org/xsd/cell/pm/1.1/" xmlns:ns7="http://www.i2b2.org/xsd/cell/crc/psm/querydefinition/1.1/" xmlns:ns9="http://www.i2b2.org/xsd/cell/ont/1.1/" xmlns:ns10="http://www.i2b2.org/xsd/hive/msg/result/1.1/" xmlns:ns2="http://www.i2b2.org/xsd/hive/pdo/1.1/" xmlns:ns4="http://www.i2b2.org/xsd/cell/crc/psm/1.1/" xmlns:ns3="http://www.i2b2.org/xsd/cell/crc/pdo/1.1/">
    <body>
        <ns10:result name="RPDO_17">
            <data column="SUBMITTED" type="string">20250808_125429</data>
            <data column="EMAIL" type="string">rmetta@mgb.org</data>
            <data column="QUEUED" type="string">20250808_125631</data>
            <data column="PROCESSING" type="string">20250808_125631</data>
            <data column="DIRECTORY" type="string">/opt/dataexport/SQLServerLarge/724</data>
            <data column="FINISHED" type="string">20250808_125633</data>
            <data column="APPROVEDBY" type="string">demoManager</data>
        </ns10:result>
    </body>
</ns10:i2b2_result_envelope>

Example:

 

Data file format/location and Email parameters set-up: HIVE_CELL_PARAMS

...

Developers Getting Started With i2b2 getstarted