Page History

Versions Compared

Old Version 2

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

Saved on Dec 28, 2009

compared with

New Version Current

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

Saved on Jan 23, 2012

Key

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

Comment: Migration of unmigrated content due to installation of a new plugin

Scrollbar

icons	false

Page info
title
title

Panel

title	Contents of this Page

Table of Contents

minLevel	2

Init1pm11.1 - Import Analysis Model

Use Case Number	Init1pm11.1
Brief Description	The first step in working with a DAM is to import the DAM into your modeling tool so that you can further refine it for your specific needs.
Actor(s) for this particular use case	Information Modeler
Pre-condition The state of the system before the user interacts with it	DAM is registered in a metadata repository
Post condition The state of the system after the user interacts with it	The DAM is available within the Information Modeler's UML modeling tool and represented by classes, attributes, and associations. T
Steps to take The step-by-step description of how users will interact with the system to achieve a specific business goal or function	Information Modeler opens modeling tool Information Modeler searches metadata repository for the desired DAM Information Modeler imports the DAM into his modeling tool
Alternate Flow Things which would prevent the normal flow of the use case	An alternate flow to this use case is that the Information Modeler imports the DAM from another information model (which may be refined rather than the vanilla DAM). Therefore, it may be desirable for Information Modelers to register refined DAMs themselves to be shared with others.
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.	Init1pm11 - LS DAM refinement and utilization
Fit criterion/Acceptance Criterion How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement?	The Information Modeler must be able to import a DAM into his UML modeling tool, it must be represented fully (so that it can be refined), and it must be able to be derived into an implementation model.

Init1pm11.2 - Refine Analysis Model

Use Case Number

Init1pm11.2

Brief Description

A key aspect of ISO 21090 datatypes is that they can be localized for use within a specific information model. The datatypes themselves define a number of optional attributes and associations, and the actual behavior of the datatypes in some cases can be modified. Specifically, ISO 21090 has two types of conformance: Direct Conformance and Indirect Conformance. Indirect conformance is defined as:

Provide mappings between internal datatypes and the healthcare datatypes

Specify for which of the datatypes an inward mapping is provided, for which an outward mapping is provided, and for which no mapping is providedThis use case describes the steps that an Information Modeler takes to localize the datatypes in alignment of Indirect Conformance

The second step in working with a DAM is to refine it by identifying those classes, attributes, and associations that will not be reused. These should be marked up in the UML in some fashion as to indicate that they are not included in the information model.

Actor(s) for this particular use case

Information Modeler

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

ISO 21090 datatypes have The DAM has been imported in the model (see use Init1pm16Init1pm11.1 above)

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

The ISO 21090 datatypes have been localized DAM has been refined within the Information Modeler's information model (in UML). By value of having imported the datatypes from the metadata repository and following ONLY the below steps, the resulting localized ISO 21090 datatypes are in Indirect Conformance with the specification.

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

The Information Modeler localizes refines enumerations
1. The Information Modeler specifies which enumerations are omitted
2. The Information Modeler specifies which enumerated values are omitted
The Information Modeler localizes refines classes (types)
1. The Information Modeler specifies which attributes are omitted
2. The Information Modeler specifies which classes (types) are omitted
The Information Modeler refines associations
1. The Information Modeler specifies which associations are omitted
The Information Modeler annotates any special considerations, rules, mappings, etc.

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

The steps above do not preclude the creation of ECCF documents or other mappings/specification documents. However, this use case does ease the creation of such documents because the ISO 21090 datatypes are DAM is derived directly from the metadata repository (meaning they have it has the appropriate level of specification/documentation already) and the localizations refinements are made in conformance with the metadata repository conventions.

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.

Init1pm11 - LS DAM refinement and utilization

Table of Contents

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?

The datatatypes DAM should be localized using the conventions of the UML modeling tool. That is, it is highly desirable that user actions be constrained by what will be conformant when the localized datatypes are DAM is registered and shared.
It is absolutely critical that the resulting localized datatypes be in conformance with the conformance metrics defined in the ISO 21090 specification, as well as when the DAM is used to create an implementation model.

Init1pm11.3 -

...

Derive Implementation Model

