API Reference

The pyx12 public API is organized into the following thematic groups. For an exhaustive auto-generated tree of every module, attribute, and class, see the full pyx12.

Reading and writing X12

• pyx12.x12file — streaming reader/writer for an X12 data stream

• pyx12.x12context — context-aware parser; iterate claim loops, alter children, track state

• pyx12.rawx12file — low-level interface to an X12 input stream

Segments and paths

• pyx12.segment — segment, composite, and element model

• pyx12.path — X12 path parser (XPath-style references into a transaction)

Validation

• pyx12.validation — data element type validation (numeric, ID, AN, DT, TM, …)

• pyx12.codes — external code list lookup (place-of-service, claim status, …)

• pyx12.dataele — normalized data element catalog

Map interface

• pyx12.map_if — load and traverse an X12N implementation guide map

• pyx12.map_index — locate the correct map XML for a given transaction

• pyx12.map_walker — walk a map tree to find the node matching the next segment

XML rendering

• pyx12.x12xml — XML rendering of an X12 document

• pyx12.x12xml_simple — simpler XML output format

• pyx12.xmlx12_simple — round-trip XML (simple form) back into X12

• pyx12.xmlwriter — minimal XML output helper

Errors and reporting

• pyx12.errors — exception classes

• pyx12.error_handler — error tree, attaches errors to the ISA/GS/ST hierarchy

• pyx12.error_html — HTML rendering of validation errors

Top-level driver

• pyx12.x12n_document — high-level entry point: validate and emit 997/999/HTML/XML

• pyx12.x12metadata — extract interchange / functional group / transaction metadata

• pyx12.params — runtime parameters and config-file loading