HL7 DOC_T12 Document Query Response

A document query came in, and this is the document-oriented response.
HL7 message structure DOC_T12 groups and segments from HL7 v2.5.1 Hide structure

These are the generated groups and segments for the version selected at the top of the page. The article explains the workflow, and this panel follows the chosen HL7 version.

Message Structure

SegmentNameRequiredRepeatable
MSH
 Message Header Yes No
MSA
 Message Acknowledgment Yes No
ERR
 Error No No
QAK
 Query Acknowledgment No No
QRD
 Original-Style Query Definition Yes No
DOC_T12.EVNPIDPV1TXAOBX_SUPPGRP
 Evnpidpv1txaobx Suppgrp group Yes Yes
EVN
 Event Type No No
PID
 Patient Identification Yes No
PV1
 Patient Visit Yes No
TXA
 Transcription Document Header UAC User Authentication Credential Segment Yes No
OBX
 Observation/Result No Yes
DSC
 Continuation Pointer No No

DOC_T12 is the document query response structure used with the older QRY/DOC document-query workflow. A sending system asks for documents, and the DOC response returns query status plus one or more document records with patient, visit, TXA document header, and optional OBX content.

This is an older-style query pattern. You will still see it in reference data and in some document-management interfaces, but many modern implementations use profile-specific APIs, repositories, or newer query patterns instead. When DOC_T12 is present, treat it as a precise local contract rather than a generic search result format.

A small DOC_T12 example

MSH|^~\&|DOCREPO|CITYHOSP|EHR|CITYHOSP|20260715142000||DOC^T12^DOC_T12|DOC120001|P|2.5.1 MSA|AA|QRY120001 QAK|DOCQ0001|OK QRD|20260715141900|R|I|DOCQ0001|||1^RD|123456^^^CITYHOSP^MR|OTH|DOCUMENT EVN|T12|20260715142000 PID|1||123456^^^CITYHOSP^MR||Smith^Jane^Anne^^Ms^^L||19800314|F PV1|1|O|CARD^ROOM1^1^CITYHOSP||||12345^Cardio^Casey TXA|1|DS|TEXT|20260715110000|12345^Cardio^Casey|20260715113000|20260715131500|||45678^Transcriber^Tina|DOC7788^TRANS|DOC7788^TRANS|AV|AU OBX|1|TX|REPORTTEXT^Report text^L||Short discharge summary is available.||||||F DSC|DOC-CONT-0002|I

What systems do with it

The sender is the document repository or document-management application answering a query. The receiver is the application that requested the document list or document content. MSA and ERR report the message/application outcome. QAK reports query status, and QRD echoes the original-style query definition.

The repeating document group carries PID, PV1, TXA, and optional OBX content. DSC can carry a continuation pointer when the result set is too large for one response.

How to read the structure

The required top-level segments are MSH, MSA, QRD, and at least one document-support group. ERR and QAK are optional in the local v2.5.1 structure, but in a practical query interface QAK is usually the first place people look to understand whether the query found records.

Each document-support group requires PID, PV1, and TXA. OBX repeats when content or extracted document text is returned. That means DOC_T12 can be a document index response, a document content response, or a hybrid, depending on the profile.

Implementation traps

The first trap is assuming OBX is always present. If the interface is returning only a list of document headers, TXA may be the main payload and the content may be fetched elsewhere. If the interface returns OBX content, define whether OBX-5 is plain text, encoded data, formatted text, or a profile-specific representation.

The second trap is continuation. If DSC is populated, the receiver has not necessarily seen the full result set. Ignoring DSC can quietly hide older notes, large reports, or later pages of a document list.

The third trap is patient matching. Query responses carry patient identifiers back in PID, but the receiver still needs to verify that the result belongs to the requested patient and organization before filing or displaying it.

Reference notes

The HL7 v2.5 event reference describes Event T12 as QRY/DOC document query, with QRY as the sending side and DOC as the receiving response structure. The Caristix trigger-event index also lists DOC_T12 as a document response used to retrieve a list of documents or a specific document.