Document Information

Author: Traci St.Martin/Craig Stancl
Email: stmartin.traci@mayo.edu, stancl.craig@mayo.edu
Team: LexEVS
Contract: RFP 10-ST1099
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services

Contents

Sign off	Date	Role	CBIIT or Stakeholder Organization

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 6.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 API is to design and construct a reference implementation of the CTS2 specification, leveraging LexEVS as the basis for the design and code base.

This release will address support for value sets, mappings between code sets, support for creation of local extensions to code sets and support related to content creation and editing.

Current Solution

LexEVS 5.1 currently supports much of the functionality called for by the CTS2 Specification.

Proposed Solutions

LexEVS 6.0 will provide the additional functionality to enhance LexEVS to meet the goals of a CTS2 Reference Implementation and requirements of the user communities.

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)	Status (Approved or Proposed)	Iteration
26638	OBO Loader update for LexEVS 6.0
26640	NCIt/OWL loader update for LexEVS 6.0
26641	Query enhancements for CTS2 Implementation LexEVS 6.0
26642	XML Exporter update for LexEVS 6.0
26643	NCIm Loader updates for LexEVS 6.0
26644	HL7 loader update for LexEVS 6.0
26645	Coding Scheme Supplement Changes for LexEVS 6.0
26646	Usage context enhancements for LexEVS 6.0
26648	Associations (maps) enhancements for LexEVS 6.0
26649	Concept Domain enhancements for LexEVS 6.0
26650	Value Set Enhancements for LexEVS 6.0
26651	Versioning enhancements for LexEVS 6.0
26652	XML loader update for LexEVS 6.0
26653	ICD10 loader update for LexEVS 6.0
26654	ICD 9 loader update for LexEVS 6.0
26655	UMLS loader update to support LexEVS 6.0
26656	Database changes to support LexEVS 6.0
26657	LexGrid model changes for LexEVS 6.0
26658	LexBIG model changes for LexEVS 6.0
26659	DAO layer changes for LexEVS 6.0 CTS2 Implementation
27829	Text loader update for LexEVS 6.0
27831	Manifest loader update for LexEVS 6.0
27838	Notification enhancements for LexEVS 6.0
27839	OBO Exporter update for LexEVS 6.0
27840	Associations Exporter for LexEVS 6.0
27841	Protege Frames Loader update for LexEVS 6.0
27842	Loader Preferences Loader update for LexEVS 6.0
27843	Authoring enhancements for CTS2 Implementation LexEVS 6.0
27844	ISO 21090 Data Type Support enhancements for CTS2 Implementation LexEVS 6.0
27845	Grid Service enablement CTS2 Implementation LexEVS 6.0
28166	GEM loader update for LexEVS 6.0
28167	ClaML Loader update for LexEVS 6.0

Functional Bug Fixes

Each bug fix included in this release is described in detail below.

GForge number (hyperlinked)	Brief description of bug	Status (Approved or Proposed)	Iteration
21935	OWL loader processing <owl:Restriction> associations incorrectly
22036	Focus code data is not found when referencing external coding scheme
24037	Include immediate parent/children when Value Domain Definition has transitiveClosure as 'false' and referenceAssociation is present
24538	"Pages" links not being built correctly in LexEVS caCORE SDK Service
25042	OBI load shows odd has_curation_status property
25325	The isDefined column in the entity table should accurately reflect the source data
26072	Incorrect Hibernate mappings of Oracle CLOB database type in caCORE SDK functions
26975	PropertyLinks won't load without namespace being supplied
26976	Loader should not shut down on a duplicate property
26977	Loader should not shut down on missing propertylink reference
22296	OWL loader does not load concepts with paranthesis
25681	Problem loading MeSH and Spanish version of SNOMED
24967	Null-Pointer Exception Thrown when no value-Domain content loaded.
23770	OBI.owl loading - missing property "has curation status" for concepts
23806	OBI.owl loading - Incorrect infromation as value to the property "imported from"
19406	Results not Deserializing Properly when using QueryModifiers on CQL Queries
21720	Load all MRMAP data
23643	Java 1.6
26329	Control the setting of isActive via Loader preferences
27026	Modify Meta Browser Extension to support browsing and searching of other applicable source hierarchies.
23324	Option to include or exclude anonymous concepts.
24699	Need to be able to identify all supported properties of a particular property type.
25509	Convert codes in entity description of anonymous class to names.
26627	Ability to keep database load if indexes fail.
26637	Page CodedNodeGraph Results
26683	Option to include or exclude entity types in association search.
26709	Examine use of LexBIG entity status
28120	Provide XSLT transformations for backwards compatability of LexBIG XML
24191	A call for requirements for the HL7.OWL loader with an emphasis on top nodes

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 (Approved or Proposed)	Iteration
26660	LexEVS 6.0 Project Charter
27849	LexEVS 5.0 Silver Level Review
27854	LexEVS 6.0 Silver Level Compatibility Review Submission Package
27856	BDA Compliance Package update for LexEVS 6.0
27857	Release Notes for LexEVS 6.0
27859	LexEVS Product Documentation (Wiki Guides) for LexEVS 6.0
27860	LexEVS NCI/NCICB website updates for LexEVS 6.0
27861	LexEVS 6.0 ECCF Documentation
27862	LexEVS 6.0 System and Software Design Document
27863	LexEVS 6.0 Design Review Package
27864	LexEVS 6.0 Deliverable Readiness Review Package
28159	6.0 Deployment to Dev Tier
28161	6.0 Deployment to QA Tier
28162	6.0 Deployment to Stage Tier
28163	Project plan for 6.0
28164	6.0 Test Plan & Test Results
28165	6.0 Use Case Document
28168	6.0 ARC Document
28169	6.0 Prototype 1
28170	6.0 Prototype 2
28172	6.0 Prototype 3
28173	6.0 Alpha 1
28174	6.0 Alpha 2
28175	6.0 Deployment to Production Tier
28177	6.0 Production Announcements

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 (Approved or Proposed)	Iteration
	Example, "Level 2 Support, integration of help and training to the user community."

