NIH | National Cancer Institute | NCI Wiki  

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup

Page info

titleContents of this Page
Table of Contents

Include Page
VKC:VKC Quick Links to Include
VKC:VKC Quick Links to Include

Wiki Markup
{multi-excerpt:name=LexEVSAtaGlance}{panel:title=At a Glance Details}
* Version Number and Release Date: v6.0.4 April, 2012
* Primary audience: System administrators (Server); Developers (API)
* caBIG® Tool Bundle: None
* Grid Enabled? Yes
* Compatibility Level: Silver
* Installation Level: Intermediate - technical assistance may be required, download may require supporting infrastructure or software
* System Requirements: Refer to [LexEVS 6.0 Prerequisite Software and Supported Platforms|LexEVS:2 - LexEVS 6.0 Prerequisite Software and Supported Platforms].

Tool Overview

Wiki Markup
LexEVS is the central EVS terminology server, developed by the Mayo Clinic with NCI and other support. LexEVS provides a common terminology model and open access to a wide range of terminologies, terminology value sets, and cross-terminology mappings needed by NCI and its partners. For users wanting to install and run a local instance of LexEVS, the LexEVS server package provides a comprehensive set of software and services to load, publish, and deploy vocabulary in a variety of web-enabled and grid environments. The LexEVS API serves users who want programmatic access to the data made available by LexEVS.

LexEVS 6.0 is the current embodiment of work started under the LexBIG project (LexGrid Vocabulary Services for caBIG®). This technology has been adopted as the strategic infrastructure for the caBIG® community and NCI's Enterprise Vocabulary Services (EVS).

NCI's EVS is a big user of the LexEVS services, but there are many others. You can consume controlled terminologies hosted by NCI's EVS without setting up your own servers to do so. Seeing what NCI has done with EVS is a good way to learn about what LexEVS can do. Refer to the [EVS Wiki|] for further information.

LexEVS provides a collection of programmable interfaces, affording users and developers open access to either controlled terminologies available from the [NCI EVS Project|] or their own terminologies. NCI's installation of LexEVS is not only a tool for the community to use, but also an example of what developers can build their own organization. By building an installation of LexEVS, an organization can control the content and have any set or subset of terminologies and mappings. One installation can be used by multiple applications in an enterprise.

Wiki Markup
{multi-excerpt:name=LexEVS6.0a}LexEVS includes the following components: 

* Terminology Server - An enterprise level terminology server
* Java API - A Java interface based on the LexGrid Object Model 
* REST/HTTP Interface - Offers basic HTTP based query mechanism from which results are returned in either XML or HTML formats 
* SOAP/Web Services Interface - Provides a programming language neutral Service-Oriented Architecture (SOA) 
* Distributed API - A Java interface based on the LexGrid data model and relies on a LexEVS Proxy and *Distributed LexEVS Adapter to provide remote clients access to the native LexEVS API 
* LexEVS Grid Services - An interface which uses the caGRID infrastructure to provide access to the native LexEVS API via the caGRID Services
* Developers GUIs - Server administration, query testing, and value set development can be performed by a developer

The name LexEVS highlights the merging of LexGrid, LexBIG, and EVS technologies and designates an entire suite of tools. In this suite, LexGrid is the underlying model for standard storage of controlled vocabularies and ontologies. The LexBIG API is the set of services that EVS adapters use to store and retrieve terminology metadata. LexEVS APIs are a combination of convenience methods and the LexBIG API (combining LexBIG and the EVS adapters into one set of services). For detailed information, refer to the [LexEVS architecture overview|LexEVS:LexEVS 6.0 Architecture].

After you have a chance to get familiar with the LexEVS suite, consider looking through the [LexEVS:LexEVS 6.0 Functionality Overview]. This lays out everything that can be done from a developer's or ontologist's point of view.

h2. Installation and Downloads 

The [installation overview|LexEVS:1 - LexEVS 6.0 Installation Overview] provides an introduction to the different environments that can be installed. Refer to the [LexEVS:LexEVS 6.0 Installation Guide] for more information.

The [LexEVS:LexEVS 6.0 Installation Options] identifies the download files for each LexEVS environment that can be installed (Local Runtime, Distributed, and Grid Services).

The [LexEVS:LexEVS Widget Library] lists many widgets that have been developed for use by particular customers. These widgets have been found to be potentially useful to a wider audience. Each widget has a description for you to use in deciding if you'd like to dig deeper and find out the usefulness of the widget in your application.

{include:VKC:Code Download Disclaimer to Include}

h2. Forum and Support{multi-excerpt}

