Author: Traci St.Martin/Craig Stancl
Email: stmartin.traci@mayo.edu
Team: LexEVS
Contract: 28XS112
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services
Sign off | Date | Role | CBIIT or Stakeholder Organization |
|---|---|---|---|
Hartel | 7/2/09 | PM | NCI EVS |
Raghu | 7/2/09 | PM | caDSR and EVS Project Manager |
The purpose of this document is to collect, analyze, and define high-level needs and features of the National Cancer Institute Center for Biomedical Informatics and Information Technology (NCI CBIIT) caCORE LexEVS Release 5.1. This document focuses on the functionalities proposed by the product stakeholders and target users in order to make it a better product. The use-case and supplementary specifications document will detail how the framework will fulfill these needs.
Vision and Needs
The objective of this release of the LexEVS 5.1 is to support the Metathesaurus Browser project by enhancing search and sorting performance as well as RRF loader changes to more accurately reflect the data. In addition we will explore enhancements to the loader framework and provide a recommendation/implementation for value set/domain support.
Current Solution
LexEVS 5.0
Proposed Solutions
LexEVS 5.1
Functional Requirements
Each enhancement, modification or new feature is described in detail below.
GForge number | Brief description of functional requirement | Status | Iteration |
|---|---|---|---|
Value Set Support recommendation/implementation | — | — | |
Improved loading framework | — | — | |
Ability to load custom data - custom loading feasibility/recommendation report | — | — | |
BDA support for 5.1 | — | — | |
--- | Update RRF loader to support Metathesaurus (Please see GForge items below) | — | — |
--- | Improve the API to efficiently support expanded search options and large concept relationships sets (Please see Gforge items below) | — | — |
Functional Bug Fixes
Each bug fix included in this release is described in detail below.
GForge number | Brief description of bug | Status | Iteration |
|---|---|---|---|
The NCI_Thesaurus association Has_Salt_Form and Has_Free_Acid_Or_Base needs reverse name | — | — | |
Unescaping XML character data in complex properties | — | — | |
User question about Metathesaurus Term-group | — | — | |
Displaying multiple concept status. | — | — | |
SNOMED Full Name instead of Full form. | — | — | |
Lucene Max Clause Count exceeded on broad NCI MetaThesaurus RegExp Restrictions | — | — | |
ResourceManager cache not Thread-safe | — | — | |
Add data from MRSAT file to NCI Meta data | — | — | |
MRSAB conifgured to load for NCI Meta data | — | — | |
MRREL data for NCi Meta - needs more data loaded | — | — | |
Load MRRANK data for NCI Meta | — | — | |
Load all MRMAP data | — | — | |
Add some additional data from MRHIER | — | — | |
Make sure MRDOC data for NCI Meta is loaded | — | — | |
Add more data from MRDEF file for NCI Meta | — | — | |
Add data from MRCONSO file to NCI Meta data | — | — | |
CodedNodeGraph resolveAsList distributed method encountered Jaa heap space error | — | — | |
Heap space error on Double Metaphone MetaThesaurus query | — | — | |
Add an algorithm for supporting case-insensitive substring search. | — | — | |
Add a search algorithm for supporting case-insensitive substring search with an additional spelling-error tolerant feature. | — | — | |
Add a sort option for ranking matched concepts by similarity score. | — | — | |
Improve error messages (e.g., CNS.resolve, CNS.resolveToList, CNG.resolveToList) | — | — | |
Make sample programs (in the examples folder) runnable under both local and distributed modes. | — | — | |
Improve ResolvedConceptReferencesIterator performance by reducing client-server network traffic in distributed mode. | — | — | |
Connection Leak on SQLImplementedMethods 'mapToCodingSchemeName' | — | — | |
OWL loader processing associations incorrectly | — | — | |
Optimize Lucene code to improve search performance | — | — | |
Implement a server side sort to improve performance | — | — |
Non-Functional Requirements
This section describes in detail all the related requirements which must be met for this release but do not add functionality. These requirements are included in the scope and project plan due to level of effort or relative importance to the overall success of delivery of the release.
GForge number (hyperlinked) | Brief description of non-functional requirement | Status | Iteration |
|---|---|---|---|
Project plan for 5.1 | — | — | |
Test plan & test results | — | — | |
Design and Implementation plan | — | — | |
Release notes for 5.1 | — | — | |
Updated programmer's guide and users guide documentation on VKC Wiki for 5.1 | — | — | |
5.1 Deployment to Dev Tier | — | — | |
5.1 Deployment to QA Tier | — | — | |
5.1 Deployment to Stage Tier | — | — | |
5.1 Deployment to Production Tier | — | — |
General Support Activities
This section describes in detail all the related activities which must be performed for this release but do not add functionality. These activities are included in the scope and project plan due to level of effort or relative importance to the overall success of delivery of the release.
GForge number (hyperlinked) | Brief description of general support activity | Status | Iteration |
|---|---|---|---|
— | Identify any 5.x/6.x requirements from caCORE teams as they migrate from EVS 3.x to LexEVS | — | — |
Stakeholder Summary
Customer Name | Role | Interest/Need |
|---|---|---|
George Komatsoulis | NCICB Application Infrastructure | Oversees NCICB Application Infrastructure |
Avinash Shanbhag | NCICB Application Infrastructure | Oversees NCICB caCORE Software Engineering |
Frank Hartel | EVS Product Manager | Directs EVS Projects |
Denise Warzel | CORE Product Line Manager | Trans-CORE requirement coordination |
Gilberto Fragoso | Associate Director EVS Infrastructure | Technical Direction |
Jason Lucas | NCI Metathesaurus Browser Project Manager | Project schedule and task management for browser team |
Raghu Chintalapati | EVS Project Manager | Project schedule and task management |
Craig Stancl | Mayo Clinic Technical Lead | Technical Direction and Implementation |
Traci St.Martin | Mayo Clinic Project Manager | Project schedule and task management |
Larry Brem | SAIC caBIG ARCH and VCDE Technical Program Manager | Contract governance |
Technical Environment
This product uses the following technical components which have been derived from the current NCICB Technology Stack.
Client Interface |
|
|---|---|
Application Server | Jboss application server |
Database Server | MySQL |
Operating System |
|
Product Dependencies
This release is dependent on the caCORE components or products documented in the CORE Product Dependency Matrix.
Out of Scope Items
Items that are out of scope were evaluated as part of the initial scoping activities for this release, and subsequently not included in the final approved scope. These items are also documented in the cumulative backlog of requirements found on the product GForge site. They include out-of-scope functional requirements (enhancements or new features), bug fixes, non-functional requirements, and general support activities.
GForge number (hyperlinked) | Brief description of item moved from the in-scope section | Iteration during which the item |
|---|---|---|
gov.nih.nci.evs.domain.Atom.getLUI does not return value. Per the tracker, Consensus says to deprecate. Lexbig does not load LUI and no user has noticed. Therefore this bug is deferred. | Inception | |
Serializer Exception on org.apache.lucene.search.regex.JavaUtilRegexCapabilities. Per the tracker, I've replicated what this method does and and called it outside the DLBAdapter and things work fine. Therefore this bug is deferred due to low priority. | Inception | |
Results not Deserializing Properly when using QueryModifiers on CQL Queries. This bug was discussed in our technical meeting and is deferred due to low priority | Inception | |
Not all concept status property values are accessible through the API. This item has been discussed and is deferred due to low priority | Inception | |
Anonymous class hierarchy with unions not showing up correctly. This item has been discussed and is not an issue for 5.0. Deferred due to low priority | Inception | |
Ontology for Genetic Interval hierarchy does not match up Protege. This item has been discussed and is not an issue for 5.0. Deferred due to low priority | Inception | |
ECG Ontology missing Description, Date, Source and Creator fields. This item has been discussed and is not an issue for 5.0. Deferred due to low priority | Inception | |
Cannot compute root node for OBI version v1.0.1423. This item has been discussed and is not an issue for 5.0. Deferred due to low priority | Inception | |
Strict Owl Processing. This item has been discussed and is not an issue for 5.0. Deferred due to low priority | Inception |
Document History
Document Version: | Click the Info tab. View the Recent Changes or click the link to view the page history. |
|---|---|
Last Modified: | Refer to the first line displayed in the document window. |
Project GForge site: | LexEVS GForge project Docs archive, Files archive |
Most current version: | Unless the display includes a notice that you are viewing a previous version, you are viewing the most current version of this Scope Document for the release indicated in the title. |
Revision history: | Click the Info tab. In the Recent Changes area, click the link to view the page history. |
Review history: | Click the Info tab. In the Recent Changes area, note the developer who made each change and the date and time. Refer to the Key People Directory for their roles. Click the link to view any page or to view the page history, and then click the link for a page. When the page opens, view the comments and changes made in that version. |
Related documents: | [EVS:Name and URL of each related document] |
Project Information
CBIIT Management | Role | Responsibilities |
|---|---|---|
Frank Hartel | Product Manager | Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release |
Avinash Shanbhag | Engineering Manager | Oversees NCICB caCORE software engineering practices, conducts design reviews, guides technical development |
Denise Warzel | Product Line Manager | Oversees NCICB caCORE product line. Responsible for overall product integration, major and minor release cycles. Supports Product Manager. |
