This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Logical State Machine Artifact Definition"

From HL7Wiki
Jump to navigation Jump to search
(Replaced content with "{{subst::Template:SAIF Artifact Definition}}")
Line 1: Line 1:
 +
 
[[Category:SAIF Artifact Definition]]
 
[[Category:SAIF Artifact Definition]]
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
 
[[:Category:SAIF Artifact Definition|Return to Artifact List]]
  
−
=Logical State Machine=
+
=Some Artifact Name=
  
 
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
 
<!-- Artifact names should be descriptive and short.  They may change as we further refine the methodology -->
Line 9: Line 10:
  
 
<!-- At a high level, what is this artifact and why is it needed?  Should ideally be only a few sentences -->
 
<!-- At a high level, what is this artifact and why is it needed?  Should ideally be only a few sentences -->
−
The Logical State Machine artifact is a RIM class state machine or constraint on it.  Used in circumstances where the RIM class based logical model needs to limit the allowed states and state transitions to support a particular use case.
+
 
 +
Put text here
  
 
== SAIF Matrix Location ==
 
== SAIF Matrix Location ==
Line 15: Line 17:
 
<!-- Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate -->
 
<!-- Where does this artifact fit into the SAIF matrix?  Delete those rows and columns that do not apply and provide qualification if appropriate -->
 
'''Row(s)'''
 
'''Row(s)'''
 +
* Conceptual (CIM)
 
* Logical (PIM)
 
* Logical (PIM)
−
* Implementable (PSM) (RIMBAA)
+
* Implementable (PSM)
  
 
'''Column(s)'''
 
'''Column(s)'''
 +
* Enterprise/Business
 
* Information
 
* Information
 +
* Computational
 +
* Engineering
 +
* Technical
 +
 +
== Prior Methodology Correspondence ==
 +
 +
<!-- Identifies how this artifact relates to artifacts from HL7's previous methodology and, in particular, whether there have been changes in scope or behavior from previous artifacts.  In some cases, the artifact will be net new. -->
  
 
== Audience ==
 
== Audience ==
  
−
<!-- Who will be the consumers of this artifact type and what will they do with it? -->
+
<!-- Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.-->
−
Designers, modelers and implementers of interoperability solutions being created under the SAIF, which solutions are required to be RIM-derived.
+
Health Care Community Audiences:
−
* Designers and modelers will use the artifact to constrain the allowed states of RIM classes within RIM based logical models
+
*General public <!-- as health care participants -->
−
* Implementers will use the artifact to determine what states are allowed for the classes found in RIM based logical models
+
*Health care practitioners <!-- of all stripes -->
 +
*Health system administrators <!-- includes payors, pharma management -->
 +
*Health care policy makers
 +
 
 +
Health Care Semantic Analysis Audiences:
 +
*Business Analysts: Map requirements to models (or system requirements)
 +
*Informaticists: Select and differentiate between information models and terminologies
 +
*System analysts: Map system requirements to specific technical solutions
 +
 
 +
Health Care Information Technology (IT) Audiences:
 +
*Standards developers and standards development organizations
 +
*System designers and architects
 +
*System purchasers
 +
*Programmers/implementers
 +
*System vendor management
 +
*Education/Research
  
 
== Applicability ==
 
== Applicability ==
  
 
<!-- Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why? -->
 
<!-- Under what circumstances does this artifact type need to be created?  Are there circumstances where this artifact should not exist?  Why? -->
−
This artifact is mandatory when the states and or state transitions of a RIM class in a Logical Model need to be constrained from the full RIM state machine.
+
Text
  
−
<i>Rationale</i>: There are very few circumstances where a particular logical model will allow all states and state transitions. In addition, there are often multiple classes with in a model where state is tracked and where state of multiple classes have inter-dependencies.
+
<i>Rationale</i>: More text
  
−
== Requirements ==
+
== Requirements, Relationships and Content ==
  
 
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
 
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
−
# SHALL be derived from the full RIM state machine for the appropriate RIM class
+
# Some requirement
−
## <i>Rationale</i>All SAIF based models are drawn from the RIM
+
## <i>Rationale</i>Some reason
−
# Each RIM class in the model including state/status attribute from the RIM class SHALL be tied to a Logical State Machine
+
# Some other requirement
−
## <i>Rationale</i>Makes explicit the allowed states/state transitions of classes within a logical model
+
## <i>Rationale</i>Some other reason
−
# RIM classes within a Logical Model MAY share the same Logical State Machine
+
=== Relationships and traceability ===
−
## <i>Rationale</i>The same set of constraints often applies to multiple classes within a logical model
 
−
# Logical State Machines for multiple classes within Logical Model MAY have inter-dependencies
 
−
## <i>Rationale</i>
 
  
−
== Relationships and traceability ==
+
<!-- What are the other artifacts to which this artifact must or may be required to relate?  (Express those relationships that are "many-to-one" - that is where many of this artifact type will usually relate to one of the other artifact type.) How do they relate?  Why is the relationship important?
  
