The HC_RSP_Z01 collaboration template processes MTRSP_Z01 business objects. The HC_RSP_Z01 collaboration template uses data contained in the MTRSP_Z01 business object to build and populate an MQWF_RSP_Z01 workflow response business object. The collaboration is generally used as one of a pair of closely coupled request/response collaborations. Data stored by HC_QBP_Z01 (the request) is used by the HC_RSP_Z01 collaboration (the response). The MTRSP_Z01 business object is an HL7 Query by Parameter response to a request for all patient records matching a specified list of diagnosis codes between a range of dates.
WebSphere MQ Workflow context data is stored in the PROCESSCONTEXT table.
This collaboration object performs the following tasks:
HC_RSP_Z01 uses the generic MTRSP_Z01 business object to represent an HL7 Query by Parameter response message.
Note: The collaboration does not clear the COMPREPORT database table. The response records are appended to the table.
This section includes information on port bindings and required steps for setting up collaboration objects based on HC_RSP_Z01. For information on standard features, ports, and configuration properties for collaboration templates, and for general information on creating collaboration objects, refer to the documents listed in Required Documents for Creating Collaboration Objects.
The following diagram illustrates HC_RSP_Z01's ports:
Note: To keep the collaboration object from using a port, bind that port to the Port connector. Doing so indicates that the port is unused without causing the collaboration object to provide additional functionality.
Business object | Bound to | Function | Verbs used |
---|---|---|---|
MTRSP_Z01 | Source application's connector or calling collaboration object. | Sends a reference-valued business object to retrieve the full-valued business object. The result determines which verb to use. | Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
MTRSP_Z01 | Source application's connector or calling collaboration object. | Receives the triggering business object. | Create |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
MQWF_RSP_Z01 | Destination application's connector | Sends the WebSphere MQ Workflow response business object out of the collaboration object. | Create |
To set up HC_RSP_Z01 as a stand-alone collaboration object, complete the following steps:
This section illustrates the business processing logic for this collaboration template:
This section illustrates this collaboration template's process logic for the supported verb, Create.
The following diagrams show the process logic for this collaboration template's Create verb.
SYNC_LOGIC diagram
Process HL7 Message diagram
Retrieve Workflow Process Context diagram
Update Process Context Table diagram
Process Query Results diagram
Loop Through Query Results diagram
Loop Through Diagnosis Codes Diagram
Create MQWorkFlow Response diagram
This collaboration template uses the following standard business processes:
This section describes the standard and specific configuration properties for this collaboration:
This collaboration template uses the following standard configuration properties:
This collaboration template has the following configuration properties specific to it:
This property specifies the database connection pool.
Default value | Usage |
---|---|
HEALTHCARE_DB | Defines the database connection pool used by the collaboration. |
This property specifies whether the collaboration object should perform a soft deletion or hard deletion on the process context entry on the PROCESSCONTEXT table. A hard deletion removes the entry. A soft deletion enters a timestamp and status code that allows database maintenance of used entries as a batch or off-hours operation.
Possible values | Usage |
---|---|
true | Causes this collaboration object to delete the row |
false (default value) | Causes this collaboration object to update the row as a soft deletion |
The HL7 protocol allows for query messages and their expected responses to be defined. The trigger event for user-defined queries must begin with the letter Z, hence the QBP_Z01 query message type.
Name | Value |
---|---|
Query Statement ID (Query ID=Znn): | Z01 |
Type | Query |
Query Name | Patients For Diagnosis Codes |
Query Trigger (= MSH-9) | QBP^Z01^QBP_Q11 |
Query Mode | Real time |
Response Trigger (= MSH-9) | RSP^Z01^RSP_K11 |
Query Characteristics | Returns patient records which match the query diagnosis codes |
Purpose | To locate patients with specified diagnoses for a specified time period |
Response Characteristics | |
Based on Segment Pattern |
QBP^Z01^QBP_Q11 query trigger | QBP message value |
---|---|
MSH | Message Header Segment |
QPD | Query Parameter Definition |
RCP | Response Control Parameter |
[DSC] | Continuation Pointer |
RSP^Z01^RSP_K11 response trigger | RSP message value |
---|---|
MSH | Message Header Segment |
MSA | Message Acknowledgement |
[ERR] | Error |
QAK | Query Acknowledgement |
QPD | Query Parameter Definition |
{[ PID {DG1} ]} |
Patient ID Diagnosis |
[DSC] | Continuation Pointer |