NIH | National Cancer Institute | NCI Wiki  

Contents of this Page

Define CDE with externally enumerated value set

Use Case Number

Init1hm6.pm18.1

Brief Description

The allowable values for a common data element can be extensive and/or defined by a standard.  In these cases, it is best to reference an external vocabulary when defining the CDE.

Actor(s) for this particular use case

Metadata Specialist

Pre-condition
The state of the system before the user interacts with it

None.

Post condition
The state of the system after the user interacts with it

A CDE is defined with an externally enumerated value set

Steps to take
The step-by-step description of how users will interact with the system to achieve a specific business goal or function

  1. A Metadata Specialist defines a new CDE in the metadata repository
  2. The Metadata Specialist selects the allowable values as being externally referenced.
  3. The Metadata Specialist enters a reference to an external vocabulary.

Alternate Flow
Things which would prevent the normal flow of the use case

The Metadata Specialist could update an existing CDE to reference an external enumeration of allowable values.

Priority
The priority of implementing the use case: High, Medium or Low

High.

Associated Links
The brief user stories, each describing the user interacts with the system for the one function only of the use case. There would potentially be a number of user stories that make up the use case.

Fit criterion/Acceptance Criterion 
How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement?

None.

Fetch CDE externally enumerated value set

Use Case Number

Init1hm6.pm18.1

Brief Description

For CDEs that have an externally enumerated value set, it is necessary that value set be retrievable via a service call in much the same way that the CDE itself is retrievable.

Actor(s) for this particular use case

Software Engineer

Pre-condition
The state of the system before the user interacts with it

A CDE exists that has an externally enumerated value set

Post condition
The state of the system after the user interacts with it

The externally enumerated value set is fetched

Steps to take
The step-by-step description of how users will interact with the system to achieve a specific business goal or function

  1. The Software Engineer fetches the CDE in question.
  2. The CDE contains a reference to an externally enumerated value set, which contains all of the information necessary to fetch it.
  3. The Software Engineer uses the reference to fetch the value set.

Alternate Flow
Things which would prevent the normal flow of the use case

None.

Priority
The priority of implementing the use case: High, Medium or Low

High

Associated Links
The brief user stories, each describing the user interacts with the system for the one function only of the use case. There would potentially be a number of user stories that make up the use case.

Fit criterion/Acceptance Criterion 
How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement? 

None.


  • No labels