pMDsoft HL7 Interface Specifications

Revision History

Date
Comments
2009-10-14 Updated the default DFT P03 specification based on recent format changes in pMDsoft.
2009-07-30 Additional information about the MLLP envelope for TCP/IP.
2009-07-28 Added information about new types of message transfer: TCP/IP and Web Services.
2008-07-22
HL7 documentation overhaul complete - first draft of new documentation finished.

Overview


pMDsoft exchanges information with other medical software systems using the industry standard HL7 protocol.  We've become experts at interoperating with other medical software packages, and we've yet to encounter a system that we can't work with.  Our HL7 engine is powerful, flexible, robust, secure, and fast: charges, appointments, and patient updates are typically transmitted and processed within a few seconds.  Read on to learn more about the types of data that pMDsoft supports, and the formats that it normally uses for these messages.

This document references concepts contained in the HL7 specifications.  For more information about HL7, please see http://www.hl7.org/

How It Works

pMDsoft transmits both inbound and outbound HL7 messages in realtime.  Each message contains one patient, charge, appointment, or acknowledgment.  We can send and receive messages in a variety of ways, depending on the capabilities of the software system that we're interfacing with:

For HTTPS Message Transfer

To receive ADT (patient) and SIU (appointment) messages, pMDsoft makes a URL available.  The URL contains parameters that are specific to the mutual customer and to the other software system.  The other software system is expected to perform an HTTPS POST message to this URL each time it wants to send a message.  The body of this message is expected to be the HL7 ASCII text.  Finally, a password in the "security" section of the MSH header of the HL7 message authenticates the sender - pMDsoft provides this password.  The body of the HTTPS response is an ACK from pMDsoft acknowledging that the message was received, and any errors that may have occurred trying to process it.

To send ADT (patient) and DFT (charge) messages, pMDsoft performs an HTTPS POST to any arbitrary URL.  One post per message; the message's text is the body of the HTTPS request.  We send a password, which can be any agreed-upon text, in the Security field of the MSH header of the message.  pMDsoft expects an ACK message in the body of the HTTPS response.

For Port-Based Message Transfer

To establish the interface, we install a Windows Service on an Internet-connected computer that is within the same firewall as the other software system, or has access to the other software system via an IPSec or VPN tunnel.  This Windows Service, which we call our HL7 Client, acts as a proxy - it listens on the agreed-upon local port (4449 by default) and transmits to another agreed-upon local port (4448 by default).

As the HL7 Client receives messages on its listening port, it transmits them securely to our servers via HTTPS (HTTP over an SSH tunnel) on port 443.  It then sends an ACK (acknowledgement) to the other software system over the same port on which it received the message.

Furthermore, the HL7 Client fetches messages being sent by pMDsoft and transmits them across its sending port to the other software.  It awaits an ACK on the same port, indicating that each message was received.

Special characters are used to indicate the start and end of each individual message being sent.  pMDsoft adheres to the MLLP (Minimal Lower Level Protocol) standard for separating messages.  The envelope around each message should consist of:

  1. A single vertical tab character to indicate the start of block (Hex), 0x0B, at the beginning of the message.
  2. The characters (Hex) 0x1C (FS) to indicate end of block, and termination character (hex) -  0x0D (carriage return) at the end of the message.

An error ACK (NAK) is specified by the "0x15" character, with the above envelope characters wrapped around it.

For File-Based Message Transfer

To establish the interface, we install a Windows Service on an Internet-connected computer that has access to the inbound and outbound HL7 file directories used by the other software system.  This Windows Service, which we call our HL7 Client, is how we maintain our near-instantaneous transfer speed.  The pMDsoft HL7 Client reads message files from the outbound directory of the other software system at frequent intervals, transmitting them securely to our servers via HTTPS (HTTP over an SSH tunnel) on port 443.  It also fetches message files being sent by pMDsoft and deposits them in the inbound directory of the other software system.

Supported Messages

Inbound to pMDsoft

ADT (Patient)
SIU (Appointment)
ACK (Acknowledgment)

Outbound from pMDsoft

ADT (Patient)
DFT (Charge)

Message Formatting

Each message file consists of UTF-8 characters representing the HL7 message.  The exact layout of a message is as follows:

