Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page properties
Target release0.1.0
Epic
Document status
Status
titleDRAFT
Document owner

Emily Wang

Designers

Ashley Hickey

Robert Turnbull

Rory Davidson

Developers

Chris Swires

Kai Kewley

Peter G. Williams

QA

Steve Archbold

Emily Wang

Goals

To build a single concept authoring tool that supported by release management features.

Scope

Using the new authoring tool to release SNOMED CT without the Workbench.

Background and strategic fit

SNOMED CT has over 400,000 concrete concept models. Considering logical model as an abstract class, the concrete concept models in SNOMED CT can be manufactured to import into the logical model. The logical components of all of concrete concept models can be viewed in the logical model, include parent and attribute(s). At this moment, we need to build a user interface for managing descriptions and request to the server for all of the pieces of given concept so that we can display the existing concept.

Assumptions

  • The single concept authoring tool will use batch for single concept creation and editing.
  • It is possible to reuse the model creator/editor has been developed. However, it won't be used as a base for creating a matrix. Instead, it will be used as an actual representation of the logical of the concrete concept models.
  • The new tool is not a one-to-one replacement of the Workbench but it can be use for new release.

Process of using single concept authoring service

Requirements 

Functional Requirements

...

Authoring Functions

#TitleUser StoryPriorityNotesJIRA Ticket
1creating a new concept starting with a concrete model in SNOMED CTAs an author, I want to create a new concept by using an existing model 
 
2

representing the concept model 

As an author, I want to see the concept model in a diagram   
3

editing to the logical model

As an author, I want to edit the concept model   
4

editing the description (FSN, PT, etc.)

As an author, I want to edit the description in text fields   
5

accessing to more descriptions

As an author, I want to be able to add more descriptions of the concept   
6

manipulating languages accessibility

As an author, I want to be able to add languages   
7

handling multiple instances of single concept editing by using list management (being able to handle lists of a number of different concept changes, but each applied to a single concept)

As an author, I want to manage many different single concept changes in one list/webpage   
8

adding more than one new concept editing in a single window

As an author, I want to add more than one concept change in the same webpage   
9

crossing boundary from one concept to another in a single window

As an author, I want to see each model related to the the description and a boundary from one concept to another   
10

displaying the SNOMED CT taxonomy

As an author, I want to see the SNOMED CT taxonomy   
11

searching the existing concept model in taxonomy

As an author, I want to search the existing concept model in taxonomy, which is the one I want to use as a start point   
12

displaying the searched existing concept model in logical model

As an author, I want to see the diagram of my selected concept model   
13

saving the concepts just created in single concept editing tool

As an author, I want to save all edits of the concepts   
14

validating each concept editing individually

As an author, I want to validate each concept I edited   
15

classifying concepts in the list

As an author, I want to classify concepts I edited   
16

moving forward to the next step (review)

As an author, I want to move the completed editing task to the review stage   
17grouping and ungrouping the relationship groupAs an author, I want to be able to group and ungroup the relationship groups   
18reviewing the searched model and editing model side by side in the same windowAs an author, I want to see both logical model I searched in taxonomy for reference and the model I am editing so that I can compare them easily.   
19deleting the new editing from the editing panelAs an author, I want to be able to delete the descriptions, attributes-values, relationship group so that I can delete the wrong one before I commit my editing   
20modifying relationship group by drag & drop a attribute-value pair into different relationship groupAs an author, I want to drag & drop a attribute-value pair from one relationship group to another instead of changing the relationship number   

Descriptions

#TitleUser StoryNotesJIRA Ticket
1each concept has at least one FSNAs an author, I want to define at least one FSN  
2only one of FSN can be marked as preferred in a given languageAs an author, I want to mark only one of FSN as preferred in a given language  
3using a language reference set to specify which FSN descriptions is preferred in each language or dialectsAs an author, I want to use a language reference set to specify FSN description is preferred in each language  
4each FSN term ends with a semantic tag, which indicates the semantic category to which the concept belongs (e.g. clinical finding, disorder, procedure, etc.)As an author, I want to indicate the semantic category to which the concept belongs by using semantic tags  
5each concept can have one or more descriptions of type synonym in each languageAs an author, I want to define more than one description of type synonym in each language 

 

6populating default preferred term in US when FSN is importedAs an author, I want the FSN to be populated into the preferred term (synonym)  
7specifying the language reference set of the preferred termAs an author, I want to specify the language reference set of each preferred term (US/GB) so that I can know the preferred term for which language  
8populating default synonym when PT is definedAs an author, I want the PT to be populated into the synonym as the default synonym  
9distinguishing different relationship groupsAs an author, I want to distinguish different relationship groups by different background colour of each relationship group instead of labeling the number of relationship group.  
10defining the definition statusAs an author, I want to define the definition status of each concept, either fully defined or primitive  
11defining the status of conceptAs an author, I want to define the status of each concept, either active or inactive  

