Carries metadata for a transcribed or electronically authored clinical document, including document type, activity date and time, originator, transcriptionist, authentication status, and unique document identifiers. It is the key segment in MDM (Medical Document Management) messages used to transmit document notifications and content between dictation and transcription systems, EHRs, and clinical document repositories.
from zato.hl7v2.v2_9 import TXA
from zato.hl7v2.v2_9 import CWE, EI, DTM
txa = TXA()
txa.set_id_txa = '1'
txa.document_type = CWE(
identifier='DS',
text='Discharge Summary'
)How to construct and work with real-world TXA segments.
Records a visit summary authored by a provider with activity date, unique document number, and authenticated status
from zato.hl7v2.v2_9 import TXA
from zato.hl7v2.v2_9 import CWE, EI, XCN
txa = TXA()
txa.set_id_txa = '1'
txa.document_type = CWE(
identifier='VS',
text='Visit Summary',
name_of_coding_system='HL70270'
)
txa.document_content_presentation = 'TX'
txa.activity_date_time = '20240610140000'
txa.primary_activity_provider_code_name = XCN(
person_identifier='PRV001',
family_name='GARCIA',
given_name='MARIA'
)
txa.unique_document_number = EI(
entity_identifier='DOC-20240610-001',
namespace_id='ClinicEHR'
)
txa.document_completion_status = 'AU'Creates a consultation note with origination date, transcriptionist, assigned authenticator, and confidentiality status
from zato.hl7v2.v2_9 import TXA
from zato.hl7v2.v2_9 import CWE, EI, XCN
txa = TXA()
txa.set_id_txa = '2'
txa.document_type = CWE(
identifier='CN',
text='Consultation Note',
name_of_coding_system='HL70270'
)
txa.document_content_presentation = 'TX'
txa.activity_date_time = '20240715100000'
txa.primary_activity_provider_code_name = XCN(
person_identifier='PRV002',
family_name='CHEN',
given_name='LIANG'
)
txa.origination_date_time = '20240715093000'
txa.originator_code_name = XCN(
person_identifier='ORG01',
family_name='CHEN',
given_name='LIANG'
)
txa.assigned_document_authenticator = XCN(
person_identifier='AUTH01',
family_name='PATEL',
given_name='ANANYA'
)
txa.transcriptionist_code_name = XCN(
person_identifier='TRN01',
family_name='ROSS',
given_name='EMMA'
)
txa.unique_document_number = EI(
entity_identifier='DOC-20240715-002',
namespace_id='ClinicEHR'
)
txa.document_completion_status = 'DO'
txa.document_availability_status = 'N'Files a wellness assessment report with a document file name, storage status, and legally authenticated completion status
from zato.hl7v2.v2_9 import TXA
from zato.hl7v2.v2_9 import CWE, EI, XCN
txa = TXA()
txa.set_id_txa = '3'
txa.document_type = CWE(
identifier='WA',
text='Wellness Assessment',
name_of_coding_system='HL70270'
)
txa.document_content_presentation = 'TX'
txa.activity_date_time = '20240820090000'
txa.primary_activity_provider_code_name = XCN(
person_identifier='PRV003',
family_name='THOMPSON',
given_name='DAVID'
)
txa.origination_date_time = '20240820083000'
txa.unique_document_number = EI(
entity_identifier='DOC-20240820-003',
namespace_id='ClinicEHR'
)
txa.unique_document_file_name = 'wellness_assessment_20240820.pdf'
txa.document_completion_status = 'LA'
txa.document_availability_status = 'AV'
txa.document_storage_status = 'AC'Step-by-step guides for working with HL7 v2 in Zato.
TXA contains transcription document header information including document types, status, dates, and authentication for medical records.
Common document types include DS (Discharge Summary), PN (Progress Note), OR (Operative Report), and HP (History and Physical).
Common statuses include DO (Dictated), AU (Authenticated), and LA (Legally Authenticated):
from zato.hl7v2.v2_9 import TXA
txa = TXA()
txa.document_completion_status = 'AU'TXA contains document header information while OBX contains the actual document content. OBX segments follow TXA with the document text.
Use folder_assignment with a CWE so coaching notes, nutrition plans, and fitness summaries land in the right chart folder for quick retrieval.
from zato.hl7v2.v2_9 import TXA
from zato.hl7v2.v2_9 import CWE
txa = TXA()
txa.folder_assignment = CWE(
identifier='WELLFIT',
text='Wellness and fitness',
name_of_coding_system='LOCAL'
)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.
Complete list of fields in the TXA segment, HL7 v2.9.
| # | Python name | Datatype | Usage | Repeatable | Table |
|---|---|---|---|---|---|
| 1 | set_id_txa | SI | Required | No | - |
| 2 | document_type | CWE | Required | No | HL70270 |
| 3 | document_content_presentation | ID | Optional | No | HL70191 |
| 4 | activity_date_time | DTM | Optional | No | - |
| 5 | primary_activity_provider_code_name | XCN | Optional | Yes | - |
| 6 | origination_date_time | DTM | Optional | No | - |
| 7 | transcription_date_time | DTM | Optional | No | - |
| 8 | edit_date_time | DTM | Optional | Yes | - |
| 9 | originator_code_name | XCN | Optional | Yes | - |
| 10 | assigned_document_authenticator | XCN | Optional | Yes | - |
| 11 | transcriptionist_code_name | XCN | Optional | Yes | - |
| 12 | unique_document_number | EI | Required | No | - |
| 13 | parent_document_number | EI | Optional | No | - |
| 14 | placer_order_number | EI | Optional | Yes | - |
| 15 | filler_order_number | EI | Optional | No | - |
| 16 | unique_document_file_name | ST | Optional | No | - |
| 17 | document_completion_status | ID | Required | No | HL70271 |
| 18 | document_confidentiality_status | ID | Optional | No | HL70272 |
| 19 | document_availability_status | ID | Optional | No | HL70273 |
| 20 | document_storage_status | ID | Optional | No | HL70275 |
| 21 | document_change_reason | ST | Optional | No | - |
| 22 | authentication_person_time_stamp_set | PPN | Optional | Yes | - |
| 23 | distributed_copies_code_and_name_of_recipients | XCN | Optional | Yes | - |
| 24 | folder_assignment | CWE | Optional | Yes | HL70791 |
| 25 | document_title | ST | Optional | Yes | - |
| 26 | agreed_due_date_time | DTM | Optional | No | - |
| 27 | creating_facility | HD | Optional | No | - |
| 28 | creating_specialty | CWE | Optional | No | HL70792 |
Get started with Zato and connect your systems in minutes.