ADT Message Format

ADT messages allow the exchange of patient information between pMDsoft and other software systems.  Patients created in other software systems
are not automatically activated to the census in pMDsoft.  Rather, they are created as inactive patients in the All Patients list, allowing doctors to activate them easily without having to enter their demographics; and automatically linking charges entered for these patients to the original patient in the other software system.

The different types of ADT messages that pMDsoft supports (both inbound and outbound) are as follows:


Supported ADT Segments

Segment
Name
Required?
MSH
Header
Yes
EVN
Event Type
Yes
PID
Patient ID
Yes
PV1
Patient Visit
Yes

Sample Inbound ADT A08 Message
MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080717120312||ADT^A08|123-20080717120312|P|2.3|||NE|NE
EVN|A08|20080717120312
PID|1||987654|A123456|Smith^John^Q||19600411000000|M|||123 Main St.^^New York^NY^11101||(123)456-7890^^^^^123^4567890|(321)654-0987X3000^^^^^321^6540987^3000|||||888776666
PV1|1|R|^^^00123||||97^Jones^Mary^Q^MD|12^Baker^Joseph^Q^DO||||||||||||||||||||||||||||||||||||20080715|20080717

Sample Outbound ADT A04 Message
MSH|^~\&|PMD_B|123456|AnotherSoftwareSystem|EmpireMedicalAssociates|20080717120312||ADT^A04|123-20080717120312|P|2.3|||AL|AL
EVN|A04|20080717120312
PID|1||987654|A123456|Smith^John^Q||19600411000000|M|||123 Main St.^^New York^NY^11101||(123)456-7890^^^^^123^4567890|(321)654-0987X3000^^^^^321^6540987^3000|||||888776666
PV1|1|R|^^^00123||||97^Jones^Mary^Q^MD|12^Baker^Joseph^Q^DO||||||||||||||||||||||||||||||||||||20080715|20080717

DFT
Message Format

pMDsoft sends charges to external software systems using DFT messages.  The charges are sent only as they are marked "Billed" in pMDsoft, and not before.  This allows several levels of review, edits, and verification to take place in pMDsoft, to ensure that the charge is ready for billing before it's sent.  pMDsoft does not accept inbound DFT messages.

The type of DFT message that pMDsoft sends is P03 (Charge Submitted).

DFT Segments Sent by pMDsoft

Segment
Name
Always Sent?
MSH Header
Yes
EVN Event Type
Yes
PID Patient ID
Yes
PV1 Patient Visit
Yes
FT1
Financial Transaction
Yes
IN1
Insurance
No (if needed by the other software system)

Sample DFT Message
MSH|^~\&|^pMDsoft|321|^AnotherSoftwareSystem||20091014145837||DFT^P03|6583558|P|2.3||||AL|
EVN|P03|20091014145837|
PID||987654|987654||Smith^John^Q||19600411|M|||123 Main St.^^New York^NY^11101^USA||(123)456-7890||||||888776666|
PV1||O|^^^123||||^Jones^Mary^Q^^^^^^&1356421622&NPI|^Baker^Joseph^Q^^^^^&1861436503&NPI|||||||||||1222222222|||||||||||||||||||||||^^^123||20091004|
FT1||||20091007000000|20091014|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||99261^Consult F/U Inp 61 Low|12~25
FT1||||20091007000000|20091007|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||93742^Defib-Analy Sngl w/Prog|
FT1||||20091007000000|20091007|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||93621^EP-EPS w/ CS or LA|
IN1|1||999|Some Carrier||||643232498|||||||||Self|||||||||||||||||||11111111111|
IN1|2||3333|Another Carrier||||6884213665||||||||Doe^Jane|Spouse|19570304||||||||||||||||||555555555|

SIU
Message Format

pMDsoft's calendar can be kept in sync with another software system via SIU messages, which are sent to pMDsoft as appointments are created, modified, and cancelled in the other system.  Events in pMDsoft's calendar can then by synchronized to mobile devices, allowing charges to be entered for them easily.  pMDsoft does not send outbound SIU messages.

The different types of SIU messages that pMDsoft supports are as follows:


Supported SIU Segments

