|
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. |
ADT Message Format
|
Segment |
Name |
Required? |
|
MSH |
Header |
Yes |
|
EVN |
Event Type |
Yes |
|
PID |
Patient ID |
Yes |
|
PV1 |
Patient Visit |
Yes |
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
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
|
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) |
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
|
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 |
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
MSH|^~\&|AnotherSoftwareSystem|EmpireMedicalAssociates|pMDsoft|123456|20080717120312||ACK|456-20080717140755|P|2.3|||NE|NE
MSA|AE|123-20080717120312|Could not find patient.
Segment Details
|
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 |
| 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 |
|
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 |
|
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. |
|
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. |
|
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> |
|
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 |
| 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 |
| 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. |