Difference between revisions of "Message Wrappers section of the v3Guide"
Rene spronk (talk | contribs) |
Rene spronk (talk | contribs) (new content - major offline edit) |
||
| Line 1: | Line 1: | ||
{{INM Workitem}} | {{INM Workitem}} | ||
| − | Section 3.9 of the v3Guide (May2006) | + | Section 3.9 of the v3Guide (May2006) needs to be updated to reflect the latest thinking on wrappers and infrastructure. The Wiki links have been added with the sole intent that terms are used in a consistent manner (i.e. glossary style); the links won't show up in the v3Guide in ballot or normative standard publications. The text below replaces the entire section 3.9, inclusive of all subsections 3.9.x. |
== 3.9 Version 3 Message Wrappers and Infrastructure == | == 3.9 Version 3 Message Wrappers and Infrastructure == | ||
| − | HL7 Version 3 provides a substantial level of functionality in the provision of envelopes to support the transport of HL7 messages from sender to receiver. HL7 calls these | + | HL7 Version 3 provides a substantial level of functionality in the provision of envelopes to support the transport (in a generic sense of the word) of HL7 messages from sender to receiver. HL7 calls these [[Wrapper|wrapper]]s. Inside the wrappers is the [[Domain Content|domain content]]. |
| − | + | Message wrappers are defined in the same way as message content, by defining object classes and related relationships. These specifications can then be used to generate an ITS-defined syntax (e.g. XML schema) to go on the wire. | |
| − | The | + | The [[Specification Infrastructure]] domain group (which consists of a number of wrapper related domains) specifies the two basic types of wrappers: |
| − | + | *Transmission Wrapper – described in the (MCCI) Transmission Infrastructure domain. | |
| − | + | *Trigger Event Control Act Wrapper (also know as the Control Act Wrapper) – described in three domains, see below for details. | |
| − | |||
| − | |||
| − | Whenever domain | + | Whenever [[Domain Content|domain content]] (as a payload) is transmitted in the form of messages they will use the wrappers as defined by the above domains. A HL7 Version 3 message typically consists of a Transmission Wrapper, a Trigger Event Control Act wrapper (conditional) and the [[Domain Content]] (optional). |
| − | + | HL7 has defined a rich set of transmission oriented functions within the HL7 standards scope because there is no de facto way of providing these functions in a single standard that could be adopted. [[Messaging Infrastructure]] standards such as Webservices or ebXML provide similar functionality, whereas [[MLLP]] or FTP do not. | |
| − | + | === 3.9.1 Transmission Wrapper === | |
| − | + | The HL7 Transmission wrapper is required for all Version 3 messages. It contains a large number of optional fields so the message overhead will vary from one context to another. Loosely coupled systems may require the use of a larger set of attributes than tightly coupled systems. This wrapper may be constrained to fit the requirements of a specific use-case or realm. | |
| − | + | All Transmission Wrappers have mandatory attributes which identify the sending and receiving systems of a message transmission by means of a Device ID. Additional information about the Sender and Receiver may also be transmitted in other classes, but the use of a mandatory attribute ensures that a [[Messaging Infrastructure]] such as ebXML can base its addressing mechanism on the ID of the receiving Device as contained in the Transmission Wrapper. | |
| − | + | Associated with use of the Transmission Wrapper are a number of services and features that are available as needed: | |
| + | *A message with a corresponding R-MIM has been defined to support the reporting of any syntax issues (or the lack of any issues) by the communication software of the receiving application. Note that this is not a reliability feature (although it has been inappropriately used as such in HL7 version 2), HL7 assumes that the underlying [[Messaging Infrastructure]] is reliable. | ||
| + | *An optional message sequence number protocol. It is an essential component of supporting in-sequence delivery at the network level. It is not required if an external mechanism for in-sequence delivery is used (e.g. by means of Webservices or ebXML). | ||
| + | *An optional set of functions and messages to support polling. These functions are included for compatibility with some early V2 use. Polling is probably a matter of limited interest to implementers, other than those with particular legacy problems. | ||
| + | *An optional [[Batch Transmission Wrapper]] used to group messages for transmission purposes. On occasion one may want to group messages before transmitting them, e.g. a batch of financial charge messages, or a group of response messages to a single query message. | ||
| − | + | === 3.9.2 Trigger Event Control Act Wrapper === | |
| − | + | Additional richness in functionality is provided by the [[Trigger Event Control Act Wrapper]] (a.k.a. Control Act Wrapper), which is used when information about the interaction which has triggered a message needs to be communicated within that message to the receiver. Almost all Version 3 messages contain trigger related information. In some exceptional cases there is no need for such information to be included in the message. The Version 3 standard documents which Control Act Wrapper needs to be used for a particular message. A generic wrapper definition is supplied as part of the Specification Infrastructure domain. This wrapper may be constrained to fit the requirements of a specific use-case or realm. | |
| − | |||
| − | |||
| − | + | Two particular areas of application of the Control Act Wrapper are query sessions and registry interactions (such as Master Person Index). Messages in those application areas use specializations (query or registration related extensions) of the basic Control Act Wrapper. | |
| − | + | The Control Act Wrappers are described in the HL7 standard in three separate domains: | |
| − | + | *Message Control Act Infrastructure (MCAI) -defines the basic Trigger Event Control Act Wrapper. | |
| − | + | *Query Infrastructure (QUQI) -describes how to use an extended version of the Control Act wrapper to support queries. The domain describes a generic parameter based query/response mechanism. | |
| − | + | *Master File/Registry Infrastructure (MFMI) -describes how to use an extended version of the Control Act Wrapper to support master file and registry use-cases. The domain describes a generic pattern for the support of registry (e.g. MPI Master Patient Index) interactions. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 22:26, 7 August 2006
This page documents an INM Workitem, i.e. an issue within scope of the INM Committee that either is still being discussed, or the resolution of which has not yet been included in an INM ballot.
Section 3.9 of the v3Guide (May2006) needs to be updated to reflect the latest thinking on wrappers and infrastructure. The Wiki links have been added with the sole intent that terms are used in a consistent manner (i.e. glossary style); the links won't show up in the v3Guide in ballot or normative standard publications. The text below replaces the entire section 3.9, inclusive of all subsections 3.9.x.
3.9 Version 3 Message Wrappers and Infrastructure
HL7 Version 3 provides a substantial level of functionality in the provision of envelopes to support the transport (in a generic sense of the word) of HL7 messages from sender to receiver. HL7 calls these wrappers. Inside the wrappers is the domain content.
Message wrappers are defined in the same way as message content, by defining object classes and related relationships. These specifications can then be used to generate an ITS-defined syntax (e.g. XML schema) to go on the wire.
The Specification Infrastructure domain group (which consists of a number of wrapper related domains) specifies the two basic types of wrappers:
- Transmission Wrapper – described in the (MCCI) Transmission Infrastructure domain.
- Trigger Event Control Act Wrapper (also know as the Control Act Wrapper) – described in three domains, see below for details.
Whenever domain content (as a payload) is transmitted in the form of messages they will use the wrappers as defined by the above domains. A HL7 Version 3 message typically consists of a Transmission Wrapper, a Trigger Event Control Act wrapper (conditional) and the Domain Content (optional).
HL7 has defined a rich set of transmission oriented functions within the HL7 standards scope because there is no de facto way of providing these functions in a single standard that could be adopted. Messaging Infrastructure standards such as Webservices or ebXML provide similar functionality, whereas MLLP or FTP do not.
3.9.1 Transmission Wrapper
The HL7 Transmission wrapper is required for all Version 3 messages. It contains a large number of optional fields so the message overhead will vary from one context to another. Loosely coupled systems may require the use of a larger set of attributes than tightly coupled systems. This wrapper may be constrained to fit the requirements of a specific use-case or realm.
All Transmission Wrappers have mandatory attributes which identify the sending and receiving systems of a message transmission by means of a Device ID. Additional information about the Sender and Receiver may also be transmitted in other classes, but the use of a mandatory attribute ensures that a Messaging Infrastructure such as ebXML can base its addressing mechanism on the ID of the receiving Device as contained in the Transmission Wrapper.
Associated with use of the Transmission Wrapper are a number of services and features that are available as needed:
- A message with a corresponding R-MIM has been defined to support the reporting of any syntax issues (or the lack of any issues) by the communication software of the receiving application. Note that this is not a reliability feature (although it has been inappropriately used as such in HL7 version 2), HL7 assumes that the underlying Messaging Infrastructure is reliable.
- An optional message sequence number protocol. It is an essential component of supporting in-sequence delivery at the network level. It is not required if an external mechanism for in-sequence delivery is used (e.g. by means of Webservices or ebXML).
- An optional set of functions and messages to support polling. These functions are included for compatibility with some early V2 use. Polling is probably a matter of limited interest to implementers, other than those with particular legacy problems.
- An optional Batch Transmission Wrapper used to group messages for transmission purposes. On occasion one may want to group messages before transmitting them, e.g. a batch of financial charge messages, or a group of response messages to a single query message.
3.9.2 Trigger Event Control Act Wrapper
Additional richness in functionality is provided by the Trigger Event Control Act Wrapper (a.k.a. Control Act Wrapper), which is used when information about the interaction which has triggered a message needs to be communicated within that message to the receiver. Almost all Version 3 messages contain trigger related information. In some exceptional cases there is no need for such information to be included in the message. The Version 3 standard documents which Control Act Wrapper needs to be used for a particular message. A generic wrapper definition is supplied as part of the Specification Infrastructure domain. This wrapper may be constrained to fit the requirements of a specific use-case or realm.
Two particular areas of application of the Control Act Wrapper are query sessions and registry interactions (such as Master Person Index). Messages in those application areas use specializations (query or registration related extensions) of the basic Control Act Wrapper.
The Control Act Wrappers are described in the HL7 standard in three separate domains:
- Message Control Act Infrastructure (MCAI) -defines the basic Trigger Event Control Act Wrapper.
- Query Infrastructure (QUQI) -describes how to use an extended version of the Control Act wrapper to support queries. The domain describes a generic parameter based query/response mechanism.
- Master File/Registry Infrastructure (MFMI) -describes how to use an extended version of the Control Act Wrapper to support master file and registry use-cases. The domain describes a generic pattern for the support of registry (e.g. MPI Master Patient Index) interactions.
