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

Difference between revisions of "Requirements-Dynamic Model"

From HL7Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
This page documents one or more [[:category:V3 Methodology Requirements|V3 Methodology Requirements]]
 
This page documents one or more [[:category:V3 Methodology Requirements|V3 Methodology Requirements]]
 
</div>
 
</div>
 +
 +
===Description===
 +
The HL7 methodology includes two parts needed for communication information between systems, the static model (content itself) and the dynamic model (what is the receiver supposed to do with the information that has been communicated).  This section seeks to briefly describe the dynamic model and to thoroughly document the dynamic model requirements for MIF.
 +
 +
The core of the HL7 dynamic model is the interaction.  A formal definition from HL7:
 +
 +
A unique association between a specific message type (static model or document), a particular trigger event that initiates or "triggers" the transfer, and the Receiver Responsibilities (in terms of response interactions) associated with the receipt of the Interaction.
 +
 +
A single Interaction explicitly answers the questions:
 +
1.What the particular message type is (static model which may be a document, a external addressing (transport) wrapper, and an 'action' wrapper.
 +
2.What caused the message to be sent (triggering event)
 +
3.What is expected of the receiving system (trigger event)
 +
3.How a receiving system knows when it has to send a particular type of response message(s) - (receiver responsibilities).
  
 
===Requirements===
 
===Requirements===
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
| '''Requirement'''  
 
| '''Requirement'''  
−
| Each trigger event must have a unique name
+
| Each interaction must have a trigger event.  HL7 needs to be able to define the 'real world' occurrences that result in a need for information to be exchanged
 
|-
 
|-
 
| ''Rationale''  
 
| ''Rationale''  
−
| The trigger events must be able to be precisely referenced when creating interactions.  The trigger event is the reason for communicating information.
+
| The trigger events must be able to be precisely referenced when creating interactions.  The trigger event is the reason for communicating information.  Part of interoperability is not only what information will get shared but also the circumstances where it will be shared.  A system that does not share the appropriate information at the correct time will not achieve interoperability.
 
|-
 
|-
 
| ''MIF''  
 
| ''MIF''  
 
|
 
|
−
* mif-model-dynamic.xsd/TriggerEvent/@name
+
* mif-model-dynamic.xsd/Interaction/@invokingTriggerEvent
 
|}
 
|}
  
Line 20: Line 33:
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
| '''Requirement'''  
 
| '''Requirement'''  
−
| Trigger events may have annotations
+
| Each trigger event must have a unique name
 
|-
 
|-
 
| ''Rationale''  
 
| ''Rationale''  
−
| Some HL7 artifacts and components convey explicit semantic meaning, for example classes, attributes, concept domains, coded concepts, etc. Other artifacts do not represent particular meaning but still require an explanation of that the artifact is and why it exists.
+
| The trigger events must be able to be precisely referenced when creating interactions. The trigger event is the reason for communicating information.
−
Lack of documentation on an artifact or component can lead to confusion about what the artifact or component is or what it's for.  
 
 
|-
 
|-
 
| ''MIF''  
 
| ''MIF''  
 
|
 
|
−
* mif-model-dynamic.xsd/TriggerEvent/@annotations
+
* mif-model-dynamic.xsd/TriggerEvent/@name
 
|}
 
|}
  
Line 34: Line 46:
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
| '''Requirement'''  
 
| '''Requirement'''  
−
| There are three types of triggering events
+
| Each trigger event must include a type.  There are three types.
 
*interaction-based
 
*interaction-based
 
*state-based
 
*state-based
Line 40: Line 52:
 
|-
 
|-
 
| ''Rationale''  
 
| ''Rationale''  
−
| Each trigger event must include a type.   
+
| The trigger event types communiate the 'pattern' expected as far as receiver responsibilities.  For example, and interaction-based trigger event is 'kicked off' when a triggering interaction is communicated.   
 
|-
 
|-
 
| ''MIF''  
 
| ''MIF''  
Line 78: Line 90:
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
| '''Requirement'''  
 
| '''Requirement'''  
−
| Interactions may have annotations
+
| Each interaction must include one or more static models.  There are use cases where only the transport wrapper, and/or transport and control act wrapper are communicated without a 'payload' (meaning a static model or document).
 
|-
 
|-
 
| ''Rationale''  
 
| ''Rationale''  
−
| Some HL7 artifacts and components convey explicit semantic meaning, for example classes, attributes, concept domains, coded concepts, etc. Other artifacts do not represent particular meaning but still require an explanation of that the artifact is and why it exists.
+
| The interactions must be able to be precisely referenced esp. as part of receiver responsibilities.  Also, the receiving system needs to kn ow
−
Lack of documentation on an artifact or component can lead to confusion about what the artifact or component is or what it's for.
 
 
|-
 
|-
 
| ''MIF''  
 
| ''MIF''  
 
|
 
|
−
* mif-model-dynamic.xsd/Interaction/@annotations
 
−
|}
 
−
 
−
 
−
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
−
| '''Requirement'''
 
−
| Each interaction must include one (reference to a) trigger event and static model.
 
