LexEVS 6.0 Use Cases

Document Information

Author: (Name)
Email: (Email address)
Team: (Product team)
Contract: (caCORE:Contract number)
Client: NCI CBIIT
National Institutes of Heath
US Department of Health and Human Services

Contents

Remove the instructional note boxes after completing the 1st draft.

Introduction

Describe the boundary and purpose of these use cases.

Use Cases

Duplicate the following pattern as many times as necessary. Replace the text in the tables with your information. All use cases are simple narratives and should not be specific to implementation technology or user interfaces. Software API is written in Design Documents.

UC0 (zero) can be used to provide context for lower level use cases. The Use case name is usually the goal of the use case.

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 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	The primary user/role/profile or system which uses the system being built to achieve some specific goal.
Primary Stakeholder	CTS 2 SFM DSTU
Other Stakeholders	Others who have an interest and how they are involved.
Expected Inputs	1. Code System ID 2. Code System Description (optional) 3. Code System Administrative Info (optional) 4. Code System Version (see model for class description) 5. Code System Contents (i.e. either: Source Location (URI) OR Code System Contents (Concepts, Concept Properties, ConceptAssociations, Designations etc.)
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 2. Supplied contents cannot be processed (may be a number of specific errors)
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