Validation Report

#TitleUser StoryNotesJIRA Ticket
1listing validation errors on validation reportAs an author, I want to see a validation report of either a list of validation errors of each concept edited or a notification of validation passed.  

Classification Report & Results

#TitleUser StoryNotesJIRA Ticket
1viewing stated and inferred relationshipAs an author, I want to view both stated and inferred relationships in classification results so that I can see both relationships when I need to.  
2viewing stated relationship only with inferred relationships excludedAs an author, I want to view stated relationships only in the classification results so that I can exclude inferred relationships in the classification results.  
3listing classification errorsAs an author, I want to see a list of details of classification errors so that I can know the concepts associated with classification errors and whether stated relationships were redundant  
4viewing redundant relationshipAs an author, I want to view redundant stated relationship if I have any in my edited concepts  
5viewing equivalent relationshipAs an author, I want to see the equivalent relationship in error message if I created an equivalent relationship  
6linking the latest classification result to each concept on editing pageAs an author, I want to go back to view the concept model and descriptions that I was editing through a link on the classification result  
7saving the classification reports on the local driveAs an author, I want to save the classification reports on my local drive so that I can review and compare different versions of classification reports when I need  
8viewing the source concept of the relationship in the classification reportAs an author, I want to see the source concept of the relationship for the concept I edited in the classification report  
9viewing the type of attribute in the classification reportAs an author, I want to see the type of attribute of the concept I edited in the classification report  
10viewing the destination concept of the relationshipAs an author, I want to view the destination concept of the relationship for the concept I edited in the classification report  
11popping classification error if there are equivalent concept resent in the ontologyAs an author, I want to know if I created an concept identical to an existing concept in the SNOMED CT ontology.  
12re-classifing the concept modelAs an author, I want to re-classify the concept more if the previous classification was failed.  

User Interface

#TitleUser StoryNotesJIRA Ticket
1collapsing the list of description and logical modelAs an author, I want to collapse the descriptions and logical model of each concept editing so that I can add more concepts without having a long page  
2expanding the widgetsAs an author, I want to expand the widgets on the webpage so that I can adjust the real estate required for a given task  
3displaying the concept just edited in taxonomy after it has been added into TSAs an author, I want to see the concepts I just edited in taxonomy after it has been added into TS after validation so that I can see if these concepts are at the appropriate location in the hierarchy.  
4displaying a list management widgetAs an author, I want to see the list management widget so that I can manage a list of variate things and group the user cases for particular purpose.  

List Management

#TitleUser StoryNotesJIRA Ticket
1displaying a list of the concepts in the list managementAs an author, I want to see a list of models that I can use the existing models to create new concepts  
2dragging and dropping the model to the logical model editorAs an author, I want to drag and drop the models from the list of models have been created  
3dragging and dropping the attribute to the descriptionsAs an author, I want to drag and drop the attribute into the description.  
4modifying the filter for searching in the listAs an author, I want to modify the filter for searching concepts in the list (i.e. add more semantic tags in filter)  
5listing most relevant concept at the top of the listAs an author, I want to see the most relevant concept at the top of list when I search a specific phase.  

Task Management (Dashboard)

 

#TitleUser StoryNotesJIRA Ticket
1sorting taskAs an author, I want to sort task by column name on my task panel  
2searching task by blank search boxAs an author, I want to search task by typing in the searching text in blank search box so that I can find the task related to the search text faster  
3prioritizing task (urgent, high, medium, low)As an author, I want to priority my tasks so that I can prioritize my work based on the priority  
4tracking request in taskAs an author, I want to track request in task so that I can know which request(s) the task included  
5customizing dashboardAs an author, I want to customizing dashboard (i.e., change the colour, the location of each widget in window  

Review

#TitleUser StoryNotesJIRA Ticket
1assigning to an author for review after editing committedAs an editing author, I want to assign an author to review my work so that  

Auditing Trail - Properties related to auditing user actions, as opposed to those related to publishable content  

#TitleUser StoryNotesJIRA Ticket
1auditing actions of each user's actions   
2auditing content edited   
3accessibility to auditing report for administrator   

Automations

#TitleUser StoryNotesJIRA Ticket
1automatically distinguish preferred term (US/GB) based on spelling of FSNAs an author, I want system to distinguish the preferred term for US/GB by the difference of spelling of the FSN  
2defaulting English as Language to useAs an author, I want system to default English as Language  

User interaction and design (Designed by Ashley Hickey)

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome
What are features we are missing on this UI?

Not Doing