Lyrebird implements HL7 v2.x messaging over HTTP/REST for clinical note writeback to EMR systems. This document describes the HL7 message formats generated by Lyrebird when saving clinical notes. We also support MLLP if required.
HL7 Integration can be configured by navigating to the open api page and clicking setup:
And filling out the modal:
Supported Message Types
Message Type | Description | Use Case |
MDM^T02
| Medical Document Management - Original Document Notification | Primary message type for clinical note writeback |
ORU^R01
| Observation Result - Unsolicited Observation Result | Alternative message type for observation-based results |
Supported HL7 Versions
- HL7 v2.3
- HL7 v2.4
- HL7 v2.5 (default)
- HL7 v2.6
MDM^T02 Message Structure
The MDM^T02 message is the primary message type used for clinical note writeback.
MSH - Message Header (required)
PID - Patient Identification (required)
ORC - Common Order (conditional)
PV1 - Patient Visit (conditional)
TXA - Document Notification (required)
OBX - Observation Result (required)
Complete Message Example
MSH|^~\&|LYREBIRD|CLINIC_A|EMR_SYSTEM|HOSPITAL_A|20250113143000||MDM^T02|LYREBIRD17367892001234|P|2.5
PID|1||PAT12345||Smith^John||19800115|M||||||||||
PV1|1|O||||||
TXA|1|CN||20250113143000|DR001|||||||DOC001|||||Clinical Note||AU
OBX|1|TX|CN||Patient presents with mild headache\. No fever\. Advised rest and hydration\.||||||F|||20250113143000
HTTP Transport
Request Format
- Method:** POST
- Content-Type: application/hl7-v2
- Accept: application/hl7-v2
- Authorization: Basic authentication (Base64 encoded username:password)
- Body: Raw HL7 message with `\r` (CR) as segment terminator
Response Format
The EMR system should respond with an HL7 ACK message:
MSH|^~\&|EMR_SYSTEM|HOSPITAL|LYREBIRD|CLINIC|20250113143001||ACK^T02|MSG123|P|2.5
MSA|AA|LYREBIRD17367892001234|Message accepted
Please contact [email protected] should you have any questions about our HL7 integration technical details.