−
|-
 
−
| ''Rationale''
 
−
| The interactions must be able to be precisely referenced esp. as part of receiver responsibilities.
 
−
|-
 
−
| ''MIF''
 
−
|
 
−
* mif-model-dynamic.xsd/Interaction/@invokingTriggerEvent
 
 
* mif-model-dynamic.xsd/Interaction/@argumentMessage
 
* mif-model-dynamic.xsd/Interaction/@argumentMessage
 
|}
 
|}
Line 141: Line 138:
 
|
 
|
 
* mif-model-dynamic.xsd/Interaction/@interactionType
 
* mif-model-dynamic.xsd/Interaction/@interactionType
−
|}
 
−
 
−
 
−
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
−
| '''Requirement'''
 
−
| Structured documents may have annotations
 
−
|-
 
−
| ''Rationale''
 
−
| Some HL7 artifacts and components convey explicit semantic meaning, for example classes, attributes, concept domains, coded concepts, etc. Other artifacts do not represent particular meaning but still require an explanation of that the artifact is and why it exists.
 
−
Lack of documentation on an artifact or component can lead to confusion about what the artifact or component is or what it's for.
 
−
|-
 
−
| ''MIF''
 
−
|
 
−
* mif-model-dynamic.xsd/StructuredDocument/@annotations
 
 
|}
 
|}
  
Line 272: Line 255:
 
|
 
|
 
* mif-model-dynamic.xsd/ApplicationRole/@name
 
* mif-model-dynamic.xsd/ApplicationRole/@name
−
|}
 
−
 
−
 
−
{| border="2" cellspacing="0" cellpadding="3" width="600"
 
−
| '''Requirement'''
 
−
| Application roles may have annotations.
 
−
|-
 
−
| ''Rationale''
 
−
| Some HL7 artifacts and components convey explicit semantic meaning, for example classes, attributes, concept domains, coded concepts, etc. Other artifacts do not represent particular meaning but still require an explanation of that the artifact is and why it exists.
 
−
Lack of documentation on an artifact or component can lead to confusion about what the artifact or component is or what it's for.
 
−
|-
 
−
| ''MIF''
 
−
|
 
−
* mif-model-dynamic.xsd/ApplicationRole/@annotations
 
 
|}
 
|}
  

Revision as of 15:23, 21 October 2009

This page documents one or more V3 Methodology Requirements

Description

The HL7 methodology includes two parts needed for communication information between systems, the static model (content itself) and the dynamic model (what is the receiver supposed to do with the information that has been communicated). This section seeks to briefly describe the dynamic model and to thoroughly document the dynamic model requirements for MIF.

The core of the HL7 dynamic model is the interaction. A formal definition from HL7:

A unique association between a specific message type (static model or document), a particular trigger event that initiates or "triggers" the transfer, and the Receiver Responsibilities (in terms of response interactions) associated with the receipt of the Interaction.

