Author: Craig Stancl
Email: stancl.craig@mayo.edu
Team: LexEVS
Contract: (caCORE:Contract number)
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services
Introduction
Use Cases
UC0: Import Code System
This use case is the only one that is at a high level and might include stakeholders and criticality (relative priority). This user case provides context for the lower level use cases.
Use Case Category |
Administration |
Use Case Description |
Installs a code system (aka terminology) into the terminology service for subsequent access by other service functions. This operation is used for the initial install of the overall terminology structure itself. This may include the full set of concepts, relationships and so on, or some of these elements may be loaded using the Import Code System Revision operation. The actual contents may be supplied by value or reference, i.e. as a complete set of explicit content or as a reference to a location where the content can be separately obtained for loading. |
Primary Actor |
Terminology Administrator |
Primary Stakeholder |
CTS 2 SFM DSTU |
Expected Inputs |
1. Code System ID |
Expected Outputs |
An acknowledgment indicating whether the terminology has been successfully loaded or not. |
Pre-conditions |
Code System source is available in a format directly consumable by CTS 2 import tools |
Post-conditions |
The code system is available for access via the CTS 2 service functions. |
Exception Conditions |
1.Code system not found at source location |
Related Gforge Trackers |
|
Related JUnits |
|
Related Links |
|
UC1: Use case name
Primary Actor |
The primary user/role/profile or system which uses the feature of this use case to achieve some specific goal. |
Pre-conditions |
Detail any activities immediately preceding this use case; only include as much history as relevant. |
Main Success Scenario |
Describe the main scenario if nothing fails, the "perfect case" scenario; this may contain some actions that are not immediately related to this use case but are necessary to satisfy other stakeholders. |
Post-conditions |
Detail any activities immediately following this use case, only include as much history as relevant. |
Exception Scenarios |
Detail exceptions that can occur in the Success Scenario; do not include technical implementation exceptions. All use cases are written from the user perspective. |
Related Links |
Links to Gforge trackers, diagrams, or related requirements documents. |
UCx: Use case name
Primary Actor |
The primary user/role/profile or system which uses the feature of this use case to achieve some specific goal. |
Pre-conditions |
Detail any activities immediately preceding this use case; only include as much history as relevant. |
Main Success Scenario |
Describe the main scenario if nothing fails, the "perfect case" scenario; this may contain some actions that are not immediately related to this use case but are necessary to satisfy other stakeholders. |
Post-conditions |
Detail any activities immediately following this use case, only include as much history as relevant. |
Exception Scenarios |
Detail exceptions that can occur in the Success Scenario; do not include technical implementation exceptions. All use cases are written from the user perspective. |
Related Links |
Links to Gforge trackers, diagrams, or related requirements documents. |
UC0: Use case name ** TEMPLATE**
This use case is the only one that is at a high level and might include stakeholders and criticality (relative priority). This user case provides context for the lower level use cases.
Use Case Category |
Definition of use case |
Use Case Description |
Definition of use case |
Primary Actor(s) |
The primary user/role/profile or system which uses the system being built to achieve some specific goal. |
Primary Stakeholder |
Who submitted the use case and how they are involved. |
Expected Inputs |
For USE CASE 0, high level description of any activities immediately preceding this use case, only include as much history as relevant. |
Expected Outputs |
For USE CASE 0, high level description of any activities immediately preceding this use case, only include as much history as relevant. |
Pre-conditions |
For USE CASE 0, high level description of any activities immediately preceding this use case, only include as much history as relevant. |
Post-conditions |
Detail any activities immediately following this use case, only include as much history as relevant. |
Exception Conditions |
Detail exceptions that can occur in the Success Scenario; do not include technical implementation exceptions. All use cases are written from the user perspective. |
Related Gforge Trackers |
Links to Gforge trackers, diagrams, or related requirements documents. |
Related JUnits |
Links to Gforge trackers, diagrams, or related requirements documents. |
Related Links |
Links to Gforge trackers, diagrams, or related requirements documents. |