Version 6.4.1 October, 2016
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 environments. The LexEVS API serves users who want programmatic access to the data made available by LexEVS.
LexEVS 6.4.1 is the current embodiment of work started under the LexBIG project (LexGrid Vocabulary Services for caBIG®). This technology was 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 (see EVS Use and Collaborations). 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 both controlled terminologies available from the NCI EVS Downloads page and other supported 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 at their own sites. 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.
LexEVS includes the following components:
- Terminology Server - An enterprise level terminology server
- Java API - A Java interface based on the LexGrid Object Model
- CTS2 1.1 compliant REST interface
- 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
- 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 applications. 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.
After you have a chance to get familiar with the LexEVS suite, consider looking through the LexEVS 6.4.1 Functionality Overview. This lays out everything that can be done from a developer's or ontologist's point of view.
Installation and Downloads
The installation overview provides an introduction to the different environments that can be installed. Refer to the LexEVS 6.x Installation Guide for more information.
The LexEVS 6.4.1 Installation Options identify the download files for each LexEVS environment that can be installed (Local Runtime, Distributed, and Grid Services).
The 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.
Forum and Support
LexEVS Issues and Discussion
Users and developers can report and discuss issues regarding the LexEVS application on its GitHub site.
What's New in LexEVS 6.4.1
LexEVS Lucene upgrade, LexEVS Loader Enhancements, new HTTPS Requirements, Admin script updates, and Resolved Defects
LexEVS 6.4.1 provides an upgrade to Lucene, the underlying search engine, additional OWL2, HL7 and other loader enhancements, ability to run services over HTTPS, and updates to existing admin scripts.
CTS2 References on this Wiki
Also included in this package (refer to LexEVS 184.108.40.206 Release Notes):
- Bug fixes
The contribution process is described in LexEVS Community Code Contribution. LexEVS source code is in the NCIP channel of Github
Presentations, Demos, and Other Materials
Refer to LexEVS Presentations.
- 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 6.x 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 6.x Installation Guide.
- LexEVS Example Code zip file. These are code examples for subjects of frequently asked questions such as creating a coded node graph using the LexBIG convenience methods.
Documentation and Training
- LexEVS 220.127.116.11 Release Notes
- LexEVS 6.x Installation Guide - outlines the supported configurations and technical installation instructions for LexEVS Vocabulary Services
- LexEVS 6.x Administration Guide - outlines the environment configuration from the perspective of an existing installation
- LexEVS 6.x Programmer's Guide - explains the LexEVS API (services, extensions, utilities, and GUI); also many related APIs
- LexEVS 6.x Design and Architecture Guide - explains the LexGrid model and the LexBIG services
- LexEVS 6.x Value Set and Pick List Definition Guide - explains the LexEVS 6.x Value Set and Pick List Definition documentation
- LexEVS 6.x 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 6.x OWL Export Guide - explains the steps necessary to export content in OWL/RDF format
- LexEVS 6.4 Javadocs download - has several parts to consult depending on what you are looking for. One download includes all the Javadocs.