Supports collaborative care coordination between providers. Key segments include MSH, PID, SCH, OBX. Care coordination platforms and clinical systems exchange this to share patient care information across organizational boundaries.
# Zato
from zato.hl7v2 import HL7Message
# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
'CCM^I21^CCM_I21|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_locationHow to construct, send, receive, and extract fields from real-world CCM^I21 messages.
Demonstrates receiving and extracting key fields from a collaborative care message transaction
# Zato
from zato.hl7v2 import HL7Message
# An incoming message ..
raw = 'MSH|^~\&|SENDER|FAC|RCV|DEST|20260701||' \
'CCM^I21^CCM_I21|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_locationStep-by-step guides for working with HL7 v2 in Zato.
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||CCM^I21^CCM_I21|MSG00001|P|2.9\rPID|1||MRN-10045||JOHNSON^SARAH^M||19880612|F|||100 Oak Lane^^Portland^OR^97201\rPD1|||Family Health Clinic^^12345\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_birthBeyond the mandatory MSH header, the required segments are: PID, IN1, SCH, RGS, OBX, ORC, OBX, PV1. 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.
Segments that make up the CCM^I21 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 | PID | Required | No | Patient identification | - |
| 6 | PD1 | Optional | No | Patient additional demographic | - |
| 7 | NK1 | Optional | Yes | Next of kin / associated parties | - |
| 8 | IN1 | Required | No | Insurance | INSURANCE |
| 9 | IN2 | Optional | No | Insurance additional info | INSURANCE |
| 10 | IN3 | Optional | No | Insurance additional info - certification | INSURANCE |
| 11 | SCH | Required | No | Scheduling activity information | APPOINTMENT_HISTORY |
| 12 | RGS | Required | No | Resource group | APPOINTMENT_HISTORY |
| 13 | OBX | Required | No | Observation result | RESOURCE_DETAIL |
| 14 | PRT | Optional | Yes | Participation information | RESOURCE_DETAIL |
| 15 | ORC | Required | No | Common order | CLINICAL_HISTORY |
| 16 | OBX | Required | No | Observation result | CLINICAL_HISTORY_OBSERVATION |
| 17 | PRT | Optional | Yes | Participation information | CLINICAL_HISTORY_OBSERVATION |
| 18 | VAR | Optional | Yes | Variance | CLINICAL_HISTORY |
| 19 | CTI | Optional | Yes | Clinical trial identification | CLINICAL_HISTORY |
| 20 | PV1 | Required | No | Patient visit | PATIENT_VISITS |
| 21 | PV2 | Optional | No | Patient visit - additional info | PATIENT_VISITS |
| 22 | ORC | Required | No | Common order | MEDICATION_HISTORY |
| 23 | RXO | Required | No | Pharmacy / treatment order | MEDICATION_HISTORY |
| 24 | RXR | Required | Yes | Pharmacy / treatment route | MEDICATION_HISTORY |
| 25 | RXC | Optional | Yes | Pharmacy / treatment component order | MEDICATION_HISTORY |
| 26 | OBX | Required | No | Observation result | MEDICATION_ORDER_OBSERVATION |
| 27 | PRT | Optional | Yes | Participation information | MEDICATION_ORDER_OBSERVATION |
| 28 | RXE | Required | No | Pharmacy / treatment encoded order | MEDICATION_HISTORY |
| 29 | RXR | Required | Yes | Pharmacy / treatment route | MEDICATION_HISTORY |
| 30 | RXC | Optional | Yes | Pharmacy / treatment component order | MEDICATION_HISTORY |
| 31 | OBX | Required | No | Observation result | MEDICATION_ENCODING_OBSERVATION |
| 32 | PRT | Optional | Yes | Participation information | MEDICATION_ENCODING_OBSERVATION |
| 33 | RXA | Required | Yes | Pharmacy / treatment administration | MEDICATION_HISTORY |
| 34 | RXR | Required | No | Pharmacy / treatment route | MEDICATION_HISTORY |
| 35 | OBX | Required | No | Observation result | MEDICATION_ADMINISTRATION_OBSERVATION |
| 36 | PRT | Optional | Yes | Participation information | MEDICATION_ADMINISTRATION_OBSERVATION |
| 37 | CTI | Optional | Yes | Clinical trial identification | MEDICATION_HISTORY |
| 38 | PRB | Required | No | Problem detail | PROBLEM |
| 39 | VAR | Optional | Yes | Variance | PROBLEM |
| 40 | VAR | Optional | Yes | Variance | PROBLEM |
| 41 | OBX | Required | No | Observation result | PROBLEM |
| 42 | PRT | Optional | Yes | Participation information | PROBLEM |
| 43 | GOL | Required | No | Goal detail | GOAL |
| 44 | VAR | Optional | Yes | Variance | GOAL |
| 45 | VAR | Optional | Yes | Variance | GOAL |
| 46 | OBX | Required | No | Observation result | GOAL |
| 47 | PRT | Optional | Yes | Participation information | GOAL |
| 48 | PTH | Required | No | Pathway | PATHWAY |
| 49 | VAR | Optional | Yes | Variance | PATHWAY |
| 50 | VAR | Optional | Yes | Variance | PATHWAY |
| 51 | OBX | Required | No | Observation result | PATHWAY |
| 52 | PRT | Optional | Yes | Participation information | PATHWAY |
| 53 | REL | Optional | Yes | Clinical relationship segment | - |
Get started with Zato and connect your systems in minutes.