−
<!-- What are the other artifacts that are related to this artifact? How? Why is the relationship important? -->
+
Follow with a bullet list of artifacts that may or must relate to this artifact, where many of the listed artifact type will relate to one of this artifact type.  
 +
  -->
 
* Some relationship
 
* Some relationship
 
** <i>Rationale</i>: Reason for relationship
 
** <i>Rationale</i>: Reason for relationship
−
 
 
* Some other relationship
 
* Some other relationship
 
** <i>Rationale</i>: Reason for other relationship
 
** <i>Rationale</i>: Reason for other relationship
 +
 +
<b>Artifact types that may or must relate to this artifact types:</b>
 +
* Many-related Artifact Type
 +
* Another Many-related Artifact Type
 +
 +
=== Content ===
 +
 +
<!-- What elements or components are required to be part of this artifact, and what is their hierarchical structure?  How?  Why is the content important? (These can be expresses as a hierarchical set of content element names, with a brief phrase to describe each.) -->
 +
* <b>Content element name</b> - Brief Description
 +
* <b>Another content element name</b> - Brief Description
 +
** <b>Sub-element name</b> - Brief Description
 +
* <b>Another content element name</b> - Brief Description
  
 
== Artifact Technology ==
 
== Artifact Technology ==
Line 125: Line 160:
 
## <i>Rationale</i>: Some other rationale
 
## <i>Rationale</i>: Some other rationale
  
 +
== Artifact Exchange and Version Management ==
 +
 +
 +
<!-- What is the format that will be used to share and exchange "source" representations of this artifact and how will it be managed in source control? -->
 +
 +
== Authoring and Maintenance Tools ==
 +
 +
 +
<!-- What tool or set of alternate tools will be used by HL7 International and recommended for use by others for the development and maintenance of this artifact? -->
 +
 +
== Governance Process Considerations ==
 +
 +
 +
<!-- This section is optional.  It identifies anticipated or existing governance processes that control or impact the development and adoption of this type of artifact.  -->
 +
 +
# <b>Governance Process name</b> - Some process description
 +
## <i>Rationale</i>: Some rationale
 +
# <b>Another Governance Process name</b> - Process description
 +
## <i>Rationale</i>: Some other rationale
  
 
== Issues ==
 
== Issues ==

Revision as of 17:49, 20 July 2011

Return to Artifact List

Some Artifact Name

Definition and Purpose

Put text here

SAIF Matrix Location

Row(s)

  • Conceptual (CIM)
  • Logical (PIM)
  • Implementable (PSM)

Column(s)

  • Enterprise/Business
  • Information
  • Computational
  • Engineering
  • Technical

Prior Methodology Correspondence

Audience

Health Care Community Audiences:

  • General public
  • Health care practitioners
  • Health system administrators
  • Health care policy makers

Health Care Semantic Analysis Audiences:

  • Business Analysts: Map requirements to models (or system requirements)
  • Informaticists: Select and differentiate between information models and terminologies
  • System analysts: Map system requirements to specific technical solutions

Health Care Information Technology (IT) Audiences:

  • Standards developers and standards development organizations
  • System designers and architects
  • System purchasers
  • Programmers/implementers
  • System vendor management
  • Education/Research

Applicability

Text

Rationale: More text

Requirements, Relationships and Content

  1. Some requirement
    1. RationaleSome reason
  2. Some other requirement
    1. RationaleSome other reason

Relationships and traceability

  • Some relationship
    • Rationale: Reason for relationship
  • Some other relationship
    • Rationale: Reason for other relationship

Artifact types that may or must relate to this artifact types:

  • Many-related Artifact Type
  • Another Many-related Artifact Type

Content

  • Content element name - Brief Description
  • Another content element name - Brief Description
    • Sub-element name - Brief Description
  • Another content element name - Brief Description

Artifact Technology

Text here

Rationale

  • Some reason
  • Some other reason

Alternatives

Some technology

  • Some pro or con
  • Some other pro or con

Content Constraints

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Content Guidelines

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Publishing Representation(s)

  1. Some text
    1. Rationale: Some rationale
  2. Some other text
    1. Rationale: Some other rationale

Publishing Constraints

  1. Some rule
    1. Rationale: Some reason
  2. Some other rule
    1. Rationale: Some other reason

Tooling Considerations

  1. Nice-to-have|Required: Some feature
    1. Rationale: Some rationale
  2. Nice-to-have|Required: Some other feature
    1. Rationale: Some other rationale

Development Process Considerations

  1. Some text
    1. Rationale: Some rationale
  2. Some other text
    1. Rationale: Some other rationale

Artifact Exchange and Version Management

Authoring and Maintenance Tools

Governance Process Considerations

  1. Governance Process name - Some process description
    1. Rationale: Some rationale
  2. Another Governance Process name - Process description
    1. Rationale: Some other rationale

Issues

  • Some issue
  • Some other issue
Retrieved from "https://wiki.hl7.org/w/index.php?title=Logical_State_Machine_Artifact_Definition&oldid=52588"