Difference between revisions of "Terminology Tooling Requirements"

From CIMI
Jump to: navigation, search
Line 5: Line 5:
 
|-
 
|-
 
! scope="col" | Category
 
! scope="col" | Category
! scope="col" | Requirement
+
! scope="col" class="unsortable" | Requirement
! scope="col" class="unsortable | Description
+
 
! scope="col" | Priority
 
! scope="col" | Priority
 +
! scope="col" class="unsortable" | Description
 +
 
|-
 
|-
| General || Global Access || The CIMI Extension contents will be accessible to anyone via the internet with the appropriate credentials.
+
| General || 1 || Global Access || The CIMI Extension contents will be accessible to anyone via the internet with the appropriate credentials.
 
|-
 
|-
| General || Browser UI Access || The CIMI Extension contents will be accessible for query and browsing through a vanilla browser such as Firefox, Internet Explorer or Safari
+
| General || 1 || Provenance || All changes will be tagged with the changing user id and change data
 +
|-
 +
| General || 3 || Change History || The list CIMI originated changes for a given concept, value set, etc. should be queryable
 +
|-
 +
| General || 2 || Change Provenance || A list of all changes by by a given user or all users should be queryable over a given date range
 +
|-
 +
| General || 2 || Browser UI Access || The CIMI Extension contents will be accessible for query and browsing through a vanilla browser such as Firefox, Internet Explorer or Safari
 
|-  
 
|-  
| Value Sets || Value Set Creation || A CIMI author should be able create a new value set and assign a list of concepts
+
| Value Sets || 1 ||  Value Set Creation || A CIMI author should be able create a new value set given a value set name
 +
|-
 +
| Value Sets || 1 || Value Set Modification || A CIMI author should be able to add a list of concepts to a value set and/or remove one or more concepts from a value set
 
|-
 
|-
| Value Sets || Value Set Modification || A CIMI author should be able to remove or add concepts to a value set
+
| Value Sets || 1 || Value Set Query || A CIMI author should be able to locate value sets by matching their description, authors or content.
 
|-
 
|-
| Value Sets || Value Set Query || A CIMI author should be able to locate value sets by matching their description, authors or content.
+
| Value Sets || 1 || Value Set Retrieval || A value set should be retrievable by identifier
 
|-
 
|-
| Value Sets || Value Set Retrieval || A value set should be retrievable by identifier
+
| Concepts || 1 || Concept Creation || A CIMI author should be able to create a new concept with a preferred name, parent concept (if known), and an optional description of its intent and purpose
 
|-
 
|-
| Concepts || Concept Creation || A CIMI author should be able to create a new concept with a preferred name, parent concept (if known), and an optional description of its intent and purpose
+
| Concepts || 1 || Concept Modification || Change the preferred name, parent concept(s), and description of a concept
 
|-
 
|-
| Concepts || Concept Modification || Change the preferred name, parent concept(s), and description of a concept
+
| Concepts || 1 ||  Concept Query || Retrieve concept(s) that match a text string and/or author
 
|-
 
|-
| Concepts || Concept Query || Retrieve concept(s) that match a text string and/or author
+
| General || 3 || Spreadsheet Import || Concept additions, value sets and other changes should be importable via a spreadsheet
 
|}
 
|}
 +
 +
'''Priorities: '''
 +
* '''1''' Must be present
 +
* '''2''' Highly desirable
 +
* '''3''' Desirable
 +
* '''4''' Wish list / future

Revision as of 14:57, 14 December 2012

The CIMI community has agreed to use SNOMED CT as the primary terminology in the CIMI modeling tool and to add whatever concepts are necessary within the CIMI namespace as necessary. The assignment and management of SNOMED CT concept identifiers for concepts, simple reference sets ("extensional" value sets), value set definition reference sets, etc. is a non-trivial process and will require supporting software and infrastructure. Following is a list of requirements for the supporting tools:

Requirements
Category Requirement Priority Description
General 1 Global Access The CIMI Extension contents will be accessible to anyone via the internet with the appropriate credentials.
General 1 Provenance All changes will be tagged with the changing user id and change data
General 3 Change History The list CIMI originated changes for a given concept, value set, etc. should be queryable
General 2 Change Provenance A list of all changes by by a given user or all users should be queryable over a given date range
General 2 Browser UI Access The CIMI Extension contents will be accessible for query and browsing through a vanilla browser such as Firefox, Internet Explorer or Safari
Value Sets 1 Value Set Creation A CIMI author should be able create a new value set given a value set name
Value Sets 1 Value Set Modification A CIMI author should be able to add a list of concepts to a value set and/or remove one or more concepts from a value set
Value Sets 1 Value Set Query A CIMI author should be able to locate value sets by matching their description, authors or content.
Value Sets 1 Value Set Retrieval A value set should be retrievable by identifier
Concepts 1 Concept Creation A CIMI author should be able to create a new concept with a preferred name, parent concept (if known), and an optional description of its intent and purpose
Concepts 1 Concept Modification Change the preferred name, parent concept(s), and description of a concept
Concepts 1 Concept Query Retrieve concept(s) that match a text string and/or author
General 3 Spreadsheet Import Concept additions, value sets and other changes should be importable via a spreadsheet

Priorities:

  • 1 Must be present
  • 2 Highly desirable
  • 3 Desirable
  • 4 Wish list / future