Developers Getting Started With i2b2
Space shortcuts
Space Tools

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Anchor
_Toc148539250
_Toc148539250
Request Example Message


<?xml version="1.0" encoding="UTF-8"?>
<i2b2:request xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:i2b2="http://i2b2.mgh.harvard.edu/message" xsi:schemaLocation="http://i2b2.mgh.harvard.edu/message ./i2b2_request.xsd">
     <message_header>
          <i2b2_version_compatible>0.3</i2b2_version_compatible>
          <hl7_version_compatible>2.4</hl7_version_compatible>
          <sending_application>
               <application_name>i2b2_IdentityManagementCell </application_name>
               <application_version>0.2</application_version>
          </sending_application>
          <sending_facility>
               <facility_name>PHS</facility_name>
          </sending_facility>
          <receiving_application>
               <application_name>i2b2_DataRepositoryCell</application_name>
               <application_version>0.2</application_version>
          </receiving_application>
          <receiving_facility>
               <facility_name>PHS</facility_name>
          </receiving_facility>
          <datetime_of_message>2000-01 31T20:59:59.222</datetime_of_message>
          <security>
               <domain>PHS</domain>
               <username>demo</username>
               <password>demouser</password>
          </security>
          <message_type>
               <message_code>Q04</message_code>
               <event_type>EQQ</event_type>
          </message_type>
          <message_control_id>
               <session_id>session id or date</session_id>
               <message_num>zsspLPVzL4wE4dZcNeFR</message_num>
               <instance_num>0</instance_num>
          </message_control_id>
          <processing_id>
               <processing_id>P</processing_id>
               <processing_mode>I</processing_mode>
          </processing_id>
          <accept_acknowledgement_type>messageId</accept_acknowledgement_type>
          <application_acknowledgement_type/>
          <country_code>US</country_code>
          </message_header>
          <request_header>
          <result_waittime_ms>180000</result_waittime_ms>
          </request_header>
     <message_body/>
</i2b2:request>

Anchor
_Toc148539251
_Toc148539251
Response Example Message

<?xml version="1.0" encoding="UTF-8"?>
<i2b2:request xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:i2b2="http://i2b2.mgh.harvard.edu/message" xsi:schemaLocation="http://i2b2.mgh.harvard.edu/message ./i2b2_request.xsd">
     <message_header>
          <i2b2_version_compatible>0.3</i2b2_version_compatible>
          <hl7_version_compatible>2.4</hl7_version_compatible>
          <sending_application>
               <application_name>i2b2_IdentityManagementCell </application_name>
               <application_version>0.2</application_version>
          </sending_application>
          <sending_facility>
               <facility_name>PHS</facility_name>
          </sending_facility>
          <receiving_application>
               <application_name>i2b2_DataRepositoryCell</application_name>
               <application_version>0.2</application_version>
          </receiving_application>
          <receiving_facility>
               <facility_name>PHS</facility_name>
          </receiving_facility>
          <datetime_of_message>2000-01 31T20:59:59.222</datetime_of_message>
          <security>
               <domain>PHS</domain>
               <username>demo</username>
               <password>demouser</password>
          </security>
          <message_type>
               <message_code>Q04</message_code>
               <event_type>EQQ</event_type>
          </message_type>
          <message_control_id>
               <session_id>session id or date</session_id>
               <message_num>zsspLPVzL4wE4dZcNeFR</message_num>
               <instance_num>0</instance_num>
          </message_control_id>
          <processing_id>
               <processing_id>P</processing_id>
               <processing_mode>I</processing_mode>
          </processing_id>
          <accept_acknowledgement_type>messageId</accept_acknowledgement_type>
          <application_acknowledgement_type/>
          <country_code>US</country_code>
          </message_header>
          <request_header>
          <result_waittime_ms>180000</result_waittime_ms>
          </request_header>
     <message_body/>
</i2b2:request>


<?xml version="1.0" encoding="UTF-8"?> <i2b2:response xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xmlns:i2b2=http://i2b2.mgh.harvard.edu/message
xsi:schemaLocation="http://i2b2.mgh.harvard.edu/message ./i2b2_response.xsd">
     <message_header>
          <i2b2_version_compatible>0.3</i2b2_version_compatible>
          <hl7_version_compatible>2.4</hl7_version_compatible>
          <sending_application>
               <application_name>i2b2_DataRepositoryCell</application_name>
               <application_version>0.2</application_version>
          </sending_application>
          <sending_facility>
               <facility_name>PHS</facility_name>
          </sending_facility>
          <receiving_application>
               <application_name>i2b2_IdentityManagementCell</application_name>
               <application_version>0.2</application_version>
          </receiving_application>
          <receiving_facility>
               <facility_name>PHS</facility_name>
          </receiving_facility>
          <datetime_of_message>2000-01-31T23:59:59.222</datetime_of_message>
          <security>
               <domain>PHS</domain>
               <username>demo</username>
               <password>demouser</password>
          </security>
          <message_type>
               <message_code>Q04</message_code>
               <event_type>EQQ</event_type>
          </message_type>
          <message_control_id>
               <message_num>zsspLPVzL4wE4dZcNeFR</message_num>
               <instance_num>1</instance_num>
          </message_control_id>
          <processing_id>
               <processing_id>P</processing_id>
               <processing_mode>I</processing_mode>
               </processing_id>
          <accept_acknowledgement_type>messageId</accept_acknowledgement_type>
          <application_acknowledgement_type/>
          <country_code>US</country_code>
          </message_header>
          <response_header>
               <info url="http://phsi2b2appdev:8080/QueryProcessor/getStatus"> Some information here</info>
               <result_status>
                    <status type="DONE">1164738169521</status>
                    <polling_url interval_ms="100"> {+}http://phsi2b2appdev:8080/QueryProcessor/polling+ </polling_url>
                    <conditions>
                         <condition type="WARNING" coding_system="i2b2"> Message here</condition>
                         <condition type="ERROR" coding_system="i2b2"> Message here</condition>
                         <condition type="FATAL_ERROR" coding_system="i2b2"> Message here</condition>
                         <condition type="INFO" coding_system="i2b2"> Message here</condition>
                    </conditions>
               </result_status>
          </response_header>
     <message_body/>
</i2b2:response>

Anchor
_Toc148539252
_Toc148539252
Message Explanations

...