Schedule a demo
Segment

Uniform billing data

Carries data elements specific to UB-92 and later UB-04 institutional billing claims in the United States, including condition codes, value codes, occurrence codes, and occurrence span codes. It appears in BAR and DFT messages sent by patient accounting systems to claims processing and clearinghouse systems for inpatient and outpatient institutional billing.

17fields
0required
v2.9HL7 version
ub2.py
from zato.hl7v2 import UB2

ub2 = UB2()
ub2.set_id_ub2 = '1'
ub2.co_insurance_days_9 = '5'
ub2.covered_days_7 = '3'
ub2.document_control_number = 'DOC001'

Build UB2 segments in Python

How to construct and work with real-world UB2 segments.

1

Wellness visit billing

Basic billing record for a routine wellness visit with covered days and document control

from zato.hl7v2.v2_9 import UB2

ub2 = UB2()
ub2.set_id_ub2 = '1'
ub2.co_insurance_days_9 = '5'
ub2.covered_days_7 = '3'
ub2.non_covered_days_8 = '0'
ub2.document_control_number = 'DOC001'
2

Billing locators

Uniform billing locator fields populated for a routine preventive care claim

from zato.hl7v2.v2_9 import UB2

ub2 = UB2()
ub2.set_id_ub2 = '1'
ub2.uniform_billing_locator_11_state = 'CA-7890'
ub2.uniform_billing_locator_31_national = 'LOC31-NAT'
ub2.uniform_billing_locator_49_national = 'NAT49-001'
ub2.uniform_billing_locator_56_state = 'ST56-002'
3

Special visit

Special visit count with condition code for an annual check-up billing record

from zato.hl7v2.v2_9 import UB2
from zato.hl7v2.v2_9 import CWE

ub2 = UB2()
ub2.set_id_ub2 = '1'
ub2.condition_code_24_30 = CWE(
    identifier='30',
    text='Annual checkup'
)
ub2.covered_days_7 = '7'
ub2.non_covered_days_8 = '0'
ub2.document_control_number = 'DOC500'
ub2.special_visit_count = '2'

Learn by building

Step-by-step guides for working with HL7 v2 in Zato.

Frequently asked questions

UB2 carries uniform billing data for institutional claims - co-insurance days, covered and non-covered days, condition codes, value amounts, billing locator fields, and document control numbers. It appears in financial messages to provide the claim-level detail needed for payer adjudication.

Create the segment and access its fields directly:

from zato.hl7v2.v2_9 import UB2

ub2 = UB2()
ub2.covered_days_7 = '3'
ub2.document_control_number = 'DOC001'
ub2.special_visit_count = '2'

covered = ub2.covered_days_7
doc_num = ub2.document_control_number
visit_count = ub2.special_visit_count

The condition_code_24_30 field uses the CWE datatype with HL7 table 0043:

from zato.hl7v2.v2_9 import UB2, CWE

ub2 = UB2()
ub2.condition_code_24_30 = CWE(
    identifier='30',
    text='Annual checkup'
)

UB2 contains several uniform billing locator fields (positions 9-11, 13-16) that carry state and national-level billing identifiers. These are free-text ST fields whose content is defined by the billing jurisdiction. They map to specific form locators on the UB-04 institutional claim form.

Set the covered_days_7 and non_covered_days_8 fields directly as string values:

from zato.hl7v2.v2_9 import UB2

ub2 = UB2()
ub2.set_id_ub2 = '1'
ub2.covered_days_7 = '5'
ub2.non_covered_days_8 = '0'

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.

UB2 field reference

Complete list of fields in the UB2 segment, HL7 v2.9.

#Python nameDatatypeUsageRepeatableTable
1set_id_ub2SIOptionalNo-
2co_insurance_days_9STOptionalNo-
3condition_code_24_30CWEOptionalNoHL70043
4covered_days_7STOptionalNo-
5non_covered_days_8STOptionalNo-
6value_amount_code_39_41UVCOptionalNo-
7occurrence_code_date_32_35OCDOptionalNo-
8occurrence_span_code_dates_36OSPOptionalNo-
9uniform_billing_locator_2_stateSTOptionalNo-
10uniform_billing_locator_11_stateSTOptionalNo-
11uniform_billing_locator_31_nationalSTOptionalNo-
12document_control_numberSTOptionalNo-
13uniform_billing_locator_49_nationalSTOptionalNo-
14uniform_billing_locator_56_stateSTOptionalNo-
15uniform_billing_locator_57_sationalSTOptionalNo-
16uniform_billing_locator_78_stateSTOptionalNo-
17special_visit_countNMOptionalNo-

Ready to build integrations?

Get started with Zato and connect your systems in minutes.

Open source In Python