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
(Created page 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]]
  
−
=Some Artifact Name=
+
=Logical State Machine=
  
 
<!-- 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 10: Line 9:
  
 
<!-- 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 17: Line 15:
 
<!-- 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)
+
* Implementable (PSM) (RIMBAA)
  
 
'''Column(s)'''
 
'''Column(s)'''
−
* Enterprise/Business
 
 
* Information
 
* Information
−
* Computational
 
−
* Engineering
 
  
 
== 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? -->
−
Text
+
Designers, modelers and implementers of interoperability solutions being created under the SAIF, which solutions are required to be RIM-derived.
 +
* Designers and modelers will use the artifact to constrain the allowed states of RIM classes within RIM based logical models
 +
* Implementers will use the artifact to determine what states are allowed for the classes found in RIM based logical models
  
 
== 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? -->
−
Text
+
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.
  
−
<i>Rationale</i>: More 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.
  
 
== Requirements ==
 
== Requirements ==
  
 
<!-- 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.) -->
−
# Some requirement
+
# SHALL be derived from the full RIM state machine for the appropriate RIM class
−
## <i>Rationale</i>Some reason
+
## <i>Rationale</i>All SAIF based models are drawn from the RIM
−
# Some other requirement
+
# Each RIM class in the model including state/status attribute from the RIM class SHALL be tied to a Logical State Machine
−
## <i>Rationale</i>Some other reason
+
## <i>Rationale</i>Makes explicit the allowed states/state transitions of classes within a logical model
 +
# RIM classes within a Logical Model MAY share the same Logical State Machine
 +
## <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 ==
 
== Relationships and traceability ==

Revision as of 16:12, 8 April 2011

Return to Artifact List

Logical State Machine

Definition and Purpose

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.

SAIF Matrix Location

Row(s)

  • Logical (PIM)
  • Implementable (PSM) (RIMBAA)

Column(s)

  • Information

Audience

Designers, modelers and implementers of interoperability solutions being created under the SAIF, which solutions are required to be RIM-derived.

  • Designers and modelers will use the artifact to constrain the allowed states of RIM classes within RIM based logical models
  • Implementers will use the artifact to determine what states are allowed for the classes found in RIM based logical models

Applicability

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.

Rationale: 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.

Requirements

  1. SHALL be derived from the full RIM state machine for the appropriate RIM class
    1. RationaleAll SAIF based models are drawn from the RIM
  2. Each RIM class in the model including state/status attribute from the RIM class SHALL be tied to a Logical State Machine
    1. RationaleMakes explicit the allowed states/state transitions of classes within a logical model
  3. RIM classes within a Logical Model MAY share the same Logical State Machine
    1. RationaleThe same set of constraints often applies to multiple classes within a logical model
  4. Logical State Machines for multiple classes within Logical Model MAY have inter-dependencies
    1. Rationale

Relationships and traceability

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

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


Issues

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