Segment
Name
Always Sent?
MSH Header
Yes
SCH
Schedule Activity Information
Yes
NTE
Notes and Comments
No
PID Patient ID
Yes
PV1 Patient Visit
Yes

Sample SIU Message
MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080722124050||SIU^S14|FF1175A4-A8CA-40e0-8F37-5E21C452B8D4|P|2.3||||NE
SCH||123456|||||||||^^1800^20080722080000^20080722083000
NTE|1|Patient Appointment Notes|Follow-up from July 19 w/ Dr. Doe
NTE|2|Appointment Notes|Scheduled for tilt table
PID|1||987654||Smith^John^Q||19600411000000|M|||123 Main St.^^New York^NY^11101||(123)456-7890^^^^^123^4567890|(321)654-0987X3000^^^^^321^6540987^3000|||||888-77-6666
PV1|1|O|^^^00123||||97^Jones^Mary^Q^MD|||||||||||||||||||||||||||||||||||||||||||123456


ACK Message Format


ACK messages tell pMDsoft that the other software system has successfully received and processed an HL7 message that pMDsoft sent it.

The type of ACK message that pMDsoft supports is ACK (Message Acknowledged).

Supported ACK Segments

Segment
Name
Required?
MSH
Header
Yes
MSA
Acknowledgment
Yes

Sample ACK Message
MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080717120312||ACK|456-20080717140755|P|2.3|||NE|NE
MSA|AE|123-20080717120312|Could not find patient.

Segment Details

MSH

Name
Required?
Comments
Type of Segment
Yes
MSH
Encoding Characters
Yes
^~\&
Sending Application
No
<Name of Application>
Example 1 (for inbound messages): AnotherSoftwareSystem
Example 2 (for outbound messages, where patient has a mapped ID in the other software system): PMD_B
Example 3 (for outbound messages, where patient lacks a mapped ID in the other software system): PMD_A
Sending Facility
No
<ID of Practice>
Example 1 (for inbound messages): EmpireMedicalAssociates
Example 2 (for outbound messages): 123456
Receiving Application
No
<Name of Application>
Example 1 (for inbound messages):
pMDsoft
Example 2 (for outbound messages):
AnotherSoftwareSystem
Receiving Facility
No
<ID of Practice>
Example 1 (for inbound messages):
123456
Example 2 (for outbound messages):
EmpireMedicalAssociates
Timestamp of Message
No
Format: YYYYMMDDHHMMSS
Security
No
NOT USED
Type of Message
Yes
<Message Type>^<Event Type>
Example 1 (for new patient): ADT^A04
Example 2 (for patient update): ADT^A08
Control ID of Message
Yes
<Control ID>
Example (for ADT messages, patient ID followed by timestamp of message): 123-20080717120312
Example (for DFT messages, a new GUID):
13D8D448-1F40-A51E-8D5E-FD45D1EE7583
Test Status
Yes
<Test Status>
Example 1 (for Production): P
Example 2 (for Training): T
Version of HL7
Yes
2.3
Sequence #
No
NOT USED
Continuation Pointer
No
NOT USED
Accept Acknowledgment Type
No
<Acknowledgment Condition>
Example (for Always): AL
Application Acknowledgment Type
No
<Acknowledgment Condition>
Example (for Always): AL

Sample MSH Segment - inbound ADT A08

MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080717120312||ADT^A08|123-20080717120312|P|2.3|||NE|NE

Sample MSH Segment - outbound ADT A04

MSH|^~\&|PMD_B|123456|AnotherSoftwareSystem|EmpireMedicalAssociates|20080717120312||ADT^A04|123-20080717120312|P|2.3|||AL|AL

Sample MSH Segment for DFT P03

MSH|^~\&|^pMDsoft|321|^AnotherSoftwareSystem||20091014145837||DFT^P03|6583558|P|2.3||||AL|

Sample MSH Segment for SIU S14

MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080722124050||SIU^S14|FF1175A4-A8CA-40e0-8F37-5E21C452B8D4|P|2.3||||NE

Sample MSH Segment for ACK

MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080717120312||ACK|456-20080717140755|P|2.3|||NE|NE

EVN

