...
Requirements (all requirements are Must-Have)
Functional Requirements
Functions
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 1 | creating a new concept starting with a concrete model in SNOMED CT | As 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 | accessing 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 | ||
| 17 | grouping and ungrouping the relationship group | As an author, I want to be able to group and ungroup the relationship groups |
Descriptions
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 181 | each concept has at least one FSN | As an author, I want to define at least one FSN | ||
| 192 | only one of FSN can be marked as preferred in a given language | As an author, I want to mark only one of FSN as preferred in a given language | ||
| 203 | using a language reference set to specify which FSN descriptions is preferred in each language or dialects | As an author, I want to use a language reference set to specify FSN description is preferred in each language | ||
| 214 | each 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 | ||
| 225 | each concept can have one or more descriptions of type synonym in each language | As an author, I want to define more than one description of type synonym in each language |
| |
| 236 | populating default preferred term in US when FSN is imported | As an author, I want the FSN to be populated into the preferred term (synonym) | ||
| 247 | specifying the language reference set of the preferred term | As 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 | ||
| 258 | populating default synonym when PT is defined | As an author, I want the PT to be populated into the synonym as the default synonym | ||
| 269 | distinguishing different relationship groups | As an author, I want to distinguish different relationship groups easily (i.e. by different colour or number) | ||
| 2710 | defining the definition status | As an author, I want to define the definition status of each concept, either fully defined or primitive | ||
| 2811 | defining the status of concept | As an author, I want to define the status of each concept, either active or inactive |
Validation Report
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 291 | listing validation errors on validation report | As 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
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 301 | viewing stated and inferred relationship | As 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. | ||
| 312 | viewing stated relationship only with inferred relationships excluded | As an author, I want to view stated relationships only in the classification results so that I can exclude inferred relationships in the classification results. | ||
| 323 | listing classification errors | As 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 | ||
| 334 | viewing redundant relationship | As an author, I want to view redundant stated relationship if I have any in my edited concepts | ||
| 345 | viewing equivalent relationship | As an author, I want to see the equivalent relationship in error message if I created an equivalent relationship | ||
| 356 | linking the latest classification result to each concept on editing page | As 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 | ||
| 367 | saving the classification reports on the local drive | As 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 | ||
| 378 | viewing the source concept of the relationship in the classification report | As an author, I want to see the source concept of the relationship for the concept I edited in the classification report | ||
| 389 | viewing the type of attribute in the classification report | As an author, I want to see the type of attribute of the concept I edited in the classification report | ||
| 3910 | viewing the destination concept of the relationship | As an author, I want to view the destination concept of the relationship for the concept I edited in the classification report | ||
| 4011 | popping classification error if there are equivalent concept resent in the ontology | As an author, I want to know if I created an concept identical to an existing concept in the SNOMED CT ontology. | ||
| 4112 | re-classifing the concept model | As an author, I want to re-classify the concept more if the previous classification was failed. |
...
User Interface
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 421 | collapsing the list of description and logical model | As 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 | ||
| 432 | expanding the widgets | As an author, I want to expand the widgets on the webpage so that I can adjust the real estate required for a given task | ||
| 443 | displaying the concept just edited in taxonomy after it has been added into TS | As 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. | ||
| 454 | displaying a list management widget | As 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
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 461 | displaying a list of the models in the list management | As an author, I want to see a list of models that I can use the existing models to create new concepts | ||
| 472 | dragging and dropping the model to the logical model editor | As an author, I want to drag and drop the models from the list of models have been created | ||
| 483 | displaying a list of attributes in the list management | As an author, I want to see a list of potential attributes that I can add to the descriptions | ||
| 494 | dragging and dropping the attribute to the descriptions | As an author, I want to drag and drop the attribute into the description. |
Handling published and unpublished content
| # | Title | User Story | Notes | JIRA Ticket |
|---|
Auditing Trail - Properties related to auditing user actions, as opposed to those related to publishable content
...
User interaction and design
Attachment (Designed by Ashley Hickey)
Detail (Designed by Ashley Hickey)
...
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 1 | auditing actions of each user's actions | |||
| 2 | auditing content edited | |||
| 3 | accessibility to auditing report for administrator | |||
| 4 | warning when the new change is exactly same as one of previous changes |
Properties of descriptions and relationships
Frequently editing
| # | Title | User Story | Notes | JIRA Ticket |
|---|
Infrequently editing
| # | Title | User Story | Notes | JIRA Ticket |
|---|
Mutable properties
| # | Title | User Story | Notes | JIRA Ticket |
|---|
Immutable properties
| # | Title | User Story | Notes | JIRA Ticket |
|---|
Automations
| # | Title | User Story | Notes | JIRA Ticket |
|---|---|---|---|---|
| 1 | defaulting the values most picked by authors |
Behaviour at and after publishing
| # | Title | User Story | Notes | JIRA Ticket |
|---|
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:
...