Stakeholder Summary

Customer Name	Role	Interest/Need
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd240619-6a9a-4495-bd77-e7f523b661d2"><ac:plain-text-body><![CDATA[	[Name]	[Title or role]	]]></ac:plain-text-body></ac:structured-macro>

CBIIT Staff/Contractor Name	Role	Responsibilities
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b461168f-6c69-4ff4-8862-8f6e7483939a"><ac:plain-text-body><![CDATA[	[Name]	[Role in this project]	]]></ac:plain-text-body></ac:structured-macro>

Technical Environment

This product uses the following technical components which have been derived from the current NCICB Technology Stack.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2150e830-54d2-4627-b643-72212de2a9a5"><ac:plain-text-body><![CDATA[	Client Interface	[Example, Internet Explorer 6.0 and above]]]></ac:plain-text-body></ac:structured-macro> <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8b09d694-5721-4cda-b32e-f36a9d03dd71"><ac:plain-text-body><![CDATA[* [Example, Mozilla v. 1.5.0.3 and above]	]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="18537c74-9de3-464e-bedd-3a3fc1b30f14"><ac:plain-text-body><![CDATA[	Application Server	[Example, Apache Tomcat 5.5.9]	]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4f732fa1-e883-4711-82db-c2a24b4579aa"><ac:plain-text-body><![CDATA[	Database Server	[Example, Oracle 9i]	]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a4ac00a1-b6be-45ec-a74a-f32de191d46c"><ac:plain-text-body><![CDATA[	Operating System	[Example, Windows 2000. XP, Vista]]]></ac:plain-text-body></ac:structured-macro> <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="dd564afc-27cc-4812-beb7-b229219530e9"><ac:plain-text-body><![CDATA[* [Example, Unix (Sun Solaris)]	]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e967a1a5-9628-4a6a-8729-d7bc32f721b7"><ac:plain-text-body><![CDATA[	[Other]		]]></ac:plain-text-body></ac:structured-macro>

Product Dependencies

This release is dependent on the caCORE components or products documented in the CORE Product Dependency Matrix.

[Provide additional explanation as applicable. For example, "The EVS vocabulary systems are used by the Java client to retrieve and validate concept information for naming and defining meanings."]

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

21880	Make sample programs (in the examples folder) runnable under both local and distributed modes. Deferred due to low priority.	Inception
22644	Need to be abe to uniquely identify the coding scheme to which a concept belongs. Deferred due to low priority.	Inception
22877	MedDRA loading into LexEVS. Deferred due to low priority.	Inception
24812	Spruce up MetaDataLoader GUI. Deferred due to low priority.	Inception
25071	Enhance LexBIG query API to fetch AssociationData objects. Deferred due to low priority.	Inception
27164	Better validation on restrictions. Deferred due to low priority.	Inception
28147	Need an option to exclude the focused node itself from ResolvedConceptReferenceList when resolving a CNG. Deferred due to low priority.	Inception
28147	Need an option to exclude the focused node itself from ResolvedConceptReferenceList when resolving a CNG. 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.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="30099bfa-2cc6-41f2-986e-06c1ac92f6bf"><ac:plain-text-body><![CDATA[	Project GForge site:	[Project GForge site link]	]]></ac:plain-text-body></ac:structured-macro>
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.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0538506e-a2af-4a98-94e1-976f26e11efa"><ac:plain-text-body><![CDATA[	Related documents:	[Name and URL of each related document]	]]></ac:plain-text-body></ac:structured-macro>

Project Information

CBIIT Management	Role	Responsibilities
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2b0935fd-2ce0-4c2b-8005-e599108f4d9b"><ac:plain-text-body><![CDATA[	[Name]	Product Manager	Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release	]]></ac:plain-text-body></ac:structured-macro>
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.

Content

Space Tools

LexEVS 6.0 Scope Document