Name Required? Comments
Type of Segment
Yes
EVN
Message Type
Yes <Message Type>
Example (for new patient): A04
Example (for patient update): A08
Example (for new charge): P03
Timestamp of Message
Yes
Format: YYYYMMDDHHMMSS

Sample EVN Segment

EVN|A08|20080717120312

PID

Name
Required?
Comments
Type of Segment
Yes
PID
Set ID
No
<Set ID>
Example: 1

Patient ID (External)
No
NOT USED
Patient ID (Internal)
Yes
<Internal ID of Patient>
Example: 987654
Patient ID (Alternate)
No
<Medical Record # of Patient>
Example: A123456
Full Name
Yes
<Last>^<First>^<MI>
Example: Smith^John^Q
Mother's Maiden Name
No
NOT USED
Date of Birth
No
<YYYYMMDD> or <YYYYMMDDHHMMSS>
Example (for ADT messages): 19600411000000
Example (for DFT messages): 19600411
Sex
Yes
<Sex>
Example (for Male): M
Alias
No
NOT USED
Race
No
NOT USED
Address
No
<Address>^^<City>^<State>^<Zip>
Example: 123 Main St.^^New York^NY^11101
Country Code
No
NOT USED
Phone Number (Home)
No
(nnn)nnn-nnnnXnnnnn^^^^^<Area Code>^<Phone>^<ext>
Example:
(123)456-7890^^^^^123^4567890
Phone Number (Work)
No
(nnn)nnn-nnnnXnnnnn^^^^^<Area Code>^<Phone>^<ext>
Example:
(321)654-0987X3000^^^^^321^6540987^3000
Patient's Language
No
NOT USED
Marital Status
No
NOT USED
Region
No
NOT USED
Patient Account #
No
NOT USED
SSN #
No
<SSN>
Example:
888776666

Sample PID Segment for ADT

PID|1||987654|A123456|Smith^John^Q||19600411000000|M|||123 Main St.^^New York^NY^11101||(123)456-7890^^^^^123^4567890|(321)654-0987X3000^^^^^321^6540987^3000|||||888776666

Sample PID Segment for SIU

PID|1||987654||Smith^John^Q||19600411000000|M|||123 Main St.^^New York^NY^11101||(123)456-7890^^^^^123^4567890|(321)654-0987X3000^^^^^321^6540987^3000|||||888-77-6666

Sample PID Segment for DFT

PID||987654|987654||Smith^John^Q||19600411|M|||123 Main St.^^New York^NY^11101^USA||(123)456-7890||||||888776666|

PV1

Name
Required?
Comments
Type of Segment
Yes
PV1
Set ID
No
<Set ID>
Example: 1

Patient Class
Yes
<Patient Class>
Example (for Recurring patient): R
Example (for Outpatient patient): O
NOT USED for DFT messages!
Location - of Patient (for ADT messages) or of Appointment (for SIU messages)
No
^^^<Location ID in other software system>
Example: 00123
NOT USED for DFT messages!
Admission Type
No
NOT USED
Pre-Admit #
No
NOT USED
Prior Location
No
NOT USED
Attending Doctor - of Patient (for ADT messages) or for Appointment (for SIU messages)
No
<Doctor ID>^<Last>^<First>^<MI>^<Suffix>
Example: 97^Jones^Mary^Q^MD
Referring Doctor - of Patient (for ADT messages) or for Appointment (for SIU messages) No
<Doctor ID>^<Last>^<First>^<MI>^<Suffix>
Example: 12^Baker^Joseph^Q^DO
Consulting Doctor
No
NOT USED
Hospital Service
No NOT USED
Temporary Location
No NOT USED
Pre-Admit Test Indicator
No NOT USED
Re-Admission Indicator
No NOT USED
Admit Source
No NOT USED
Ambulatory Status
No NOT USED
VIP Indicator
No NOT USED
Admitting Doctor
No NOT USED
Patient Type
No NOT USED
Visit #
No NOT USED
Financial Class
No NOT USED
Charge Price Indicator
No NOT USED
Courtesy Code
No NOT USED
Credit Rating
No NOT USED
Contract Code
No NOT USED
Contract Effective Date
No NOT USED
Contract Amount
No NOT USED
Contract Period
No NOT USED
Interest Code
No NOT USED
Transfer to Bad Debt Code
No NOT USED
Transfer to Bad Debt Date
No
NOT USED
Bad Debt Agency Code
No NOT USED
Bad Debt Transfer Amount
No NOT USED
Bad Debt Recovery Amount
No NOT USED
Delete Account Indicator
No NOT USED
Delete Account Date
No NOT USED
Discharge Disposition
No NOT USED
Discharged to Location
No NOT USED
Diet Type
No NOT USED
Servicing Facility
No NOT USED
Bed Status
No NOT USED
Account Status
No NOT USED
Pending Location
No NOT USED
Prior Temporary Location
No NOT USED
Admit Timestamp
No <YYYYMMDD>
Example: 20080715
NOT USED for DFT and SIU messages.
Discharge Timestamp
No <YYYYMMDD>
Example: 20080717
NOT USED for DFT and SIU messages.
Current Patient Balance
No NOT USED
Total Charge
No NOT USED
Total Adjustment
No NOT USED
Total Payments
No NOT USED
Appointment ID (for SIU messages only!)
No <Appointment ID>
Example: 123456
NOT USED for ADT and DFT messages.

