Use Case Number

Init1pm1.1

Brief Description

Since its inception, caBIG has been founded on (1) developing and defining standards, tooling, and architecture to enable interoperability, and (2) determining whether existing systems meet the basic requirements for interoperability.  While the nature of the "compatibility reviews" may change, there is a clear need to provide the community a way to understand at what level different applications meet interoperability requirements.  It is highly desirable that the review process be as simple and transparent as possible both for the developer/owner of a system and the reviewers.  In this way, review artifacts should be able to be generated in an automated fashion based on the model itself or its registration in the metadata repository.  Furthermore, a reviewer using the compatibility review software should be able to access real-time the artifacts that they need to perform a review.

Actor(s) for this particular use case

• Information Modeler
• Compatibility Reviewer

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

A model has been created with all the necessary semantic information for registration and a "compatibility" review.

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

The artifacts have been generated for the compatibility review and they have been linked in the compatibility review system.

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 register his metadata in the metadata repository
2. (If needed) the Information Modeler takes the steps in the modeling tool to generate review artifacts
3. The review artifacts are linked into the review tool
4. The Compatibility Reviewer has access to all of the information (artifacts) needed to complete the review

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

It should not be a requirement to use the caBIG-defined tooling to generate compatibility artifacts.  Instead, there should be an alternate flow that involves the creation of the artifacts de novo, registration of the metadata, and providing the artifacts to the review system.

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.

Init1pm1 - ICR IRWG Requirements

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

• It is highly desirable that as many (if not all) of the review artifacts be generated automatically for the Information Modeler by the modeling tool
• It is highly desirable that as many (if not all) of the review artifacts be linked real-time from the metadata repository into the review tool (e.g. the reviewer will be reviewing data elements that are pulled directly from the metadata repository rather than statically copied)

Use Case Number

Init1pm1.2

Brief Description

The modeling tool and metadata registry should facilitate easy reuse of existing metadata.  Specifically, this includes sophisticated/seamless type-ahead functionality for finding common data elements and semantic concepts, the metadata repository should support the notion of common data elements that overlap between system and provide touch-points for interoperability, the registration process should be linked directly with the modeling tool, and Information Modelers should have the ability to perform metadata loads into a "sandbox" metadata repository on their own.

Actor(s) for this particular use case

Information Modeler

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 model has been created, semantic metadata has been added, and it has been registered in the metadata repository.

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 creates a model in the modeling tool
2. The Information Modeler is able to search for specific common data elements and semantic concepts directly from the modeling tool using type-ahead functionality (or an equivalently user friendly technology)
3. The Information Modeler is able to search for common data elements that have been identified as key touchpoints for other systems to "link" with or "interoperate" on
4. Whenever the Information Modeler feels it is helpful, he should be able to load the model into a sandbox environment through functionality built into the modeling tool

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.

Init1pm1 - ICR IRWG Requirements

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

• As many of the described steps and as much of the functionality as possible should be built into the modeling tool