Difference between revisions of "Logical State Machine Artifact Definition"
(2 intermediate revisions by the same user not shown) | |||
Line 9: | 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 | + | |
+ | The primary purpose of a logical state machines is to allow "trigger events" (events that initiate communication) to be defined with respect to the state transitions of select RIM class. These logical state machines are not intended to represent a full behavioral model for their respective classes. At present, logical state machines are only defined for those "back bone" classes that have a unique identity, and thus represent persistent concepts. | ||
== SAIF Matrix Location == | == SAIF Matrix Location == | ||
Line 16: | Line 17: | ||
'''Row(s)''' | '''Row(s)''' | ||
* Logical (PIM) | * Logical (PIM) | ||
− | |||
'''Column(s)''' | '''Column(s)''' | ||
− | * | + | * Computational |
+ | |||
+ | == 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. --> | ||
+ | Corresponds with the state machine defined in prior methodology. | ||
== 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.--> |
− | + | Health Care Semantic Analysis Audiences: | |
− | * | + | *Business Analysts: Map requirements to models (or system requirements) |
− | * | + | *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 | ||
== 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? --> | ||
− | + | A logical state machine is mandatory for each RIM class with a populated stateAttribute property. | |
− | <i>Rationale</i>: | + | <i>Rationale</i>: Provides the reference behavior semantics for key RIM classes. |
− | == 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.) --> | ||
− | # | + | # Include the set of states needed to support a rich set of behaviors for information objects relevant to healthcare. |
− | ## <i>Rationale</i> | + | ## <i>Rationale</i>: Provides common behavioral semantics for RIM based models. |
− | # | + | # Maintain a degree of abstraction in the logical state machine model such that they can be used across a broad range of healthcare information objects. |
− | ## <i>Rationale</i> | + | ## <i>Rationale</i>: The state machine must be applicable to all healthcare objects represented by the associated RIM class. Many healthcare objects may have fine grained specialized states that are not broadly applicable. |
− | + | # Manage the allowed states for a particular logical state machine using controlled terminologies (code systems) that are formally approved as an integral part of the RIM. These terminologies shall be universally bound to the RIM class attribute identified in the stateAttribute for the associated RIM class. | |
− | ## <i>Rationale</i> | + | ## <i>Rationale</i>: Controlling terminologies determine the meaning of the abstract states, and must, themselves be part of the RIM. |
− | + | ||
− | + | === 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? | |
− | + | 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 146: | ||
## <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 == |
Latest revision as of 16:50, 22 July 2011
Contents
- 1 Logical State Machine
- 1.1 Definition and Purpose
- 1.2 SAIF Matrix Location
- 1.3 Prior Methodology Correspondence
- 1.4 Audience
- 1.5 Applicability
- 1.6 Requirements, Relationships and Content
- 1.7 Artifact Technology
- 1.8 Content Constraints
- 1.9 Content Guidelines
- 1.10 Publishing Representation(s)
- 1.11 Publishing Constraints
- 1.12 Tooling Considerations
- 1.13 Development Process Considerations
- 1.14 Artifact Exchange and Version Management
- 1.15 Authoring and Maintenance Tools
- 1.16 Governance Process Considerations
- 1.17 Issues
Logical State Machine
Definition and Purpose
The primary purpose of a logical state machines is to allow "trigger events" (events that initiate communication) to be defined with respect to the state transitions of select RIM class. These logical state machines are not intended to represent a full behavioral model for their respective classes. At present, logical state machines are only defined for those "back bone" classes that have a unique identity, and thus represent persistent concepts.
SAIF Matrix Location
Row(s)
- Logical (PIM)
Column(s)
- Computational
Prior Methodology Correspondence
Corresponds with the state machine defined in prior methodology.
Audience
Health Care Semantic Analysis Audiences:
- Business Analysts: Map requirements to models (or system requirements)
- 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
Applicability
A logical state machine is mandatory for each RIM class with a populated stateAttribute property.
Rationale: Provides the reference behavior semantics for key RIM classes.
Requirements, Relationships and Content
- Include the set of states needed to support a rich set of behaviors for information objects relevant to healthcare.
- Rationale: Provides common behavioral semantics for RIM based models.
- Maintain a degree of abstraction in the logical state machine model such that they can be used across a broad range of healthcare information objects.
- Rationale: The state machine must be applicable to all healthcare objects represented by the associated RIM class. Many healthcare objects may have fine grained specialized states that are not broadly applicable.
- Manage the allowed states for a particular logical state machine using controlled terminologies (code systems) that are formally approved as an integral part of the RIM. These terminologies shall be universally bound to the RIM class attribute identified in the stateAttribute for the associated RIM class.
- Rationale: Controlling terminologies determine the meaning of the abstract states, and must, themselves be part of the RIM.
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
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Content Guidelines
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Publishing Representation(s)
- Some text
- Rationale: Some rationale
- Some other text
- Rationale: Some other rationale
Publishing Constraints
- Some rule
- Rationale: Some reason
- Some other rule
- Rationale: Some other reason
Tooling Considerations
- Nice-to-have|Required: Some feature
- Rationale: Some rationale
- Nice-to-have|Required: Some other feature
- Rationale: Some other rationale
Development Process Considerations
- Some text
- Rationale: Some rationale
- Some other text
- Rationale: Some other rationale
Artifact Exchange and Version Management
Authoring and Maintenance Tools
Governance Process Considerations
- Governance Process name - Some process description
- Rationale: Some rationale
- Another Governance Process name - Process description
- Rationale: Some other rationale
Issues
- Some issue
- Some other issue