Goals
- Enhanced feature set for Refset Management Services tool Version 1.0.0 (extending and enhancing previously Minimal Viable Product release)
Background and strategic fit
Iterative refinement building on the features and services in Minimal Viable Product baseline.
Assumptions
- Availability of Terminology Server (TS) platform and service API, including enhanced API services to deliver Refset Management Services updates.
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-321 - Getting 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-321 - Getting issue details... STATUS |
JIRA backlog tickets derived from specifications table
User interaction and design
Questions
Below is a list of questions to be addressed as a result of this requirements document:
| Question | Outcome |
|---|---|
| What is definition of most recent Refset | Most recent published Refset. |
| How many most recent Refset we need to show | 10 |
| What is definition of most viewed and # of refset shown as most viewed | The (published) one that people have clicked through to view. |
which are all following new fields are mandatory during create of "Simple Refset"
| Mandatory fields:
|
| List of SNOMED®CT extensions | SNOMED_CT_Namespace_Registry - OFFICIAL 20141021.pdf This may be a useful reference until/unless a better alternative can be defined? Decision 17 March 2015 (RTU/EWA/PNEMA/SAR): The extensions filter options for version 1.0.0 will be populated dynamically (perhaps periodically cached for performance) from the entered Refset data rather than driven from a predefined table. |
Ashley Hickey other day you mentioned that you wanted to apply filter on refset directory page at client side. is this correct assumption that in that case you will be fetching all the refset before applying required filters? if so then do you require services to get search results from backend (although that may be optimal) based on individual filters? I understand "search all" still needs to be back end service. Please confirm. | |
| For log-in should IHSDO tools support authentication/identification via social/OAuth credentials, ie "login with Google", "login with FB" etc? | Not in Phase 2. |
| RF2 format Refset | |
| To send refset diff report a SMTP host, a from address and credential if required are needed. At the moment I am using gmail to send these reports. But as we move into UAT/PROD we may need these details. @Adam will be doing the placement of these property value in UAT/PROD so feel free to directly communicate these values in advance of release. At the moment we are fine. | NOTE to Team. |
Not Doing
- 3rd party social network / OAuth login