 ANSI/HL7 V3 COMT, R2-2005 HL7 Version 3 Standard: Shared Messages, Release 2 8/11/2005 |
Content Last Edited: 2009-09-09T22:31:58
2.2 Storyboards
2.3 Application Roles
2.4 Trigger Events
2.5 Refined Message Information Models
2.6 Hierarchical Message Descriptions
2.7 Interactions
The Act Generic Status Message is used to change the status of an Act without altering any of the associated information. Common situations where Act Generic Status Message is used include:
-
simple changes of status, e.g. hold, release, suspend, resume, cancel, abort, and nullify
-
application level acknowledgement or rejection of a message
The (new/current) act status of the order, intent or event Act can be any valid act status (e.g. hold, release, suspend, resume, cancel, abort, nullify).
Note: These message types can be used as a reusable payload in a domain interaction, and between two domain application roles. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
|
||||||
|
For details on the interpretation of this section, see the storyboard discussion in the Version 3 Guide.
The Shared Messages domain will include storyboards, application roles, trigger events, interactions, and message types shared by any of the healthcare domains. Some of these will be for example purposes only. The examples will not be used in their own right but as a reusable payload in various domains. When used in this fashion, the message is trasmitted as a result of a domain interaction and between two domain application roles. In the case where the artifacts can be used in their own right, the reader will be informed of that as well.
This storyboard describes the process of querying for the status of an act. There are three different query/response interactions, each of those interaction pairs related to one specific act mood.
Please note that the mood of the act in the response message determines the applicable interaction pair. If the query message identifies an act, this act doesn't have to be in the same mood as the mood of the focal act of the response message. Example: the HL7 Laboratory domain could create an interaction "given the Act.id of an order (an observation act in order mood), please respond with all related observations (observation acts in event mood) and their status." In this example, the query interaction would be Find Act Event Status, Query. The inFulfillmentOf association of the focal act can be used to identify the order associated with the laboratory observations.
| Find Act Order Status Query |  QUMT_IN020030UV01 |
| Find Act Order Status Query Response | QUMT_IN020040UV01 |
| Find Act Intent Status Query | QUMT_IN020050UV01 |
| Find Act Intent Status Query Response | QUMT_IN020060UV01 |
| Find Act Event Status Query | QUMT_IN020070UV01 |
| Find Act Event Status Query Response | QUMT_IN020080UV01 |
Dr. Eric Emergency has ordered a laboratory test to be performed for his patient Eve Everywoman. Normally a result for the requested test will be reported with 2 hours. After 3 hours, Eric Emergency has not received any results. He selects Eve Everywoman in his HIS system and requests that the status of all laboratory orders that were created today be shown on his screen. The HIS sends the query to the laboratory system (Find Act Order Status).
The HIS responds with zero or more Orders and their statuses (Find Act Order Status Response). The order statuses are displayed on the screen of Eric Emergency. In this list the status of his own order is shown as 'completed'.
|
||||||||||||
|
For details on the interpretation of this section, see the discussion of application roles and their relationships in the Version 3 Guide.
The Shared Messages domain will include storyboards, application roles, trigger events, interactions, and message types shared by any of the healthcare domains. Some of these will be for example purposes only. The examples will not be used in their own right but as a reusable payload in various domains. When used in this fashion, the message is trasmitted as a result of a domain interaction and between two domain application roles. In the case where the artifacts can be used in their own right, the reader will be informed of that as well.
Example Sender application role.
Note: This is not a real Application Role. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
Example Sender application role.
Note: This is not a real Application Role. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
An Act Status Query Placer initiates queries related to the status of acts. This application role is for example purposes only. Refer to specific domains for the appropriate application role.
An Act Status Query Fulfiller responds to Act Status queries. This application role is for example purposes only. Refer to specific domains for the appropriate application role
|
||||||||||||||||||
|
For details on the interpretation of this section, see the discussion of trigger events in the Version 3 Guide.
The Shared Messages domain will include storyboards, application roles, trigger events, interactions, and message types shared by any of the healthcare domains. Some of these will be for example purposes only. The examples will not be used in their own right but as a reusable payload in various domains. When used in this fashion, the message is trasmitted as a result of a domain interaction and between two domain application roles. In the case where the artifacts can be used in their own right, the reader will be informed of that as well.
| Type: |
The Find Act Order Status requests the status of all acts that are in Order mood and match the criteria as specified by the query parameters. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSQ^Q06 order status query event
| Type: | Interaction based |
The Find Act Order Status Response returns acts (and their statuses) that match the parameters as defined in the Query. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSR^Q06 order status query response event.
| Type: |
The Find Act Intent Status requests the status of all acts that are in Intent mood and match the criteria as specified by the query parameters. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSQ^Q06 order status query event.
| Type: |
The Find Act Intent Status Response returns acts (and their statuses) that match the parameters as defined in the Query. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSR^Q06 order status query response event
| Type: |
The Find Act Event Status requests the status of all acts that are in Event mood and match the criteria as specified by the query parameters. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSQ^Q06 order status query event.
| Type: |
The Find Act Event Status, Response returns acts (and their statuses) that match the parameters as defined in the Query. This trigger event is for example purposes only. Refer to specific domains for appropriate trigger events. The closest v2 equivalent is the OSR^Q06 order status query response event.
| Type: |
Note: This is not a real trigger event. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as a result of a domain trigger event, a domain interaction and between two domain application roles.
|
||||||||
|
For details on the interpretation of this section, see the description of RMIMs in the Version 3 Guide.
| Parent: | Shared Interactions (COMT_DM000001UV) |
This query is used to retrieve information related to the existence as well as the status of acts matching certain criteria. (Version 2 mapping: this is a generalized equivalent of the OSQ^Q06 order status query message).
The payload of the response is a Shared Message (Act Generic Status), which identifies an act and its status. The controlActProcess class in the response message may be associated with multiple payloads, thus allowing for a response message which contains the status of multiple acts. The response message may also contain zero payloads in case no matching acts could be found.
The QueryByParameter class and related classes capture information related to act status queries. You are referred to Query Infrastructure for a description of the QueryByParameter and SortControl classes.
QueryByParameter has a number of associated ParameterItem classes:
-
PatientId: Identifies the recordTarget for which Acts are requested. All identifiers listed in this class are related to one specific patient.
-
EffectiveTime: The effective time of the requested Acts should fall within the time interval specified by this parameter value.
-
AuthorId: The Author of the requested Acts should equal one of the authors identified by this parameter value.
-
StatusCode: The statusCode of the requested Acts should be one of the statuscodes specified in this parameter value.
-
ActId: The ID of the requested Act. If the ID of the requested Act is known none of the other parameters need to have a value.
Note: the message types derived from this R-MIM act are used as payloads in domain interactions. The query doesn't contain an act mood parameter. The semantics of the domain interaction specify the mood of the requested acts. Example: a Query for the status of an Order implies that the status request is related to acts in ORD mood.
| Act Status Query | QUMT_HD020010UV01 |
| Parent: | Shared Interactions (COMT_DM000001UV) |
The Act Generic Status Message is used to change the status of an Act without altering any of the associated information. Common situations where Act Genic Status Message is used include:
-
simple changes of status, e.g. hold, release, suspend, resume, cancel, abort, and nullify
-
application level acknowledgement or rejection of a message
The (new/current) act status of the order, intent or event Act can be any valid act status (e.g. hold, release, suspend, resume, cancel, abort, nullify).
Note: These message types can be used as a reusable payload in a domain interaction, and between two domain application roles. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
The base class is ActGenericStatus based on the Act class. ActGenericStatus is a clone of the ActGenericReference base class of the D-MIM. The R-MIM is equal to the D-MIM, except for the following attributes/associations:
The following attributes are contained in the ActGenericStatus act:
-
moodCode: Specifies whether the Act is an activity that has happened, can happen, is happening, is intended to happen, or is requested/demanded to happen (required, defined by domain ActMoodCompletionTrack which is constrained below). For state transition messages, the moodCode will be the same as the original act.
-
Ordered: RQO
-
Intent: PRMS
-
Event: EVN
The HMD related to this RMIM defines three (3) Message Types, constraining the moodCode to one of the above values. Note: For state transition messages, the moodCode will be the same as the original act.
-
Examples
Example #1: If the status of an Order Act changes from active to suspend, the HL7 domain content needs to contain the identification of the act and its new status. The shared message defined in this domain is used as the HL7 domain content in the domain-defined status update interaction.
Example #2: If an interaction cancels an Act and the receiver is to send an application acknowledgement (as identified by the receiver responsibilities in the interaction), the Transmission Wrapper Acknowledgement.typeCode contains AA in the application acknowledgement to indicate that the requested status change was successfully executed; the HL7 domain content consists of the Act (i.e. the Act Generic Status version thereof) that was cancelled. The ActGenericStatus.statusCode attribute contains cancelled.
| Act Generic Status | COMT_HD001100UV01 |
|
||||||||
|
For details on the interpretation of this section, see the description of HMDs in the Version 3 Guide.
| Act Status Query | QUMT_MT020010UV01 | |
The Act Generic Status Message is used to change the status of an Act without altering any of the associated information. Common situations where Act Generic Status Message is used include:
-
simple changes of status, e.g. hold, release, suspend, resume, cancel, abort, and nullify
-
application level acknowledgement or rejection of a message
The (new/current) act status of the order, intent or event Act can be any valid act status (e.g. hold, release, suspend, resume, cancel, abort, nullify).
Note: These message types can be used as a reusable payload in a domain interaction, and between two domain application roles. Shared messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
|
||||||||||||||||||||||
|
For details on the interpretation of this section, see the definition of Interactions in the Version 3 Guide.
The Shared Messages domain will include storyboards, application roles, trigger events, interactions, and message types shared by any of the healthcare domains. Some of these will be for example purposes only. The examples will not be used in their own right but as a reusable payload in various domains. When used in this fashion, the message is trasmitted as a result of a domain interaction and between two domain application roles. In the case where the artifacts can be used in their own right, the reader will be informed of that as well.
Note: This is not a real interaction. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
| Trigger Event | Act Generic Status Trigger Event Example | COMT_TE000001UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Trigger Event Control Act | MCAI_MT700201UV01 |
| Message Type | Act Generic Status - Order | COMT_MT001101UV01 |
| Sender | Example, Sender | COMT_AR000001UV01 |
| Receiver | Example, Receiver | COMT_AR000002UV01 |
| Trigger Event | Find Act Order Status | QUMT_TE020030UV01 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Query Definition | Act Status Query | QUMT_MT020010UV01 |
| Reason | Trigger Event | Interaction |
| Find Act Order Status Query Response | QUMT_TE020040UV01 | QUMT_IN020040UV01 |
| Sender | Act Status Query Placer | QUMT_AR020003UV01 |
| Receiver | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Trigger Event | Find Act Order Status Query Response | QUMT_TE020040UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Definition | Act Generic Status - Order | COMT_MT001101UV01 |
| Sender | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Receiver | Act Status Query Placer | QUMT_AR020003UV01 |
Note: This is not a real interaction. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
| Trigger Event | Act Generic Status Trigger Event Example | COMT_TE000001UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Trigger Event Control Act | MCAI_MT700201UV01 |
| Message Type | Act Generic Status - Intent | COMT_MT001102UV01 |
| Sender | Example, Sender | COMT_AR000001UV01 |
| Receiver | Example, Receiver | COMT_AR000002UV01 |
| Trigger Event | Find Act Order Status | QUMT_TE020030UV01 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Query Definition | Act Status Query | QUMT_MT020010UV01 |
| Reason | Trigger Event | Interaction |
| Find Act Intent Status Query Response | QUMT_TE020040UV01 | QUMT_IN020060UV01 |
| Sender | Act Status Query Placer | QUMT_AR020003UV01 |
| Receiver | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Trigger Event | Find Act Order Status Query Response | QUMT_TE020040UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Definition | Act Generic Status - Intent | COMT_MT001102UV01 |
| Sender | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Receiver | Act Status Query Placer | QUMT_AR020003UV01 |
Note: This is not a real interaction. Common messages, as defined in the Shared Messages Introduction, are not used in their own right but as a reusable payload in various domains. When used in this fashion, the message is transmitted as the result of a domain interaction, and between two domain application roles.
| Trigger Event | Act Generic Status Trigger Event Example | COMT_TE000001UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Trigger Event Control Act | MCAI_MT700201UV01 |
| Message Type | Act Generic Status - Event | COMT_MT001103UV01 |
| Sender | Example, Sender | COMT_AR000001UV01 |
| Receiver | Example, Receiver | COMT_AR000002UV01 |
| Trigger Event | Find Act Order Status | QUMT_TE020030UV01 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Control Act Wrapper | Query Control Act Request : Parameter List | QUQI_MT020001UV01 |
| Query Definition | Act Status Query | QUMT_MT020010UV01 |
| Reason | Trigger Event | Interaction |
| Find Act Event Status Query Response | QUMT_TE020040UV01 | QUMT_IN020080UV01 |
| Sender | Act Status Query Placer | QUMT_AR020003UV01 |
| Receiver | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Trigger Event | Find Act Order Status Query Response | QUMT_TE020040UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Control Act Wrapper | Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 |
| Query Definition | Act Generic Status - Event | COMT_MT001103UV01 |
| Sender | Act Status Query Fulfiller | QUMT_AR020004UV01 |
| Receiver | Act Status Query Placer | QUMT_AR020003UV01 |
| Return to top of page |