This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Template:SAIF Generic IM Technology"

From HL7Wiki
Jump to navigation Jump to search
 
(17 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
</noinclude>
 
</noinclude>
 
<!-- What technological/standard solution has been selected for use in creating this artifact and why? -->
 
<!-- What technological/standard solution has been selected for use in creating this artifact and why? -->
Text here
+
The '''primary distribution technology''' for this model SHALL be in a file that conforms to the [http://www.hl7.org/v3ballot/html/infrastructure/mif/mif.html HL7 Model Interchange Format] (MIF).
 +
 
 +
The [[#Ideal model creation tool for this artifact|Ideal model creation tool for this artifact]] is defined in the
 +
[[#Tooling Considerations|Tooling Considerations]] section of this document.  The "ideal tool" is used as "requirements" in the following discussion of current tooling and alternatives.
 +
 
 +
===Current (April 2011) model creation tool for this artifact===
 +
<b>[http://gforge.hl7.org/gf/project/visio-rmim-desi HL7 RMIM Designer]</b> in Visio accomplishes all of the functions listed for the [[#Ideal model creation tool for this artifact|''ideal tool'']], except 2., 2.1 and 3.3.  This tool is:
 +
*Written in Microsoft Visio VBA (runs in releases 2002, 2003, 2007, or 2010)
 +
*:
 +
*Has configurable editors - Clone [class] Editor, Vocabulary Selection pane, and CMET Selector - all of which
 +
**Get RIM configuration from a [http://gforge.hl7.org/gf/project/design-repos Design Repository] via [http://gforge.hl7.org/gf/project/rose-tree RoseTree] DLLs
 +
**:
 +
**Get Vocabulary configuration from a Vocabulary "core MIF" file via [http://gforge.hl7.org/gf/project/rose-tree RoseTree] DLLs
 +
**:
 +
**Get data types content and constraints from an RMIM Designer-specific text file
 +
**:
 +
**Get Interface Package contents from an RMIM Designer-specific text file
 +
**:
 +
*Saves primary content in dual files as:
 +
**Using Visio "VSD" files as the Visio-readable source and as the primary graphic storage
 +
**:
 +
**Using an HL7-defined XML file of all content and annotations that includes all data needed to create a [http://gforge.hl7.org/gf/project/mif-schemas MIF] representation.
 +
**:
 +
*Has VBA functions to extract the graphic data as PNG files and a corresponding "mapped overlay" to provide "clickable graphics" that link to textual renderings of the model
 +
*:
 +
*Requires support functions from the [http://gforge.hl7.org/gf/project/v3-generator V3 Generator] to:
 +
**Create a [http://gforge.hl7.org/gf/project/mif-schemas MIF] "output" file that includes graphic data (starting with the XML output from the RMIM Designer), and
 +
**:
 +
**Produce "table views" of the data to which the mapped overlays link.
  
 
=== Rationale ===
 
=== Rationale ===
 
<!-- What's the justification for selecting the chosen technology? -->
 
<!-- What's the justification for selecting the chosen technology? -->
* Some reason
+
This information model artifact has several primary characteristics that act as requirements for the selected technology. These characteristics are:
* Some other reason
+
* The model is a UML Class model with extensions to UML to represent:
 +
** New shapes to represent Entry Points, Interfaces and stubs
 +
**:
 +
**HL7-defined properties for many elements
 +
*:
 +
* The model must be distributed as a machine-processable model represented in the [http://gforge.hl7.org/gf/project/mif-schemas HL7 Model Interchange Format] (MIF) in support of:
 +
**Using any particular model artifact as the "'''derived from'''" source for another model;
 +
**:
 +
**Support [http://gforge.hl7.org/gf/project/v3-generator V3 Generator] process that creates schemas for HL7 V3 specifications
 +
**:
 +
**Support V3 Publishing and Normative Edition packaging and publication processes
 +
*:
 +
* The model must be derived from a predecessor model whose ultimate derivation source is the [[Reference Information Model Artifact Definition|Reference Information Model]] (RIM)
 +
*:
 +
* The model must declare bindings to:
 +
** A [[Abstract Data Types Artifact Definition|Data Types Model]] to which its attributes are bound
 +
**:
 +
** A [[Vocabulary Model Artifact Definition|Vocabulary Model]] to define the terminology bindings for its encoded attributes
 +
**:
 +
** An [[Interface Model Artifact Definition|Interface Model]] from which its interfaces are drawn
 +
*
 +
* Within the model the textual representation for properties governing class attributes is governed by the [[Static Model BNF Grammar]] specified by the Modeling and Methodology Work Group.
  
 
=== Alternatives ===
 
=== Alternatives ===
 
<!-- What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen? -->
 
<!-- What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen? -->
 
+
An alternative tool, the NHS-supported [https://www.projects.openhealthtools.org/sf/projects/staticmodeldesigner/ Static Model Designer] (SMD) has intended characteristics that meet all of the characteristics of the [[#Ideal model creation tool for this artifact|"ideal" tool]] (except, in the early releases, 2.2 and 3.3) has been under development. As of April 2011, there is not sufficient funding to advance the tool to the point that it could replace the current tool suite.
<b>Some technology</b>
 
* Some pro or con
 
* Some other pro or con
 

Latest revision as of 22:02, 11 April 2011

Generic Artifact Technology content for SAIF Information models.
         Only the content appearing below in black font will appear in the inclusion.
These elements are intended to appear under the following section:

Artifact Technology

The primary distribution technology for this model SHALL be in a file that conforms to the HL7 Model Interchange Format (MIF).

The Ideal model creation tool for this artifact is defined in the Tooling Considerations section of this document. The "ideal tool" is used as "requirements" in the following discussion of current tooling and alternatives.

Current (April 2011) model creation tool for this artifact

HL7 RMIM Designer in Visio accomplishes all of the functions listed for the ideal tool, except 2., 2.1 and 3.3. This tool is:

  • Written in Microsoft Visio VBA (runs in releases 2002, 2003, 2007, or 2010)
  • Has configurable editors - Clone [class] Editor, Vocabulary Selection pane, and CMET Selector - all of which
    • Get RIM configuration from a Design Repository via RoseTree DLLs
    • Get Vocabulary configuration from a Vocabulary "core MIF" file via RoseTree DLLs
    • Get data types content and constraints from an RMIM Designer-specific text file
    • Get Interface Package contents from an RMIM Designer-specific text file
  • Saves primary content in dual files as:
    • Using Visio "VSD" files as the Visio-readable source and as the primary graphic storage
    • Using an HL7-defined XML file of all content and annotations that includes all data needed to create a MIF representation.
  • Has VBA functions to extract the graphic data as PNG files and a corresponding "mapped overlay" to provide "clickable graphics" that link to textual renderings of the model
  • Requires support functions from the V3 Generator to:
    • Create a MIF "output" file that includes graphic data (starting with the XML output from the RMIM Designer), and
    • Produce "table views" of the data to which the mapped overlays link.

Rationale

This information model artifact has several primary characteristics that act as requirements for the selected technology. These characteristics are:

  • The model is a UML Class model with extensions to UML to represent:
    • New shapes to represent Entry Points, Interfaces and stubs
    • HL7-defined properties for many elements
  • The model must be distributed as a machine-processable model represented in the HL7 Model Interchange Format (MIF) in support of:
    • Using any particular model artifact as the "derived from" source for another model;
    • Support V3 Generator process that creates schemas for HL7 V3 specifications
    • Support V3 Publishing and Normative Edition packaging and publication processes
  • The model must be derived from a predecessor model whose ultimate derivation source is the Reference Information Model (RIM)
  • The model must declare bindings to:
  • Within the model the textual representation for properties governing class attributes is governed by the Static Model BNF Grammar specified by the Modeling and Methodology Work Group.

Alternatives

An alternative tool, the NHS-supported Static Model Designer (SMD) has intended characteristics that meet all of the characteristics of the "ideal" tool (except, in the early releases, 2.2 and 3.3) has been under development. As of April 2011, there is not sufficient funding to advance the tool to the point that it could replace the current tool suite.