A single Interaction explicitly answers the questions: 1.What the particular message type is (static model which may be a document, a external addressing (transport) wrapper, and an 'action' wrapper. 2.What caused the message to be sent (triggering event) 3.What is expected of the receiving system (trigger event) 3.How a receiving system knows when it has to send a particular type of response message(s) - (receiver responsibilities).

Requirements

Requirement Each interaction must have a trigger event. HL7 needs to be able to define the 'real world' occurrences that result in a need for information to be exchanged
Rationale The trigger events must be able to be precisely referenced when creating interactions. The trigger event is the reason for communicating information. Part of interoperability is not only what information will get shared but also the circumstances where it will be shared. A system that does not share the appropriate information at the correct time will not achieve interoperability.
MIF
  • mif-model-dynamic.xsd/Interaction/@invokingTriggerEvent


Requirement Each trigger event must have a unique name
Rationale The trigger events must be able to be precisely referenced when creating interactions. The trigger event is the reason for communicating information.
MIF
  • mif-model-dynamic.xsd/TriggerEvent/@name


Requirement Each trigger event must include a type. There are three types.
  • interaction-based
  • state-based
  • user-based
Rationale The trigger event types communiate the 'pattern' expected as far as receiver responsibilities. For example, and interaction-based trigger event is 'kicked off' when a triggering interaction is communicated.
MIF
  • Interaction-based: mif-model-dynamic.xsd/TriggeringEvent/@interaction
  • State-based: mif-model-dynamic.xsd/TriggeringEvent/@stateTransition
  • User-based: mif-model-dynamic.xsd/TriggeringEvent/@environmentalOccurrence


Requirement EnvironmentalOccurrence may have associated text.
Rationale Describes the nature of the environmental occurrence (e.g. user action)
MIF
  • mif-model-dynamic.xsd/EnvironmentalOccurrence/@text


Requirement Each interaction must have a unique name
Rationale The interactions must be able to be precisely referenced esp. as part of receiver responsibilities.
MIF
  • mif-model-dynamic.xsd/Interaction/@name


Requirement Each interaction must include one or more static models. There are use cases where only the transport wrapper, and/or transport and control act wrapper are communicated without a 'payload' (meaning a static model or document).
Rationale The interactions must be able to be precisely referenced esp. as part of receiver responsibilities. Also, the receiving system needs to kn ow
MIF
  • mif-model-dynamic.xsd/Interaction/@argumentMessage


Requirement Each interaction may include one or more receiver responsibilities
Rationale Frequently in response to an interaction, one or more 'response' interactions are triggered. There can be multiple responses.
MIF
  • mif-model-dynamic.xsd/Interaction/@receiverResponsiblities


Requirement Each interaction may include one or more sending application and receiving application.
Rationale ?.
MIF
  • mif-model-dynamic.xsd/Interaction/@sendingApplication
  • mif-model-dynamic.xsd/Interaction/@receivingApplication


Requirement Each interaction may have an interaction type.
Rationale Synonymous with trigger event types.
MIF
  • mif-model-dynamic.xsd/Interaction/@interactionType


Requirement Structured documents have a document definition (static model)
Rationale Documents the primary payload model as well as any parameterized stubs within the model.
MIF
  • mif-model-dynamic.xsd/StructuredDocument/@DocumentDefinition


Requirement Interactions have to be able to bind to a message model or a document as the payload.
Rationale There are two 'types' of static model content at HL7. RMIMs which represent workflow-type communications and Documents which represent point-in-time information.
MIF
  • mif-model-dynamic.xsd/BoundStaticModel/@parameterModel


Requirement Interactions may include a use type.
Rationale Identifies the type of content represented by the model when entered from this entry point. The contentType determines whether the model is legitimate content for a classStub from another model.
MIF
  • mif-model-dynamic.xsd/BoundStaticModel/@entryPointUseKind


Requirement A static model may be a choice of payload models
Rationale In some models, the payload is actually a choice of models. Used in models which bring in harmonized and/or summary data.
MIF
  • mif-model-dynamic.xsd/BoundStaticModel/@specialization


Requirement For each query interaction, an additional binding to the parameter list is required. Note this includes query requests as well as query responses.
Rationale The parameter list is required for both requests and responses.
MIF
  • mif-model-dynamic.xsd/ParameterModel


Requirement Each receiver responsibility must have a reason.
Rationale Indicates the conditions under which this receiver responsibility should be chosen. Should be mutually exclusive with the conditions of all other receiver responsibilities for this interaction. Also, the combined reasons for all receiver responsibilities should be complete. I.e. There should be no circumstance that doesn't fit into the reason of one and one receiver responsibility.
MIF
  • mif-model-dynamic.xsd/ReceiverResponsibly/@reason


Requirement A receiver responsibility may have one or more 'response' interactions.
Rationale Supports acknowledgements as well as query responses.
MIF
  • mif-model-dynamic.xsd/ReceiverResponsibly/@invokingInteraction


Requirement A receiver responsibility may have one or more 'response' trigger events.
Rationale Indicates that the specified trigger event should be fired, along with any interactions associated with that trigger event and supported by any of the receiving system's application roles.
MIF
  • mif-model-dynamic.xsd/ReceiverResponsibly/@invokingTriggerEvent


Requirement Each application role must have a unique name
Rationale The sending and receiving application role must be able to be precisely referenced when creating interactions.
MIF
  • mif-model-dynamic.xsd/ApplicationRole/@name


Requirement Each application role may have related application roles.
Rationale Used to build composites.
MIF
  • mif-model-dynamic.xsd/ApplicationRole/@relatedApplicationRoles


Requirement Each application role may be either or both sending interactions and/or receiving interactions.
Rationale Application role is about the functional capability. Need to document for each role when the application expects to receiving information and act; or sends information.
MIF
  • mif-model-dynamic.xsd/ApplicationRole/@sendsInteractions
  • mif-model-dynamic.xsd/ApplicationRole/@receivesInteractions


Requirement Each application role may either create or consume a document.
Rationale Application roles need to deal with documents as well as other static models.
MIF
  • mif-model-dynamic.xsd/ApplicationRole/@createsDocuments
  • mif-model-dynamic.xsd/ApplicationRole/@consumesDocuments


Requirement Interactions, Trigger Events, Application Roles and Structured Documents may have a number of different types of annotations
Rationale See rationales for individual annotations types
Implementation

Future Requirements (not complete)

Note that HL7 is currently re-developing and replacing the current dynamic model methodolgy. Below are SOME of the requirements. Requirements are still being determined and documented as part of the HL7 Enterprise Architecture Framework Alpha implementation projects.

Future Requirement Communicate conformance of receiver responsibilities. It is necessary to know which receiver responsibilities must happen (mandatory), should happen (required), may happen (optional), and must not happen (usually based on a previous elaboration of a receiver responsibility).
Rationale It is necessary to know which receiver responsibilities must happen (mandatory), should happen (required), may happen (optional), and must not happen (usually based on a previous elaboration of a receiver responsibility).
MIF
  • TBD
Retrieved from "https://wiki.hl7.org/w/index.php?title=Requirements-Dynamic_Model&oldid=28262"