Message type

Add patient accounts

Adds one or more patient accounts to the billing system. The PID segment identifies the patient and PV1 carries the visit information. Financial and accounts receivable systems consume this to create billing records and associate charges.

32segments

7required

1group

v2.9HL7 version

# Zato
from zato.hl7v2 import HL7Message

# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
      'BAR^P01^BAR_P01|MSG001|P|2.9\r' \
      'PID|1||MRN-10045||SMITH^JOHN||19850315|M\r' \
      'PV1|1|I|MED^201^A'

# .. parsed into a Python object ..
msg = HL7Message.parse(raw)

# .. whose fields we can now access.
name = msg.pid.patient_name
dob = msg.pid.date_time_of_birth
patient_class = msg.pv1.patient_class
location = msg.pv1.assigned_patient_location

Python examples

Build and parse BAR^P01 messages in Python

How to construct, send, receive, and extract fields from real-world BAR^P01 messages.

Parse an incoming BAR^P01 message

Demonstrates receiving and extracting key fields from a add patient accounts transaction

# Zato
from zato.hl7v2 import HL7Message

# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
      'BAR^P01^BAR_P01|MSG001|P|2.9\r' \
      'PID|1||MRN-10045||SMITH^JOHN||19850315|M\r' \
      'PV1|1|I|MED^201^A'

# .. parsed into a Python object ..
msg = HL7Message.parse(raw)

# .. whose fields we can now access.
name = msg.pid.patient_name
dob = msg.pid.date_time_of_birth
patient_class = msg.pv1.patient_class
location = msg.pv1.assigned_patient_location

Tutorials

Learn by building

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

MLLP

Receive and parse HL7 v2 messages

Set up an MLLP channel, parse incoming messages, and respond with acknowledgments.

Start tutorial Build

Build and send HL7 v2 messages

Construct HL7 v2 messages from scratch using typed segment classes and send them over MLLP.

Start tutorial

FAQ

Frequently asked questions

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||BAR^P01^BAR_P01|MSG00001|P|2.9\rEVN|P01|20260401120000\rPID|1||MRN-10045||JOHNSON^SARAH^M||19880612|F|||100 Oak Lane^^Portland^OR^97201\rPD1|||Family Health Clinic^^12345\rPRT|1||AT^Attending||1234^CHEN^DAVID^L^^^MD\rROL|1|AD|AT^Attending^HL70443|1234^CHEN^DAVID^L^^^MD'
msg = HL7Message.parse(raw)

name = msg.pid.patient_name
dob = msg.pid.date_time_of_birth

Beyond the mandatory MSH header, the required segments are: EVN, PID, PV1, DG1, PR1, IN1. 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.

Reference

BAR^P01 segment composition

Segments that make up the BAR^P01 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	`SFT`	Optional	Yes	Software segment	-
4	`UAC`	Optional	No	User authentication credential	-
5	`EVN`	Required	No	Event type	-
6	`PID`	Required	No	Patient identification	-
7	`PD1`	Optional	No	Patient additional demographic	-
8	`PRT`	Optional	Yes	Participation information	-
9	`ROL`	Optional	Yes	Role	-
10	`PV1`	Required	No	Patient visit	VISIT
11	`PV2`	Optional	No	Patient visit - additional info	VISIT
12	`PRT`	Optional	Yes	Participation information	VISIT
13	`ROL`	Optional	Yes	Role	VISIT
14	`DB1`	Optional	Yes	Disability	VISIT
15	`OBX`	Optional	Yes	Observation result	VISIT
16	`PRT`	Optional	Yes	Participation information	VISIT
17	`AL1`	Optional	Yes	Patient allergy information	VISIT
18	`DG1`	Required	No	Diagnosis	VISIT
19	`DRG`	Optional	No	Diagnosis related group	VISIT
20	`PR1`	Required	No	Procedures	VISIT
21	`PRT`	Optional	Yes	Participation information	VISIT
22	`ROL`	Optional	Yes	Role	VISIT
23	`GT1`	Optional	Yes	Guarantor	VISIT
24	`NK1`	Optional	Yes	Next of kin / associated parties	VISIT
25	`IN1`	Required	No	Insurance	VISIT
26	`IN2`	Optional	No	Insurance additional info	VISIT
27	`IN3`	Optional	Yes	Insurance additional info - certification	VISIT
28	`PRT`	Optional	Yes	Participation information	VISIT
29	`ROL`	Optional	Yes	Role	VISIT
30	`ACC`	Optional	No	Accident	VISIT
31	`UB1`	Optional	No	UB82	VISIT
32	`UB2`	Optional	No	Uniform billing data	VISIT

Ready to build integrations?

Get started with Zato and connect your systems in minutes.

Get started ▶Read the docs

Open source In Python