Wiki Markup
{multi-excerpt:name=LexEVSSupportLinks}* [LexEVS FAQ]
Please visit our FAQs especially if you are new to LexEVS.

* [LexEVS End User forum |]
Forum for end users to discuss and submit support issues regarding the LexEVS application.

* [LexEVS Developer forum |]
Forum for developers to discuss and submit support issues regarding the LexEVS API.

* [LexEVS Documentation Feedback forum|]
Forum for all users to discuss and submit support issues regarding the LexEVS documentation.

* [Bug Tracker for LexEVS|] 
Please visit the LexEVS Jira project for bug and feature requests related to LexEVS.

* If you find the above mechanism are not going to work for you please contact [Application Support (email)|].{multi-excerpt}

Wiki Markup
{multi-excerpt:name=LexEVS6.0b}h2. What's New 

LexEVS 6.0 is the latest release. This release focuses primarily on alignment with standards. Other significant functionality added, especially in the areas of authoring APIs, value sets, mappings, and exporters top the list of enhancements, is:

* Comprehensive support of the [Common Terminology Services - Release 2|VKC:Common Terminology Services 2] functionality as described in the [Health Level Seven (HL7)|VKC:Health Level 7] CTS 2 Draft Standard for Trial Use ([DSTU|]).
* LexGrid Model and database updates to support CTS 2 (_See_ _[LexEVS:LexEVS 6.0 Information Models]_)
* Loader and data access layer changes to support CTS 2 functions
* Additional versioning and value set and picklist functionality to support CTS 2 functions (_See_ _[LexEVS:LexEVS 6.0 Value Set and Pick List Definition Guide]_)
* New OWL/RDF Exporter (_See_ _[LexEVS:LexEVS 6.0 CTS2 Administration 2 - Export Operation API]_)
* XML exporter enhancements to provide filtered export of code system (_See_ _[LexEVS:LexEVS 6.0 CTS2 Administration 2 - Export Operation API]_)
* New Authoring API services to support CTS 2 functions (_See_ _[LexEVS:LexEVS 6.0 CTS2 Authoring 2 - Code System Authoring Operation API]_)
* New Query API services to support CTS 2 functions (_See_ _[LexEVS:LexEVS 6.0 CTS2 Query 3 - Concept Domain Query Operation API]__,_ _[LexEVS:LexEVS 6.0 CTS2 Query 4 - Usage Context Query Operation API]__,_ _[LexEVS:LexEVS 6.0 CTS2 Query 5 - Value Set Query Operation API]_)
* Associations and mappings enhancements to support CTS 2 functions and user requirements (_See_ _[LexEVS:LexEVS 6.0 CTS2 Authoring 1 - Association Authoring Operation API]_)

{tip:Migration for Previous Releases}For help with a migration from previous releases, refer to the [LexEVS:LexEVS 6.0 Migration Tips for 5.x Users]. To see any of the previous releases, refer to the [LexEVS roadmap|LexEVS:LexEVS Release Roadmap].{tip}

h2. Presentations, Demos and Other Materials

h3. Presentations{multi-excerpt}

Wiki Markup
{multi-excerpt:name=LexEVSPresentations}* [LexEVS 6.0 Highlights Presentation|LexEVS 6.0^LexEVS_6.0_Highlights.ppt] (397 KB)
Scott Bauer
February 17, 2011

* [LexEVS REST APIs demo at HHS and NIH the Health 2.0 Hack-a-Thon|LexEVS:Hack-A-Thon 2011 NCI Blue - LexEVS REST API]
Larry Brem
June 11, 2011

* [caBIG® Annual Meeting Semantic Infrastructure v2|]
Charlie Mead, Jane Brzozowski, Cecil Lynch, Raghu Chintalapati, Craig Stancl
September 14, 2010

* [LexEVS 101 Presentation|LexEVS:LexEVS Presentations^LexEVS_101.ppt] (1.6 MB)
Craig Stancl and Rick Kiefer
February 22, 2010

* [Value Domain and Pick List Support in LexEVS 5.1|LexEVS:LexEVS Presentations^CaBIG_ValueDomain_PickList_presentation_102009.ppt] (775 KB)
Sridhar Dwarkanath
caBIG® VCDE and Architecture joint workspace meeting - Atlanta, GA
October 20-22, 2009

* [LexEVS:LexEVS 5.0 Boot Camp] (Presentations Given at the Bootcamp)
LexEVS team
NCI CBIIT Training facility - Rockville, Md.
November 17-19 2009

