Difference between revisions of "Requirements-Dynamic Model"
Line 328: | Line 328: | ||
* mif-model-dynamic.xsd/ApplicationRole/@createsDocuments | * mif-model-dynamic.xsd/ApplicationRole/@createsDocuments | ||
* mif-model-dynamic.xsd/ApplicationRole/@consumesDocuments | * mif-model-dynamic.xsd/ApplicationRole/@consumesDocuments | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Revision as of 14:41, 21 October 2009
This page documents one or more V3 Methodology Requirements
Requirements
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 |
|
Requirement | Trigger events 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 |
|
Requirement | There are three types of triggering events
|
Rationale | The triggering event type describes the pattern that the interaction follows. |
MIF |
|
Requirement | EnvironmentalOccurrence may have associated text. |
Rationale | Describes the nature of the environmental occurrence (e.g. user action) |
MIF |
|
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 |
|
Requirement | Interactions 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 |
|
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 |
|
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 |
|
Requirement | Each interaction may include one or more sending application and receiving application. |
Rationale | ?. |
MIF |
|
Requirement | Each interaction may have an interaction type. |
Rationale | Synonymous with trigger event types. |
MIF |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
Requirement | A receiver responsibility may have one or more 'response' interactions. |
Rationale | Supports acknowledgements as well as query responses. |
MIF |
|
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 |
|
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 |
|
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 |
|
Requirement | Each application role may have related application roles. |
Rationale | Used to build composites. |
MIF |
|
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 |
|
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 |
|
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 |
|