Author: Traci St.Martin, Tom Johnson
Email: stmartin.traci@mayo.edu
Team: LexEVS
Contract: 28SX112
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services
|
| Sign off |
Date |
Role
|
CBIIT or Stakeholder Organization
|
Johnita Beasley
|
11/11/2008
|
Overall EVS Technical Lead |
NCI EVS
|
Gilberto Fragoso
|
11/18/2008
|
EVS Infrastructure |
NCI EVS
|
Frank Hartel
|
11/17/2008
|
EVS Product Manager
|
NCI EVS
|
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.0. 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.0 is to:
- Complete EVS shift to LexBIG API (LexEVS)
- Introduce caCORE SDK based interfaces to replace EVS counterparts
- Focus on ease of adoption (EVS to LexEVS Migration)
- BDA process
- Unified OWL loader
- Model changes to prepare for resubmission for Silver/Gold compatibility in the Fall 2009
- Consistent naming/release numbers
Current Solution
EVS 4.2
Proposed Solutions
LexEVS 5.0
Functional Requirements
Each enhancement, modification or new feature is described in detail below.
GForge number
(hyperlinked) |
Brief description of functional requirement
(enhancement or new feature)
|
Iteration
(Approved or Proposed)
|
| 17509 |
Model revisions & readiness for Silver/Gold Compatibility (scope modified & approved 1/14/09) |
|
| 17511 |
Data Services - SDK |
|
| 17508 |
Build and Deployment process complete |
|
| 18449 |
2009/01 model changes: (please see Gforge tracker for more detail on the nature of the changes and further descriptions)
- Minimal changes to the query API supported by:
- Changes to database structure (includes n-1 compatibility with existing sources)
- Changes to Lucene indexing
- Change to query implementation
|
|
Functional Bug Fixes
Each bug fix included in this release is described in detail below.
GForge number
(hyperlinked) |
Brief description of bug
|
Iteration
(Approved or Proposed)
|
| 15091 |
Implement getAssociation for EVS API web service |
|
| 15222 |
Remove convenience methods for nameToCode |
|
| 15976 |
Two constructors create ConceptReferenceList methods throw exceptions |
|
| 16508 |
Example to dump/query auxiliary metadata |
|
| 16579 |
Better error handling for invalid search criteria in http interface |
|
| 16686 |
Javadocs should open in new window |
|
| 17019 |
Import RRF representation of relationship groups |
|
| 17161 |
Users should have the ability to request Search results be sorted |
|
| 17183 |
CodingSchemeID not present in exported LexGrid XML |
|
| 17233 |
Unified OWL loader |
|
| 17405 |
Remove JUnit test dependency on 'Automobiles' vocab for LexEVS Grid Services |
|
| 17410 |
Change -nf option to -fe (fail on error) |
|
| 17421 |
EntityDescription not assigned to the NCI PT (rdfs:label) using Scrubber output |
|
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
|
Iteration
(Approved or Proposed)
|
| 17507 |
Project plan for 5.0 |
|
| 17520 |
Release notes for 5.0 |
|
| 17521 |
Update Tech and Admin Guide for 5.0 |
|
| 17510 |
Create Migration Guide for 5.0 |
|
| 17502 |
Deployment to Dev Tier |
|
| 17503 |
Deployment to QA Tier |
|
| 17504 |
Deployment to Stage Tier |
|
| 17505 |
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 |
Iteration
(Approved or Proposed) |
| |
caDSR Support |
|
| |
MDR Support |
|
| |
Training and support for users migrating to LexEVS 5.0 (development team & VKC collaboration/dependency) |
|
| |
|
|
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 |
| Wil Garcia |
Project Manager/Technical |
Technical Direction and Implementation |
| Charles Griffin |
Overall LexEVS Project Manager |
Project schedule and task management |
| Tom Johnson |
Mayo Clinic Technical Project Manager/Engineering Lead |
Technical Direction and Implementation |
| Traci St.Martin |
Mayo Clinic Project Manager |
Project schedule and task management |
CBIIT Staff/Contractor Name
|
Role
|
Responsibilities
|
[caCORE:Name]
|
[caCORE:Role in this project]
|
|
| |
|
|
| |
|
|
Technical Environment
This product uses the following technical components which have been derived from the current NCICB Technology Stack.
Client Interface
|
- NCI browsers
- Programs accessing through caCORE/EVS APIs
|
| Application Server |
Jboss application server |
| Database Server |
MySQL |
Operating System
|
- Windows 2000, XP
- Unix (Sun Solaris)
|
| [caCORE:Other] |
|
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
with brief explanation added of why it was not included in this release
|
Iteration during which the item
was removed from in-scope
|
| 14971 |
Make use of logging consistent - elminate system out. We will address this if time permits |
|
| 15975 |
The NCI_Thesaurus association Has_Salt_Form and Has_Free_Acid_Or_Base needs reverse name. We will address this if time permits. |
|
| 15667 |
gov.nih.nci.evs.domain.Atom.getLUI does not return value. We will address this if time permits. |
|
| 16678 |
Serializer Exception on org.apach.lucene.search.regenex. We will address this if time permits. |
|
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:
|
https://gforge.nci.nih.gov/projects/lexevs/
|
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:
|
[caCORE: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.
|
|
