NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use Case Number

Init6pm23.2

Brief Description

Data elements are generated using specific algorithms.  There needs to be a way to model the features of the algorithm itself and tie it back to the original data.  One of the features of the algorithm could be the code of the algorithm itself.  It would be ideal if this type of model could be generalized for use in the caBIG analytical community.

Actor(s) for this particular use case

Information Modeler, Software Engineer

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

An algorithm exists, it is coded, and its features are known.  Outputs from the analytical routine are modeled and registered.

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

A semantically sound description of the algorithm is defined, able to be shared with others, and able to be associated with data that the algorithm created.

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 Information Modeler imports the standard analytical routine semantic metadata model into his UML model.
  2. The Information Modeler extends the analytical routine metadata as needed
  3. The Information Modeler associates output parameter data elements to the analytical metadata
  4. The Information Modeler registers his model, including input parameters, output parameters, and associated extended analytical routine metadata
  5. The Software Engineer generates a grid service using the registered metadata
  6. The Software Engineer provides the analytical routine metadata values, which is exposed in the service-level metadata
  7. The Software Engineer implements the system, which links the analytical outputs to the analytical routine metadatadata.

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

Medium

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.

Init6pm23

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

None.

...

A common standard model is highly desirable, though it is necessary for different Information Modelers to extend it.

Init6pm23.3 - Modeling Lab and Research Methodology

Use Case Number
The author-assigned number to refer to each specific use case. The format of this number is <SemCon Ops Initiative><analyst's initiatls><requirement number>.< <use case number>, for example Init1dbw1.1, Init1dbw1.2, Init2dbw2.1, 2.2, etc.

n.n


Init6pm23.3

Brief Description

Metadata describing analytical results should link to the methodology used to generate the input data, such as the way that the biological specimens are analyzed and treated.  In some cases, there can be clear overlap between the research methodology and the study design, which should be linked if possible.

Brief Description

 

Actor(s) for this particular use case

Information Modeler, Software Engineer  

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

Input data to analytical services has been generated using a particular set of steps, which is termed the methodology.  A UML model exists for modeling the input parameter data.

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

Research methodology metadata is modeled and associated to input parameter metadata. 

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.
2

  1. The Information Modeler imports the standard research methodology semantic metadata model into his UML model.
  2. The Information Modeler extends the research methodology semantic metadata as needed
  3. The Information Modeler associates input parameter data elements to the research methodology semantic metadata
  4. The Information Modeler associates study design data elements to the research methodology semantic metadata
  5. The Information Modeler registers his model, including input parameters and associated extended research methodology semantic metadata
  6. The Software Engineer generates a grid service using the registered metadata
  7. The Software Engineer implements the system, which links the analytical inputs to the research methodology data.

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

Researcher enters the research methodology data when the input parameter data is entered into the system.

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


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.

 Init6pm23

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

1.
2.. A common standard model is highly desirable, though it is necessary for different Information Modelers to extend it.

Use Case - Descriptive Name

Use Case Number
The author-assigned number to refer to each specific use case. The format of this number is <SemCon Ops Initiative><analyst's initiatls><requirement number>.< <use case number>, for example Init1dbw1.1, Init1dbw1.2, Init2dbw2.1, 2.2, etc.

n.n

Brief Description

 

Actor(s) for this particular use case

 

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

 

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

 

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.
2.

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

 

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

 

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?


1.
2...

Use Case - Descriptive Name

Use Case Number
The author-assigned number to refer to each specific use case. The format of this number is <SemCon Ops Initiative><analyst's initiatls><requirement number>.< <use case number>, for example Init1dbw1.1, Init1dbw1.2, Init2dbw2.1, 2.2, etc.

n.n

Brief Description

 

Actor(s) for this particular use case

 

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

 

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

 

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.
2.

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

 

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

 

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?


1.
2...