Message type

Collaborative care update

Supports collaborative care coordination between providers. Key segments include MSH, RF1, PID, SCH. Care coordination platforms and clinical systems exchange this to share patient care information across organizational boundaries.

59segments

27required

15groups

v2.9HL7 version

# Zato
from zato.hl7v2 import HL7Message

# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
      'CCU^I20^CCU_I20|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 CCU^I20 messages in Python

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

Parse an incoming CCU^I20 message

Demonstrates receiving and extracting key fields from a collaborative care update transaction

# Zato
from zato.hl7v2 import HL7Message

# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
      'CCU^I20^CCU_I20|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||CCU^I20^CCU_I20|MSG00001|P|2.9\rRF1||ROUTINE^Routine^HL70283||20260401|20260430\rNK1|1|JOHNSON^MICHAEL|SPO^Spouse|100 Oak Lane^^Portland^OR^97201|5035551234\rREL|1||HAS^Has^HL70948'
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: RF1, PRD, PID, IN1, SCH, RGS, OBX, ORC. 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

CCU^I20 segment composition

Segments that make up the CCU^I20 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	`RF1`	Required	No	Referral information	-
6	`PRD`	Required	No	Provider data	PROVIDER_CONTACT
7	`CTD`	Optional	Yes	Contact data	PROVIDER_CONTACT
8	`PID`	Required	No	Patient identification	PATIENT
9	`PD1`	Optional	No	Patient additional demographic	PATIENT
10	`NK1`	Optional	Yes	Next of kin / associated parties	-
11	`IN1`	Required	No	Insurance	INSURANCE
12	`IN2`	Optional	No	Insurance additional info	INSURANCE
13	`IN3`	Optional	No	Insurance additional info - certification	INSURANCE
14	`SCH`	Required	No	Scheduling activity information	APPOINTMENT_HISTORY
15	`RGS`	Required	No	Resource group	APPOINTMENT_HISTORY
16	`OBX`	Required	No	Observation result	RESOURCE_DETAIL
17	`PRT`	Optional	Yes	Participation information	RESOURCE_DETAIL
18	`ORC`	Required	No	Common order	CLINICAL_HISTORY
19	`OBX`	Required	No	Observation result	CLINICAL_HISTORY_OBSERVATION
20	`PRT`	Optional	Yes	Participation information	CLINICAL_HISTORY_OBSERVATION
21	`VAR`	Optional	Yes	Variance	CLINICAL_HISTORY
22	`CTI`	Optional	Yes	Clinical trial identification	CLINICAL_HISTORY
23	`PV1`	Required	No	Patient visit	PATIENT_VISITS
24	`PV2`	Optional	No	Patient visit - additional info	PATIENT_VISITS
25	`ORC`	Required	No	Common order	MEDICATION_HISTORY
26	`RXO`	Required	No	Pharmacy / treatment order	MEDICATION_HISTORY
27	`PRT`	Optional	Yes	Participation information	MEDICATION_HISTORY
28	`RXR`	Required	Yes	Pharmacy / treatment route	MEDICATION_HISTORY
29	`RXC`	Optional	Yes	Pharmacy / treatment component order	MEDICATION_HISTORY
30	`OBX`	Required	No	Observation result	MEDICATION_ORDER_OBSERVATION
31	`PRT`	Optional	Yes	Participation information	MEDICATION_ORDER_OBSERVATION
32	`RXE`	Required	No	Pharmacy / treatment encoded order	MEDICATION_HISTORY
33	`PRT`	Optional	Yes	Participation information	MEDICATION_HISTORY
34	`RXR`	Required	Yes	Pharmacy / treatment route	MEDICATION_HISTORY
35	`RXC`	Optional	Yes	Pharmacy / treatment component order	MEDICATION_HISTORY
36	`OBX`	Required	No	Observation result	MEDICATION_ENCODING_OBSERVATION
37	`PRT`	Optional	Yes	Participation information	MEDICATION_ENCODING_OBSERVATION
38	`RXA`	Required	No	Pharmacy / treatment administration	MEDICATION_HISTORY
39	`PRT`	Optional	Yes	Participation information	MEDICATION_HISTORY
40	`RXR`	Required	No	Pharmacy / treatment route	MEDICATION_HISTORY
41	`OBX`	Required	No	Observation result	MEDICATION_ADMINISTRATION_OBSERVATION
42	`PRT`	Optional	Yes	Participation information	MEDICATION_ADMINISTRATION_OBSERVATION
43	`CTI`	Optional	Yes	Clinical trial identification	MEDICATION_HISTORY
44	`PRB`	Required	No	Problem detail	PROBLEM
45	`VAR`	Optional	Yes	Variance	PROBLEM
46	`VAR`	Optional	Yes	Variance	PROBLEM
47	`OBX`	Required	No	Observation result	PROBLEM
48	`PRT`	Optional	Yes	Participation information	PROBLEM
49	`GOL`	Required	No	Goal detail	GOAL
50	`VAR`	Optional	Yes	Variance	GOAL
51	`VAR`	Optional	Yes	Variance	GOAL
52	`OBX`	Required	No	Observation result	GOAL
53	`PRT`	Optional	Yes	Participation information	GOAL
54	`PTH`	Required	No	Pathway	PATHWAY
55	`VAR`	Optional	Yes	Variance	PATHWAY
56	`VAR`	Optional	Yes	Variance	PATHWAY
57	`OBX`	Required	No	Observation result	PATHWAY
58	`PRT`	Optional	Yes	Participation information	PATHWAY
59	`REL`	Optional	Yes	Clinical relationship segment	-

Ready to build integrations?

Get started with Zato and connect your systems in minutes.

Get started ▶Read the docs

Open source In Python