Use Case Number	Init1pm11.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 The third step in working with a DAM is to derive an implementation model based upon the DAM. The Information Modeler imports the refined DAM into his implementation model package and adds the necessary specificity such that it can be implemented.
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 DAM has been refined 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 generatedimplementation model is created that has the necessary information for semantic annotation and registration, as well as the necessary information for generating a DAM mapping document.
Steps to take The step-by-step description of how users will interact with the system to achieve a specific business goal or function	The Information Modeler imports the refined DAM into his implementation space/package. The Information Modeler refines the imported entities The Information Modeler modifies the names of classes, attributes, and association endpoints The Information Modeler updates the multiplicities of associations The Information Modeler updates the datatype of each attribute The Information Modeler updates enumerations The Information Modeler adds additional modeling entities, including classes, attributes, associations, and enumerations makes whatever manual markup of the model is necessary to generate an XML SchemaThe 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 informationupdates an existing implementation model that has previously been derived from a DAM.
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.	Init1pm11 - LS DAM refinement and utilization 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?	The resulting implementation model has the necessary annotations /information to tie XML Schema types to UML types, which will be registered in the metadata repository. An XML Schema is produced that conforms to the ISO 21090 specifications A document is produced describing the mapping from UML to XSD (not strictly necessary, but desirable)to generate a mapping document that includes modifications to derived DAM entities and additional model entities

Init1pm11.4 -

...

Generate Mapping Document

Use Case Number	Init1pm11.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 The next step in the DAM process is to create a document that describes the changes and additions to the DAM. This includes name changes, excluded classes/attributes, and added classes/attributes.
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 DAM-derived implementation model exists in the Information Modeler's UML modeling tool with all required annotations to be registered, including XML Mappingsgenerate a mapping document.
Post condition The state of the system after the user interacts with it	The information model is registered and available in the metadata repository A mapping document is 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	The Information Modeler selects the information implementation model and datatypes to registerDAM The Information Modeler performs the registration steps directly from his UML modeling tool to generate a mapping document
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.	Init1pm11 - LS DAM refinement and utilization 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?	None. 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.

Init1pm11.5 -

...

Register DAM-derived Implementation Model

Brief Description
Use Case Number	Init1pm11.5
Use Case Number	Init1pm11.6
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
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	The System Architect uses the metadata browser to identify two or more systems with the same ISO 21090 datatypes localized in different ways. The System Architect documents a data exchange scenario 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	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.	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?	The documentation and semantic metadata should be sufficient information to determine the mechanism by which data can be exchanged between systems.

Init1pm11.6 - 21090 Datatype Support - Translation Services

As little coding as possible should be required.

ISO 21090 data types have a specific encoding scheme that is significantly different than what has been used thus far in caBIG services. Rather than reengineering existing services entirely, it may be desirable to have a common translation service interface and implementation toolkit that can be used to "wrap" existing non-compliant servicesfinal step in the DAM process is to register a DAM-derived implementation model. This use case is important because it is important to share in the metadata repository the relationship of the implementation model to the original DAM, and, if possible, to the derived DAM.
Actor(s) for this particular use case	Information Modeler Software Engineer
Pre-condition The state of the system before the user interacts with it	One or more services exist that expose datatypes that are not ISO 21090 compliant A refined DAM and completed DAM-derived implementation model exists in the Information Modelers UML tool.
Post condition The state of the system after the user interacts with it	A new service is implemented that exposes the same semantics but with ISO 21090 datatypes The refined DAM and implementation model are 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	The Software Engineer enters a service into the toolkit for remapping The Software Engineer uses the toolkit provided to create mappings from the original datatypes to the ISO 21090 datatypes with minimal coding The Software Engineer generates the new information model automatically and registers it Information Modeler selects the refined DAM and completes the steps necessary to register it in the metadata repository. The Information Modeler selects the implementation model and completes the steps necessary to register it in the metadata repository.The Software Engineer deploys the new and (if necessary) old service
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 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.	Init1pm11 - LS DAM refinement and utilization Init1bes12 - Mapping_transformation support for ISO21090 data types
Fit criterion/Acceptance Criterion How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement?	The relationships between the original DAM, the derived DAM, and the implementation model are captured in the metadata repository.