Sample PV1 Segment for ADT

PV1|1|R|^^^00123||||
97^Jones^Mary^Q^MD|12^Baker^Joseph^Q^DO||||||||||||||||||||||||||||||||||||20080715|20080717

Sample PV1 Segment for DFT

PV1||O|^^^123||||^Jones^Mary^Q^^^^^^&1356421622&NPI|^Baker^Joseph^Q^^^^^&1861436503&NPI|||||||||||1222222222|||||||||||||||||||||||^^^123||20091004|

Sample PV1 Segment for inbound SIU

PV1|1|O|^^^00123||||97^Jones^Mary^Q^MD|||||||||||||||||||||||||||||||||||||||||||123456

FT1

Name
Always Sent?
Comments
Type of Segment
Yes
FT1
Set ID
Yes
<Order of This Procedure in the Series>
Example: 1

Transaction ID
No
NOT USED
Transaction Batch ID
No
NOT USED
Transaction Date
Yes
<YYYYMMDDhhmmss>
Transaction Posting Date
No
NOT USED
Transaction Type
Yes
CG
Transaction Code
No
NOT USED
Transaction Description
No NOT USED
Transaction Description (Alternative)
No NOT USED
Transaction Quantity
No NOT USED
Transaction Amount (Extended)
No NOT USED
Transaction Amount (Unit)
No NOT USED
Department Code
No NOT USED
Insurance Plan ID
No NOT USED
Insurance Amount
No NOT USED
Patient Location
Yes
<Location ID>^<Location Name>
Example: 123^Office
Fee Schedule
No NOT USED
Patient Type
No NOT USED
Diagnosis Code
Yes
<ICD Code 1>^<Name 1>~<ICD Code 2>^<Name 2>~<ICD Code 3>^<Name 3>~<ICD Code 4>^<Name 4>
Example: 780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos

NOTE: More or fewer than 4 ICDs per procedure may be present, continuing in the same pattern.
Performed By
Yes
<Doctor ID>^<Last>^<First>^<MI>^<Suffix>
Example: 97^Jones^Mary^Q^MD
Ordered By
No NOT USED
Unit Cost
No NOT USED
Filler Order Number
No NOT USED
Patient Link
No NOT USED
Procedure Code
Yes
<CPT Code>^<Procedure Name>
Example: 99261^Consult F/U Inp 61 Low
Modifier(s)
No <Modifier 1>~<Modifier 2>~<Modifier 3>~<Modifier4>
Example: 12~25

NOTE: Between 0 and 4 modifiers per procedure may be present.

Sample FT1 Segments (all for a single DFT message)

FT1||||20091007000000|20091014|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||99261^Consult F/U Inp 61 Low|12~25
FT1||||20091007000000|20091007|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||93742^Defib-Analy Sngl w/Prog|
FT1||||20091007000000|20091007|CG||||1|||||||||780.4^Dizziness/Giddiness~785.2^Heart Murmur~272.0^Hypercholesterolemia Pure~458.9^Hypotension Nos||||||93621^EP-EPS w/ CS or LA|

IN1

