NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 3

changes.mady.by.user Unknown User (mcconnellp)

Saved on

compared with

New Version 4

changes.mady.by.user Unknown User (mcconnellp)

Saved on

Key

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

...

Use Case Number

Init1pm16.3

Brief Description

In addition to providing a platform independent UML representation of healthcare datatypes, ISO 21090 defines an XML binding of those datatypes to be used when exchanging data between physical systems.  Specifically, ISO 21090 requires the following for Indirect Conformance:

  • Specify whether the XML representation described herein is used when the datatypes are represented in XML, or optionally to provide an alternative namespace for the XML representation 
    This use case describes the generation of an XML Mapping including an XML Schema.

Actor(s) for this particular use case

Information Modeler

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

The ISO 21090 datatypes have been localized in the Information Modelers UML modeling tool using the necessary metadata repository conventions.

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

An XML Schema and mapping guide are generated.

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 makes whatever manual markup of the model is necessary to generate an XML Schema
  2. The Information Modeler generates an XML Schema and mapping document derived directly from the localized ISO 21090 datatypes in his UML model

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

The Information Modeler manually creates XML Schema, a mapping document, and annotates the model accordingly with the UML-to-XML Schema mapping information.

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.

Init1pm16 - 21090 Datatype Support

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

  1. The model has the necessary annotations/information to tie XML Schema types to UML types, which will be registered in the metadata repository.
  2. An XML Schema is produced that conforms to the ISO 21090 specifications
  3. A document is produced describing the mapping from UML to XSD (not strictly necessary, but desirable)

Init1pm16.4 - 21090 Datatype Support - Register Datatypes

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.

Init1pm16.4

Brief Description

caBIG compability and ECCF require that semantic metadata be registered and advertised in order to facilitate interoperability.  This use case describes the process by which an Information Modeler takes his localized, XML Schema mapped model to the centralized metadata repository.

Actor(s) for this particular use case

  Information Modeler

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

A localized ISO 21090 model exists in the Information Modeler's UML modeling tool with all required annotations to be registered, including XML Mappings.

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

The information model is registered and available 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.
2.

  • The Information Modeler selects the information model and datatypes to register
  • The Information Modeler performs the registration steps directly from his UML 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.

 Init1pm16 - 21090 Datatype Support

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.. The entire information model should be registered, including the localized ISO 21090 datatypes and XML Schema mappings.  It should be obvious from which vanilla ISO 21090 datatypes the localized data are derived.

Init1pm16.

...

5 - 21090 Datatype Support - Interoperate on Datatypes

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

Init1pm16.5

Brief Description

The true test of whether the semantic infrastructure is handling ISO 21090 requirements is that it is possible to:

  • Discover healthcare touchpoints between systems that localize ISO 21090 in different ways
  • Programmatically interoperate between these systems

Brief Description

 

Actor(s) for this particular use case

System Architect
  Software Engineer

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

Two or more systems have correctly imported, localized, generated XML Schema, and registered information models with ISO 21090 datatypes.  Furthermore, these information models are implemented by real systems with ECCF compliant APIs.

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

Touch points are discovered and data is successfully exchanged. 

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 System Architect uses the metadata browser to identify two or more systems with the same ISO 21090 datatypes localized in different ways.
  2. The System Architect documents a data exchange scenario
  3. The Software Engineer uses the metadata, ECCF artifacts, and caBIG compliant APIs to exchange data from one system to another.

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

None. 

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.

 Init1pm16 - 21090 Datatype Support

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.. The documentation and semantic metadata should be sufficient information to determine the mechanism by which data can be exchanged between systems.