Page History
...
i2b2 Cell Messaging
...
Document Version: | 1.6.1 |
I2b2 Software Release: | 1.6 |
| Anchor | ||||
|---|---|---|---|---|
|
Table of Contents
Document Management
Introduction
The i2b2 Hive
i2b2 Messaging Overview
XSD Files for i2b2 XML Schema
i2b2.xsd
i2b2_request.xsd
i2b2_response.xsd
i2b2 Messaging Detail
Use Cases
Services / Messages
Sequence Diagrams
XML Schema Definitions
i2b2.xsd
i2b2_request.xsd
i2b2_response.xsd
Example Messages
Request Example Message
Response Example Message
Message Explanations
Request Description
Response Description
Status Type "DONE"
Status Type "PENDING"
Status Type "ERROR"
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
Revision Number | Date | Author | Description of change |
1.6.1 | 10/12/10 | Janice Donahoe | Formatted for wiki |
|
|
|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
The Informatics for Integrating Biology and the Bedside (i2b2) is one of the sponsored initiatives of the NIH Roadmap National Centers for Biomedical Computing (http://www.bisti.nih.gov/ncbc/). One of the goals of i2b2 is to provide clinical investigators broadly with the software tools necessary to collect and manage project-related clinical research data in the genomics age as a cohesive entity - – a software suite to construct and manage the modern clinical research chart. The i2b2 hive is a set of cells or modules that have a common messaging protocol that allow the cells to interact using web services and XML messages.
...
All cells in the i2b2 hive must communicate using standard i2b2 XML messages. This message specifies certain properties that are common to cells and essential to the administration tasks associated with sending, receiving and processing messages.
All requests are sent using a <request> tag and responses are returned using a <response> tag. The same <message_header> tag is used for both. The <request_header> is used for requests but may optionally be echoed back in the response. The response must include a <response_header>.
The XSD specification of the i2b2 message permits individual cells to add cell-specific XML in the <message_body> tag. This cell-specific XML need not extend the i2b2 message schema since the i2b2 schema will allow insertion of tags from any namespace into the <message_body> tag.
The following image illustrates the basic top-level elements contained within the request and response messages.
| Anchor | ||||
|---|---|---|---|---|
|
...
All i2b2 cells must satisfy one specific use case which is to communicate. The specific types of communication are defined by each cell. Any client of an i2b2 cell must communicate by sending a message to the cell and the cell responds by sending a response. The generic cell communication is defined in this document which the cell-specific communication is described in each cell messaging document.
| Anchor | ||||
|---|---|---|---|---|
|
Each cell in the i2b2 Hive must communicate via web services using the XML messages that can be validated by the i2b2_request.xsd and i2b2_response.xsd schemas. The actual services provided by a cell depend on its use case. Cell-specific xml must be placed inside the <message_body> section of the i2b2 request or response. Each cell must describe its services and message sets in the document defining messaging for that cell.
The generic i2b2 request is satisfied by a <request> message which contains a <message_header>, <request_header> and <message_body>.
The generic i2b2 response is satisfied by a <response> message which contains a <message_header>, <response_header> and <message_body>. The response may optionally echo the <request_header> back to the client.
...
All i2b2 cells must satisfy the generic use case of communicating messages. The typical scenario for a communication between any client and any cell is illustrated below. The client sends a <request> message and the cell returns a <response> message. This basic behavior is the same regardless of the outcome or status of the request.
| Anchor | ||||
|---|---|---|---|---|
|
...
<?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 | ||||
|---|---|---|---|---|
|
<?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>
...
