Release Goals
- Provide a tool that enables the management & creation of reference sets against the International edition of SNOMED CT and Member extensions.
- Provide a directory of existing reference sets that can be searched and downloaded to be used by others
Existing components to be used
- IHTSDO Terminology Server (TS) platform to retrieve the terminology.
- IHTSDO Identity Management Server (IMS) for user management - IHTSDO Identity Management Service Documentation
Member Requirements
The following document is a list of the requirements which were gathered from Members towards the end of 2013 -
Category | Summary | In Release Scope | Notes | |
---|---|---|---|---|
1 | Refset specification | Need to reuse the refset specification (i.e. must persist Wants to share a refset spec with other NRCs, therefore needs to be able to “release” a refset spec Expects IHTSDO to facilitate a ‘member exchange’ for refset specs; has submitted a Tracker item for this | ||
2 | Refset specification | To be able to rerun the spec to create new instance e.g. after SNOMED CT changes, to find the differences that need to be managed |
||
3 | Refset specification | Use refset spec to adjust refset content automatically |
||
4 | Workflow | Needs to be a basic workflow which allows the import/creation of resets, adjusting content to changes to SCT and to producing release files |
||
5 | Import | Needs the ability to import refsets developed outside the tool (including from other member countries) into the tool |
||
6 | Replacements for deprecated content | Tool should suggest replacements for deprecated content based on historical associations at SCT version change |
||
7 | Metadata | Include in the Refset display metadata info the SNOMED CT Version used for creation of the refset. Allow for adding a note to remember this is not the latest version when not working with the latest version. Add the refset version as well in each output of the refset: list, file, specification or otherwise. |
||
8 | Rule based creation | Allow to build a refset on searching for specific terms additionally to use of other clauses (such as constraint on a hierarchy or sub-hierarchy) |
||
9 | Allow multiple selection of concepts (e.g.: from an imported list) and selection of a clause to apply to those as a group rather than individually (e.g.: list of concepts to exclude + all of their descendants. Add a specification to an imported list where we would apply to all concepts the ‘Kind of’ clause.) |
|||
10 | Rule based creation | Clauses o Add Code and children: Does not exist. Can this be created rather than using 2 clauses jointly: Concept is clause + Concept is child of clause. |
||
11 | Rule based creation | Allow creation of default refset clauses specification templates so we would never start from scratch (for different basic use cases) |
||
12 | Allow different sorting option for the selected descriptions in a specification (alpha, alpha+FSN or alpha+PT, per hierarchy, per sub-hierarchy, etc) |
|||
13 | Allow adding a specification to an imported list of concepts created as a refset |
|||
14 | Cloning refsets | When cloning o automatically create a name for the Clone o In the cloned refset, mention the original refset this one was cloned from |
||
15 | Activate or not the mandatory date as a user preference and allow flags to inform the user : |
|||
16 | When inactivating a concept, make sure all components are being inactivated/cleared and the concept no longer shows in the Taxonomy. Allow creating another refset with same name. |
|||
17 | Allow creation of a naming convention template for creation of refse |
|||
18 | Comments / feedback | When adding a comment to a refset, discrepancy between the selected concept and the one where the comment is added. Make sure alignment is 100% effective when selecting a concept and acting on it |
||
19 | Allow to create other than Translation Project where the same concept can be included in many refsets. Allow to display a warning message when a concept (if many, group them in a logical manner if possible) is in many refsets provide metadata as to the refsets name, version, etc. |
Specific Requirements
Title | User Story | Acceptance Criteria | Importance | Notes | |
---|---|---|---|---|---|
1 | Refset field - Description | As a Refset User I want to see a description of the refset so that I can understand its aims/intent |
|
Must | As implemented in MVP |
2 | Refset field - Use Case / Scope | As a Refset User I want to see the use case / scope for a refset so that I can understand its context |
|
Must |
|
3 | Refset field - Language | As a Refset User I want to see the language that the Refset is written with so that I can understand its international applicability |
|
Must | Could be a subset from a standards list if definition is available. A user-definable subset list preference would be good for UX. Another option, and perhaps slicker UX, would be to make language and country fields auto-complete from entered text, rather than presenting traditional drop-down lists (eg https://www.devbridge.com/sourcery/components/jquery-autocomplete/)? |
4 | Refset field - Contributing Organisation | As a Refset User I want to see the contributing organisation to the Refset so that I can understand its organisational origins and context |
|
Must |
|
5 | Refset field - Country of Origin | As a Refset User I want to see the country of origin for a Refset so that I can understand its national origins and context |
|
Must | Could be a subset from a standards list if definition is available. A user-definable subset list preference would be good for UX. Also see note on "Refset field - Language" above for possible alternative UX approach. |
6 | Refset field - Version of SNOMED CT | As a Refset User I want to see the version of SNOMED CT that contains a Refset so that I can understand its relationship to other SNOMED CT content |
|
Must | |
7 | Refset field - Entry of Extension | As a Refset User I want to populate the SNOMED CT extensions from the actual Refset data so that I can filter the Refset by Extension later |
|
Must |
|
8 | Refset field - Refset Publish Date | As a Refset User I want see when a Refset was published so that I can understand its availability |
|
Must |
|
9 | Refset field - Implementation | As a Refset User I want to see implementation details for a Refset so that I can understand its history and how it was implemented. |
|
Must |
|
10 | Refset metadata | As a Refset User I want to see metadata relating to a Refset so that I can understand how popular it is, when it was last modified, and who contributed to it | Must |
|
|
11 | Filter by language - Refset listings | As a Refset User I want to filter the presented list of available Refsets by language so that I can constrain the list to those I am most interested in. |
|
Must | Could be a subset from a standards list if definition is available. A user-definable subset list preference would be good for UX. Also see note on "Refset field - Language" above for possible alternative UX approach. |
12 | Filter by contributing organisation - Refset listings | As a Refset User I want to filter the presented list of available Refsets by contributing organisation so that I can constrain the list to those I am most interested in. |
|
Must | |
13 | Filter by country of origin - Refset listings | As a Refset User I want to filter the presented list of available Refsets by country of origin so that I can constrain the list to those I am most interested in. |
|
Must | Could be a subset from a standards list if definition is available. A user-definable subset list preference would be good for UX. Also see note on "Refset field - Language" above for possible alternative UX approach. |
14 | Filter by version of SNOMED CT - Refset listings | As a Refset User I want to filter the presented list of available Refsets by version of SNOMED CT so that I can constrain the list to those I am most interested in. |
|
Must |
|
15 | Filter by exension - Refset listings | As a Refset User I want to filter the presented list of available Refsets by extension so that I can constrain the list to those I am most interested in. |
|
Must |
|
16 | Search by concept ID - Refset listings | As a Refset User I want to search for available Refsets by concept ID so that I can constrain the list to those I am most interested in. |
|
Must |
|
17 | Search by term - Refset listings | As a Refset User I want to search for available Refsets containing a particular term so that I can constrain the list to those I am most interested in. |
|
Must |
|
18 | Filter by clinical domain - Refset listings | As a Refset User I want to filter the presented list of available Refsets by clinical domain so that I can constrain the list to those I am most interested in. |
|
Must |
|
19 | Refset view - more information | As a Refset User I want an option to show more information for a Refset so that I can understand its use-case / scope and implementation details | Must | Fields for more information display:
|
|
20 | Refset listings - view refset link | As a Refset User I want to browse to a particular Refset view by following a link anchored to its description in a Refset listing so that I don't need an additional button to view the Refset | Must |
|
|
21 | Refset listings - last updated by | As a Refset User I don't want to see a "last updated by" column in Refset listings, as that information is more usefully presented as the contributing organisation | Must |
|
|
22 | Member import help | As a Refset User I want to see help and guidelines so that I can follow instructions to import members | Must | ||
23 | External URL | As a user I want to capture an external site url to locate a refset not stored in refset tool | Optional | see JIRA issue - RMT-321Getting issue details... STATUS | |
24 | External Contact | As a user I want capture contact details for a refset not stored in refset tool | Mandatory if External URL is available | see JIRA issue - RMT-321Getting issue details... STATUS |
JIRA backlog tickets derived from specifications table