Basic Layout of Documentation on the i2b2 website #

On the Software page of the i2b2 website (http://www.i2b2.org/software) there is a section called “Documentation“. Within this section there is an image of a hive and attached to each cell you will find the available documentation specific to the cell.

When you hover over a cell a pop-up menu will appear listing all the documentation available for that cell.

List of available documentation #

The following is an outline of all the documentation that is currently available on the software page of the i2b2 website (http://www.i2b2.org/software).

The following documentation is available for the i2b2 core cells:

Data Repository Cell (CRC)

• Architecture Document
• Design Document
• Installation Guide
• Messaging Guide
• Plug-in Analysis Document

File Repository Cell

• Architecture Document
• Installation Guide
• Messaging Guide

Identity Management Cell

• Documentation is currently unavailable

Ontology Management Cell

• Architecture Document
• Design Document
• Installation Guide
• Messaging Guide

Project Management Cell

• Design Document
• Installation Guide
• Messaging Guide

Workflow Management Cell

• Architecture Document
• Design Document
• Installation Guide
• Messaging Guide

The following documentation is available for the i2b2 optional cells:

Natural Language Processing (NLP)

• Architecture Document
• Installation Guide
• Messaging Guide

PFT Processing

• Architecture Document
• Installation Guide
• Messaging Guide

The following documentation is available for the CRC Plug-ins (server side plug-ins):

Patient Counts Plug-in

• Functional Specification

The following documentation is available for the i2b2 web client:

• Startup Guide
• Project Request Guide

The following documentation is available for the i2b2 Workbench and Plug-ins:

i2b2 Workbench

• Installation Guide
• Tutorial Document
• Developer’ Guide

Annotator Plug-in (workbench feature)

• Help Guide

Correlation Analysis Plug-in (workbench feature)

• Design Document
• Installation Guide
• Messaging Guide

Export Data Plug-in (workbench feature)

• Help Guide

High Performance Computing Plug-in (workbench feature)

• Design Document
• Installation Guide
• Messaging Guide

Import Data Plug-in (workbench feature)

• Help Guide

Table View Plug-in (workbench feature)

• Help Guide

Text Analyzer Plug-in (workbench feature)

• Help Guide