NIH | National Cancer Institute | NCI Wiki  


Document Information

Author: Jason Lucas
Email: jason.lucas@nih.gov
Team: EVS
Contract: [Contract number]
Client: NCI CBIIT
National Institutes of Health
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) NCI EVSRESTAPI 1.5. This document focuses on the functionality proposed by the product stakeholders and target users in order to make it a better product.

Vision and Needs

The objective of this release of the NCI EVSRESTAPI is to develop the search and concept data retrieval of MedDRA terms.

Functional Requirements

Each enhancement, modification or new feature is described in detail below.

JIRA number (hyperlinked)

Brief description of functional requirement (enhancement or new feature)

Comments

EVSRESTAPI-182evsrestapi-client-SDK - implement examples for associationEntries calls.
EVSRESTAPI-188evsrestapi-client-SDK - subset, subsetMember
EVSRESTAPI-229Implementation of MedDRA in the EVSRESTAPI
EVSRESTAPI-230Improve Swagger documentation for property search
EVSRESTAPI-234evsrestapi-client-SDK - Create example for searching NCIm concepts
EVSRESTAPI-235Implementation of MDR hierarchies in evsrestapi
EVSRESTAPI-238Add terminology metadata for the loader responsible for loading dataNo additional QA required
EVSRESTAPI-242

Style Guide and Vulnerability Disclosure Policy Footer Updates for Swagger Docs





Functional Bug Fixes

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

JIRA number (hyperlinked)

Brief description of bug

Iteration (Approved or Proposed)

EVSRESTAPI-224Fix 'include' parameter for metadata subset(s) calls
EVSRESTAPI-225The /concept/{terminology}/subsetMember/{code} does not have include param
EVSRESTAPI-236Extra NCIm associations metadata - BRB, BRN, XRNo further QA is needed
EVSRESTAPI-239Terms Matching in DEF do not always showup in the highlights
EVSRESTAPI-241Computed concept paths not starting with 0
EVSRESTAPI-243EVSRESTAPI v1 Spring Framework Upgrade









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.

JIRA number (hyperlinked)

Brief description of non-functional requirement

Iteration (Approved or Proposed)

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.

JIRA number (hyperlinked)

Brief description of general support activity

Iteration (Approved or Proposed)






Stakeholder Summary

Customer Name

Role

Interest/Need

Sherri De Coronado

Semantic Infrastructure Product Manager

Directs EVS Projects




CBIIT Staff/Contractor Name

Role

Responsibilities

[Name]

[Role in this project]

Technical Environment

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

Item

Description

Client Interface


Application Server

  • Tomcat

Database Server

  • Stardog

Operating System

  • Linux [Operating system independent]

[Other]

  • Java Platform 1.8

Product Dependencies

This release is dependent on LexEVS terminology server API.

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.

JIRA 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

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 JIRA site:

https://tracker.nci.nih.gov/projects/EVSRESTAPI/

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:


Project Information

CBIIT Management

Role

Responsibilities

Lyuba Reminnick

Product Manager

Oversees development of the product: features, functions, definition of stakeholders, priorities within the scope, timeframe for release.

  • No labels