* [LexEVS Overview|LexEVS:LexEVS Presentations^200907_LexEVS_Annual_Meeting_FINAL.ppt]  (12.5 MB)
LexEVS team
2009 caBIG® Annual Meeting - Washington, D.C.
July 20-22, 2009
Presentation to NCCH - Australia
March 2, 2009

* [LexBIG/LexGrid Services for LexBIG 2.3 Model and API for the Grid|LexEVS:LexEVS Presentations^LexBIG_LexGrid_(2).ppt]
H. Scott Bauer and Kevin Peterson
Presentation to NCCH - Australia
March 2, 2009

* [Terminology Tool Announcements|LexEVS:LexEVS Presentations^Terminology_Tool_Announcements2.ppt]
Kevin Peterson
caBIG®; VCDE and Architecture joint workspace meeting -  - Cambridge, Massachusetts
May 12, 2009{multi-excerpt}

Wiki Markup
{multi-excerpt:name=LexEVS6.0c}h3. Examples

* Query Service with Program Examples, included in the LexEVS base installation. Both Lexical Set Operations and Graph Operations are included for common vocabulary functions using a sample vocabulary and CodedNodeSet. This is described in the [LexEVS:LexEVS 6.0 Installation Guide].
* Example Programs and Verification Test Suite, included in the LexEVS base installation. The Example Programs provide a limited interactive demonstration of LexEVS capabilities. Both are explained in the [LexEVS:LexEVS 6.0 Installation Guide].
* Code examples, [LexEVS Example Code zip file available on GForge|]. These are code examples for subjects of frequently asked questions such as creating a coded node graph using the LexBIG convenience methods.

h2. Documentation and Training

* [Release Notes and Readme|LexEVS:LexEVS 6.0 Download Files#LexEVS Release Notes]
* [LexEVS:LexEVS 6.0 Installation Guide] - outlines the supported configurations and technical installation instructions for LexEVS Vocabulary Services for caBIG®
* [LexEVS:LexEVS 6.0 Administration Guide] - outlines the environment configuration from the perspective of an existing installation
* [LexEVS:LexEVS 6.0 Programmer's Guide] - explains the LexEVS API (services, extensions, utilities, and GUI); also many related APIs
* [LexEVS:LexEVS 6.0 Design and Architecture Guide] - explains the LexGrid model and the LexBIG services
* [LexEVS:LexEVS 6.0 Value Set and Pick List Definition Guide] - explains the LexEVS 6.0 Value Set and Pick List Definition documentation
* [LexEVS:LexEVS 6.0 Loader Guide] - intended for a LexEVS developer and provides information about the loaders provided, mapping, and how to create your own loaders using the loader framework
* [LexEVS:LexEVS 6.0 OWL Export Guide] - explains the steps necessary to export content in OWL/RDF format
* [LexEVS:LexEVS in SpringSource MVC Maven Project] guide - shows how to use a local instance of LexEVS in a Spring 3.0.x MVC project and how to deploy it to a Tomcat server from within the SpringSource Tool Suite.
* LexEVS 6.0 Javadocs - There are several parts to the LexEVS Javadocs to consult depending on what you are looking for. To download any of the Javadocs, go to the [Javadocs section|LexEVS:LexEVS 6.0 Download Files#LexEVS Source Code.2C JavaDocs.2C and Examples] on the downloads page. You will find one download including all the Javadocs.
** If you have a local application accessing a Local Runtime, view the [Local Runtime Javadoc|] online.
** To interact with a LexEVS server that is hosting terminologies remotely, whether it be your own or the services at NCI, view the [Distributed Javadoc|] online.
** If you are using the Grid Analytical Services, view the [Grid Analytical Services Javadoc|] online.
** The Grid Data Service for LexEVS sits behind a caGrid interface. Most users do not reach this service via the Java API and in fact only a single method in the caGrid API is of interest. It can be found in the [Grid Data Service Implementation|].

No formal LexEVS Server training courses exist in the caBIG® Learning Management System (LMS) at this time.

h2. Contributions

In the spirit of open source caBIG® invites you to participate in the community.  The contribution process is described in [LexEVS:LexEVS Community Code Contribution]. LexEVS source code is in [NCI SVN|].

h2. Related Tools 

* [Biomed GT Wiki|EVS:BiomedGT Wiki]
* [NCI Protégé|Protege:NCI Protege]
* [NCI Term Browser|EVS:NCI Term Browser]
* [NCI Thesaurus|EVS:NCI Thesaurus (NCIt)]
* [NCI Metathesaurus|EVS:NCI Metathesaurus (NCIm)]{multi-excerpt}

Wiki Markup