Name
Required?
Comments
Type of Segment
Yes
IN1
Set ID
Yes
<Order of This Insurance Carrier in the Series>
Example: 1

Insurance Plan ID
No
NOT USED
Insurer ID
Yes
<Carrier ID in pMDsoft>
Example: 999
Insurer Name
Yes
<Carrier Name>
Example: Some Carrier
Insurer Address
No
<Address1>^<Address2>^<City>^<State>^<Zip>
Insurer Contact Person
No
NOT USED
Insurer Phone #
No (nnn)nnn-nnnnXnnnnn^^^<Email>^^<Area Code>^<Phone>^<ext>
Group #
No
<Group Number>
Group Name
No NOT USED
Insured's Group Employer ID
No NOT USED
Insured's Group Employer Name
No NOT USED
Plan Effective Date
No NOT USED
Plan Expiration Date
No NOT USED
Authorization Information
No NOT USED
Plan Type
No NOT USED
Name of Insured
No
<Last>^<First>^<MI>^<Suffix>
Example: Doe^Jane
Insured's Relation to Patient
No
<Relationship Code>
Example: Self
Example: Spouse
Example: Child
Example: Other
Insured's Date of Birth
No
<YYYYMMDD>
Insured's Address
No NOT USED
Assignment of Benefits
No NOT USED
Coordination of Benefits
No NOT USED
Coordination of Benefits Priority
No NOT USED
Notice of Admission Flag
No NOT USED
Notice of Admission Date
No NOT USED
Release Information Code
No NOT USED
Pre-Admission Certification
No NOT USED
Verification Date/Time
No NOT USED
Verification By
No NOT USED
Type of Agreement Code
No NOT USED
Billing Status
No NOT USED
Lifetime Reserve Days
No NOT USED
Delay Before L. R. Day
No NOT USED
Company Plan Code
No
NOT USED
Policy #
No
<Insurance Policy #>
Example: 555555555
Policy Deductible
No
NOT USED
Policy Limit Amount
No
NOT USED
Policy Limit Days
No NOT USED
Room Rate - Semi-Private
No NOT USED
Room Rate - Private
No NOT USED
Insured's Employer Status
No NOT USED
Insured's Sex
No
<Sex>

Sample IN1 Segments (all for a single DFT message)

IN1|1||999|Some Carrier||||643232498|||||||||Self|||||||||||||||||||11111111111|
IN1|2||3333|Another Carrier||||6884213665||||||||Doe^Jane|Spouse|19570304||||||||||||||||||555555555|


SCH

Name
Required?
Comments
Type of Segment
Yes
SCH
Placer ID
No
NOT USED
Filler ID
Yes
<Appointment ID>
Example: 123456
3
No NOT USED
4
No NOT USED
5
No NOT USED
Event Reason
No
NOT USED
Appointment Reason
No
NOT USED
8
No
NOT USED
Duration
No
NOT USED
Duration Interval
No
NOT USED
Timing
Yes
^^<Duration (s)>^<Start YYYYMMDDhhmmss>^<End YYYYMMDDhhmmss>
Example: ^^1800^20080722080000^20080722083000

Sample SCH Segment

SCH||123456|||||||||^^1800^20080722080000^20080722083000

NTE

Name Required? Comments
Type of Segment
Yes
NTE
Set ID
No <Order of This Note in the Series>
Example: 1

Comment Type
No
Example: Appointment Notes
Comment
Yes
Example: Scheduled for tilt table

Sample NTE Segments (all for a single SIU message)

NTE|1|Patient Appointment Notes|Follow-up from July 19 w/ Dr. Doe
NTE|2|Appointment Notes|Scheduled for tilt table

MSA

Name Required? Comments
Type of Segment
Yes
MSA
Acknowledgment Code
Yes <Error Status>
Example (for Acknowledged): AA
Example (for Error): AE
Example (for Rejected): AR
Control ID of Message Acknowledged
Yes
<Patient#>-<YYYYMMDDHHMMSS>
Example: 123-20080717120312
Text Message
No <Error Description>
Example: Could not find patient.

Sample MSA Segment - error

MSA|AE|123-20080717120312|Could not find patient.

Sample MSA Segment - acknowledged

MSA|AA|456-20080717140755