Returns a query response containing the requested data. The QAK segment reports the query status, QPD echoes the original query parameters, and the payload segments carry the result data. Query-response workflows consume this.
# Zato
from zato.hl7v2 import HL7Message
# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
'RSP^K31^RSP_K31|MSG001|P|2.9\r' \
'QAK|QRY001|OK|Q22\r' \
'QPD|Q22^FindCandidates|QRY001|SMITH^JOHN'
# .. parsed into a Python object ..
msg = HL7Message.parse(raw)
# .. whose fields we can now access.
query_tag = msg.qak.query_tag
status = msg.qak.query_response_status
query_name = msg.qpd.message_query_name
query_tag = msg.qpd.query_tagHow to construct, send, receive, and extract fields from real-world RSP^K31 messages.
Demonstrates receiving and extracting key fields from a dispense history response transaction
# Zato
from zato.hl7v2 import HL7Message
# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
'RSP^K31^RSP_K31|MSG001|P|2.9\r' \
'QAK|QRY001|OK|Q22\r' \
'QPD|Q22^FindCandidates|QRY001|SMITH^JOHN'
# .. parsed into a Python object ..
msg = HL7Message.parse(raw)
# .. whose fields we can now access.
query_tag = msg.qak.query_tag
status = msg.qak.query_response_status
query_name = msg.qpd.message_query_name
query_tag = msg.qpd.query_tagStep-by-step guides for working with HL7 v2 in Zato.
Use the HL7v2 message parser to extract the typed structure. The parsed message gives you direct access to every segment and field by name.
from zato.hl7v2 import HL7Message
raw = 'MSH|^~\&|SENDER|FACILITY|RECEIVER|DEST|20260401120000||RSP^K31^RSP_K31|MSG00001|P|2.9\rMSA|AA|MSG00001\rERR|||0|I|\rQAK|QRY-2001|OK\rQPD|QRY-1001|QRY-2001|\rRCP|I|10^RD\rDSC|CONT-001'
msg = HL7Message.parse(raw)
query_tag = msg.qak.query_tag
status = msg.qak.query_response_statusBeyond the mandatory MSH header, the required segments are: MSA, QAK, QPD, RCP, PID, PV1, ORC, TQ1. Optional segments provide additional detail when available.
Zato connects to any system that speaks HL7v2 over MLLP or FHIR over REST. This includes Epic, Cerner, Meditech, Allscripts, and other EHR platforms.
Yes, Zato has built-in MLLP support for sending and receiving HL7v2 messages. MLLP channels handle the framing protocol automatically.
Zato supports HL7 v2.9, which is backward compatible with earlier versions including v2.3, v2.5, and v2.7. Standard segments and datatypes are available as typed Python classes.
Yes. Zato handles both HL7v2 and FHIR natively, so you can parse v2 messages and build FHIR resources with IG-specific extensions in the same service. Typed Python classes are available for both protocols, including extensions from US Core, UK Core, Da Vinci, and other Implementation Guides.
Segments that make up the RSP^K31 message, in order. Groups are shown with their child segments.
| # | Segment | Usage | Repeats | Description | Group |
|---|---|---|---|---|---|
| 1 | MSH | Required | No | Message header | - |
| 2 | ARV | Optional | Yes | Access restriction | - |
| 3 | MSA | Required | No | Message acknowledgment | - |
| 4 | ERR | Optional | Yes | Error | - |
| 5 | SFT | Optional | Yes | Software segment | - |
| 6 | UAC | Optional | No | User authentication credential | - |
| 7 | QAK | Required | No | Query acknowledgment | - |
| 8 | QPD | Required | No | Query parameter definition | - |
| 9 | RCP | Required | No | Response control parameter | - |
| 10 | PID | Required | No | Patient identification | RESPONSE |
| 11 | PD1 | Optional | No | Patient additional demographic | RESPONSE |
| 12 | PRT | Optional | Yes | Participation information | RESPONSE |
| 13 | NTE | Optional | Yes | Notes and comments | RESPONSE |
| 14 | ARV | Optional | Yes | Access restriction | RESPONSE |
| 15 | AL1 | Optional | Yes | Patient allergy information | RESPONSE |
| 16 | PV1 | Required | No | Patient visit | PATIENT_VISIT |
| 17 | PV2 | Optional | No | Patient visit - additional info | PATIENT_VISIT |
| 18 | PRT | Optional | Yes | Participation information | PATIENT_VISIT |
| 19 | ARV | Optional | Yes | Access restriction | PATIENT_VISIT |
| 20 | ORC | Required | No | Common order | RESPONSE |
| 21 | PRT | Optional | Yes | Participation information | RESPONSE |
| 22 | TQ1 | Required | No | Timing / quantity | TIMING |
| 23 | TQ2 | Optional | Yes | Timing / quantity relationship | TIMING |
| 24 | RXO | Required | No | Pharmacy / treatment order | ORDER_DETAIL |
| 25 | PRT | Optional | Yes | Participation information | ORDER_DETAIL |
| 26 | NTE | Optional | Yes | Notes and comments | ORDER_DETAIL |
| 27 | RXR | Required | Yes | Pharmacy / treatment route | ORDER_DETAIL |
| 28 | RXC | Required | No | Pharmacy / treatment component order | ORDER_DETAIL |
| 29 | NTE | Optional | Yes | Notes and comments | ORDER_DETAIL |
| 30 | RXE | Required | No | Pharmacy / treatment encoded order | ENCODING |
| 31 | PRT | Optional | Yes | Participation information | ENCODING |
| 32 | NTE | Optional | Yes | Notes and comments | ENCODING |
| 33 | TQ1 | Required | No | Timing / quantity | ENCODING |
| 34 | TQ2 | Optional | Yes | Timing / quantity relationship | ENCODING |
| 35 | RXR | Required | Yes | Pharmacy / treatment route | ENCODING |
| 36 | RXC | Optional | Yes | Pharmacy / treatment component order | ENCODING |
| 37 | RXD | Required | No | Pharmacy / treatment dispense | RESPONSE |
| 38 | PRT | Optional | Yes | Participation information | RESPONSE |
| 39 | RXR | Required | Yes | Pharmacy / treatment route | RESPONSE |
| 40 | RXC | Optional | Yes | Pharmacy / treatment component order | RESPONSE |
| 41 | CDO | Optional | Yes | Clinical study data object | RESPONSE |
| 42 | OBX | Required | No | Observation result | OBSERVATION |
| 43 | PRT | Optional | Yes | Participation information | OBSERVATION |
| 44 | NTE | Optional | Yes | Notes and comments | OBSERVATION |
| 45 | DSC | Optional | No | Continuation pointer | - |
Get started with Zato and connect your systems in minutes.