 ANSI/HL7 V3 IM, R1-2004 HL7 Version 3 Standard: Infrastructure Management: Query Infrastructure 10/20/2004 |
Content Last Edited: 2005-06-20T19:05:04
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 Query By Parameter topic specifies the formation of information Query By Parameter queries and the responses to these queries to meet the needs of healthcare applications using the HL7 version 3 messaging standard.
|
||||||
|
For details on the interpretation of this section, see the storyboard discussion in the Version 3 Guide.
Query control in HL7 Version 3 is defined by the handling of the events and state transitions identified in the state HL7 Version 3 Query Control state diagram (refer to introduction). Refer to the chapter-defined queries for specific storyboards.
Illustrates the interactions to conduct a generic query by parameter query session.
| Query by Parameter Query Specification |  QUQI_IN000001UV01 |
| General Query Complete Query Response | QUQI_IN000002UV01 |
| General Query Activate Query Continue | QUQI_IN000003UV01 |
| General Query Complete Query Response | QUQI_IN000002UV01 |
| General Query Activate Query Continue | QUQI_IN000003UV01 |
Describes the interactions of the simple scenario where a query by parameter query session is processed between a data requesting application and data serving application. A logical query session is initiated by an application that creates and sends an HL7 version Query By Parameter query specification to another application role that fulfills such requests. The fulfilling application subsequently validates the query request and prepares a query response message with (a) the initial quantity of result sets requested or (b) an exception reason why the logical query session could not be opened. The application responsible for initiating the query request receives the query response message and (a) processes any exception indicated in the query response message that would end the query session, or (b) creates a query continuation message to request "n" more result sets (if n equals 0, this would indicate a request to cancel the logical query session), or (c) do nothing if no more result sets are wanted within the established query session. The exact method for ending a logical query session between a query placer and a query fulfiller would be part of a conformance claim established between the placer and fulfiller application roles for a given implementation.
|
||||||||
|
For details on the interpretation of this section, see the discussion of application roles and their relationships in the Version 3 Guide.
In release 1 of HL7 Version 3, a pair of application roles is provided for managing queries. This pair manages the states and state transitions that are specific to this generic query framework. Refer to chapter-defined queries for specific application roles.
A query requestor that conducts HL7 version 3 queries by using the query by parameter query specification mechanism. To conduct HL7 version 3 queries means that this role manages the query control trigger events that are described in the HL7 version 3 Query Control State Diagram for an application that is requesting information.
A query processing role that responds to HL7 version 3 queries that have been specified by using the query by parameter mechanism. This role manages the query control trigger events that are described in the HL7 version 3 Query Control State Diagram for an application that is creating responses to queries for information.
|
||||||||||||
|
For details on the interpretation of this section, see the discussion of trigger events in the Version 3 Guide.
Each interaction is initiated by a query control state transition that is assigned a Query Control Trigger Event.
| Type: | State-transition based |
| State Transition: | QueryEvent (QUQI_RM020000UV01) |
A new query specification is initiated between a query placer and a query fulfiller. This initiates an HL7 version 3 query session.
| Type: | State-transition based |
| State Transition: | QueryEvent (QUQI_RM000001UV01) |
The processing on the request for the next set of results for an existing query session has been completed. If zero result sets were in the continuation request, then the logical query session is cancelled.
| Type: | State-transition based |
| State Transition: | QueryEvent (QUQI_RM000001UV01) |
A query placer initiates a request to continue sending result sets on an existing query session. If query placer identifies that zero result sets are to be returned, this is equivalent to a request to cancel the logical query session.
| Type: | State-transition based |
| State Transition: | QueryEvent (QUQI_RM120000UV01) |
A query response is completed between a query fulfiller and a query placer within an HL7 version 3 query session.
|
||||||||||||
|
For details on the interpretation of this section, see the description of RMIMs in the Version 3 Guide.
| Parent: | Query Control Act (QUQI_DM000000UV) |
This structure contains the specification of parameters to execute the HL7 Version Query by Parameter Query mechanism. The Query by Parameter Specification Control Act wrapper links to a domain committee defined parameter structure that additionally contains parameters used as a filter to restrict the result set to desired request constraints. The domain content in the new version is ONLY JUST the SINGLE QueryByParameter class with the single attribute statusCode.This class is used in the QUPA mpi query examples as the entry point for those domain specifications.
| Query Control Act Request: ParameterList | QUQI_HD020000UV01 |
| Parent: | Query Control Act (QUQI_DM000000UV) |
| Query Control Act Request: QueryByParameter | QUQI_HD021000UV01 |
| Parent: | Query Control Act (QUQI_DM000000UV) |
This structure contains the identity of an established query session and values to continue or cancel that query sessions. This one has NO domain content. The full QueryContinuation class (with all it's attributes) is IN the wrapper and does NOT appear in the domain content areas. This wrapper has no domain payload.
| Query Control Act Request Continuation / Cancellation Control Act | QUQI_HD000001UV01 |
| Parent: | Query Control Act (QUQI_DM000000UV) |
This structure contains the identity of the established query session in progress, the status of the query session with the current response and statistics for managing the processing of the result set for this query session. If there is a non-null result set, one or more instances from the result set will be linked to the Query General Response ControlAct Wrapper. The act subject is the domain payload, the QueryAck class (plus the control act class) is in the wrapper.
| Query Control Act Response/Acknowledgement | QUQI_HD120000UV01 |
|
||||||||||||
|
For details on the interpretation of this section, see the description of HMDs in the Version 3 Guide.
Query by parameter query specification Control Act with a full complement of associations. The domain-defined entry point stub is ParameterList.
| R_AssignedPerson | COCT_MT090100UV01 |
| R_AssignedDevice | COCT_MT090300UV01 |
| A_DetectedIssue | MCAI_MT900001UV01 |
| Query Control Act Request : Parameter List | QUQI_MT020001UV01 | |
Query by parameter query specification Control Act with a full complement of associations. The QueryEvent is the domain-defined entry point stub.
| R_AssignedPerson | COCT_MT090100UV01 |
| R_AssignedDevice | COCT_MT090300UV01 |
| A_DetectedIssue | MCAI_MT900001UV01 |
| Query Control Act Request : Query By Parameter | QUQI_MT021001UV01 | |
Message is used in a query session to (a) request more result sets in a Query Response or (b) cancel the Query Session.
| R_AssignedPerson | COCT_MT090100UV01 |
| R_AssignedDevice | COCT_MT090300UV01 |
| A_DetectedIssue | MCAI_MT900001UV01 |
| Query Control Act Request Continue / Cancel | QUQI_MT000001UV01 | |
Basic Query Response/Acknowledgement Message Type
| R_AssignedPerson | COCT_MT090100UV01 |
| R_AssignedDevice | COCT_MT090300UV01 |
| A_DetectedIssue | MCAI_MT900001UV01 |
| Query Control Act Response / Acknowledgement | QUQI_MT120001UV01 | |
|
||||||||||
|
For details on the interpretation of this section, see the definition of Interactions in the Version 3 Guide.
Query by parameter query specification to start query session.
| Trigger Event | Query General Execute Query Specification | QUQI_TE000001UV01 |
| Transmission Wrapper | Send Message Payload | MCCI_MT000100UV01 |
| Reason | Trigger Event | Interaction |
| A query response is required for a query specifation for this application role. | QUQI_TE000002UV01 | QUQI_IN000002UV01 |
| Sender | Query by Parameter Placer | QUQI_AR000001UV01 |
| Receiver | Query by Parameter Fulfiller | QUQI_AR000002UV01 |
The General Query Activate Query Continue interaction contains instructions to continue or cancel the identified query session as requested by the originator of the query session.
| Trigger Event | Query General Activate Query Continuation | QUQI_TE000003UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Sender | Query by Parameter Fulfiller | QUQI_AR000002UV01 |
| Receiver | Query by Parameter Placer | QUQI_AR000001UV01 |
General Query Complete Query Response interaction contains status on an identified query session and one or more instances of the query results set if any exist.
| Trigger Event | Query General Complete Query Response | QUQI_TE000002UV01 |
| Transmission Wrapper | Application Level Acknowledgement | MCCI_MT000300UV01 |
| Reason | Trigger Event | Interaction |
| The query fulfiller must return the next set of instances from the result set or return a status indicating that there are no more result instances ofr the current query session. | QUQI_TE000002UV01 | QUQI_IN000002UV01 |
| Sender | Query by Parameter Fulfiller | QUQI_AR000002UV01 |
| Receiver | Query by Parameter Placer | QUQI_AR000001UV01 |
| Return to top of page |