ADT Outbound from NMC

From NoMoreClipboard
Jump to: navigation, search
NoMoreClipboard.com Third Party Systems Interface Specification
NoMoreClipboard.com HL7 ADT OUTBOUND SPECIFICATION

The information in this document is subject to change.

TABLE OF CONTENTS
1. INTRODUCTION

The NMC HL7 outbound Interface sends HL7 messages to a receiving system. This interface can send messages real-time using TCP/IP protocol, or in a batch method, depending on the external system’s requirements.


2. ASSUMPTIONS

The following assumptions have been made concerning the implementation of the interface:

  1. It is assumed that the reader of this document is familiar with HL7. This document is not intended to standalone but should be used in conjunction with the HL7 Specification Version 2.3.
  2. This is an ADT and/or SIU Interface.
  3. The Interface utilizes the HL7 Standard Version 2.2 or 2.3.
  4. The HL7 interface can be processed real-time using TCP/IP protocol or in a batch method.
  5. The NoMoreClipboard.com system has translation capabilities if required.

3. INTERFACE OVERVIEW

In order to process the data successfully, the following items must be supplied/completed:

  1. External system(s) must furnish IP address(s) if real-time processing is used.
  2. Interface system parameters must be setup in order to direct the interface on how to format the data for the external system.
  3. Translation files (if the practice is using translations) must be setup that will convert Master File Values (Physician, Location, Insurance Company, Appointment Codes, Document Types and Observation Result Codes) into NMC system values.

How it Works


The following describes the process as it occurs:


  • If running in real-time via TCP/IP. A message is sent from NMCs HL7 outbound system to the receiving system’s Hl7 inbound Interface. The message is then processes accordingly and an acknowledgement of success or error is back to NMCs Hl7 outbound system.
  • If success then the sending system is free to send the next result.
  • If error, then the sending system should continue to send the messge until a successful acknowledgement has been sent back from the receving systems HL7 inbound Interface.

4. COMMUNICATION FLOW

A communications envelope will be used for all messages sent between NMCs system and the receiving system. The Minimal Lower Level Protocol (MLLP) is used by the TCP/IP connection, as specified by HL7 standard.

The envelope will 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.

For more information, refer to appendix C, section 1, of the HL7 Implementation Support Guide.

When the HL7 Interface process an inbound message, it sends back an acknowledgment indicating the message was received successfully (accept) or unsuccessfully (failure). A sending lab system should use this information to know when to send the next message or so it can automatically retry on a failure.


HL7 Standard Acknowledgments


These acknowledgments conform to the HL7 standard. The interface determines the acknowledgment mode to use based on the values sent in MSH.15 and MSH.16, sending back the acknowledgment in the manner requested by the message sender. For more information, refer to chapter two of the HL7 standard documentation.


5. HL7 ADT DATA MAPPING

The following is the HL7 Data Mapping for the ADT outbound Interface.


Only the fields and segments in this document are currently support by NMCs System. Please refer to your HL7 manual for HL7 requirements.


ADT^A01


MSH EVN PID PV1 [ PV2 ] [ { GT1 } ] [ { IN1 }]


ADT^A04


MSH EVN PID PV1 [ { GT1 } ] [ { IN1 } ]


ADT^A08


MSH EVN PID PV1 [ { GT1 } ] [{ IN1 }]


ADT^A40


MSH EVN { PID MRG [ PV1] }


MSH – Message Header
Field Name Len Type Description and Format Information
1
Field Separator
1
ST
|
2
Encoding Characters
4
ST
^~\&
3
Sending Application
15
ST
NMC
4
Sending Facility
20
ST
REQUIRED - Site specific
5
Receiving Application
30
ST
REQUIRED – Site Specific
6
Receiving Facility
30
ST
REQUIRED - Site specific
7
Date/Time of Message - System
26
TS
REQUIRED - YYYYMMDDHHMMSS
8
Security
40
ST
Site specific
9
Message Type
7
CM
ADT^A01 ADT^A04 ADT^A08 ADT^A40 Demographics
10
Message Control ID
14
ST
REQUIRED

Unique number from sending application

11
Processing ID
1
ID
P = Production, T = Test
12
Version ID
8
ID
2.3

A sample MSH Segment:


MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711162050||ADT^A04|DSD1184185250|P|2.5||||||


ENV – Event Type
Field Name Len Type Description and Format Information
1 Event Type 3 ID A01 A04 A08 A40
2 Date/Time 26 TS YYYYMMDDHHMMSS

A sample ENV Segment:


EVN|A01|200502122323490321


PID – Patient Identification
Field Name Len Type Description and Format Information
2 External Patient ID 20 CX Optional – depending on the receiving system
3 Internal Patient ID 20 CX REQUIRED – MR Number

This is the patients Medical Record Number.

5 Patient Name 48 XPN REQUIRED - Last^First^Middle

Patient Full Name

7 Date of Birth 26 TS REQUIRED – YYYYMMDD

Patients Date of Birth.

8 Sex 1 IS F – Female

M – Male

O – Other

U – Unknown

10 Race 5 CE This field refers to the patient’s race.
11 Patient Address 106 XAD


street1^street2^city^state^zip
13 Home Phone Number 40 XTN This field contains the patient’s personal phone numbers. All alpha characters are removed except commas (,).
14 Work Phone Number 40 XTN This field contains the patient’s personal phone numbers. All alpha characters are removed except commas (,).
16 Marital Status 5 CE A – Separated

D - Divorced

M - Married

S - Single

W – Widowed

19 Social Security Number 16 ST 999999999

A sample PID segment:


PID||56439|||DOE^JOHN^M||19701204|M|||4101 WEST JEFFERSON BLVD.^SUITE 3500^IN^81305-0000||(260)647-1459|890-8675X03245||00001|||3456345


PV1 – Patient Visit
Field Name Len Type Description and Format Information
7 Attending Doctor 60 XCN unique_id^Last^First^Middle


This field contains the attending physician information. The unique_id column is required and must be assigned to just one physician in the sending application.

8 Referring Doctor 60 XCN unique_id^Last^First^Middle


This field contains the referring physician information. The unique_id column is required and must be assigned to just one physician in the sending application.

9 Consulting Doctor 60 XCN unique_id^Last^First^Middle


This field contains the consulting physician information. The unique_id column is required and must be assigned to just one physician in the sending application.

A sample PV1 segment:


PV1|||||||00001^SMITH MD^BOB^D|00002^SHEPHERD, MD^STEVEN^E|0003^JACKSON MD^BOB|||||


GT1 – Guarantor
Field Name Len Type Description and Format Information
1 Set ID 4 SI Number for GT1 segment order
2 Guarantor Number 60 CX unique_id

This field contains the Guarantors unique identifier number

3 Guarantor Name 48 XPN Last^First^Middle



4 Guarantor spouse name 48 XPN Last^First^Middle
5 Guarantor Address 106 XAD street1^street2^city^state^zip



6 Guarantor Phone Number 40 XTN This field contains the guarantor’s personal phone numbers. All alpha characters are removed except commas (,).
7 Guarantor Business Phone number 40 XTN This field contains the guarantor’s business phone numbers. All alpha characters are removed except commas (,).
8 Guarantor Date of birth 26 TS YYYYMMDD

Guarantors Date of Birth.

9 Guarantor Sex 1 IS F – Female

M – Male

O – Other

U – Unknown

12 Guarantor SSN 16 ST 999999999
16 Guarantor Employer Name 130 XPN Guarantors Employer
17 Guarantor Employer Address 106 XAD street1^street2^city^state^zip
19 Guarantor Employer ID number 20 CX Employer Identification number
20 Guarantor employement status 2 IS Guarantor employment status
24 Guarantor Death Date 26 TS YYYYMMDDhhmmss



25 Guarantor Death Flag 1 ID Death indicator – Guarantor is deceased
30 Guarantor Marital status code 80 CE Guarantor marital status
44 Guarantor Ethnic group 80 CE Guarantor Ethnic Group

A sample GT1 segment:


GT1|1|234342|oil^olive^a|Popeye|123 street st.^^Fort Wayne^IN^46808|(260) 426-5555||20060328133300|F|||111111234|||||||||||||0|||||M|||||||||||||||||||||||||


IN1 – Patient Identification
Field Name Len Type Description and Format Information
1 Set ID 4 SI Set Id
2 Insurance Plan Id 60 CE REQUIRED – Insurance Plan ID
3 Insurance Company ID 59 CX REQUIRED – Insurance Company ID
4 Insurance Company Name 130 XON REQUIRED – Insurance Company Name
5 Insurance Company Address 106 XAD street1^street2^city^state^zip
7 Insurance Company Phone number 40 XTN This field contains the insurance company phone numbers. All alpha characters are removed except commas (,).
8 Group Number 12 ST


Group number
11 Insured’s Group Employers Name 130 XON Employer Name
12 Plan Effective Date 8 DT YYYYMMDD
13 Plan Expiration Date 8 DT YYYYMMDD
15 Plan Type 3 IS Plan type
16 Name of Insured 48 XPN Last^First^Middle



17 Insured’s Relationship To Patient


80 CE Insured’s Relationship To Patient



18 Insured’s Date of Birth 26 TS Insured’s Date of Birth
19 Insured’s Address


106 XAD street1^street2^city^state^zip
36 Policy Number


15 ST REQUIRED - Policy Number



A sample IN1 segment:


IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||


MRG – Merge patient information
Field Name Len Type Description and Format Information
1 Prior Patient Identifier List 20 CX REQUIRED – MR Number

This is the patients Medical Record Number

4 Prior Patient ID 20 CX Patient id

A sample MRG segment:

MRG|10284^^^ADT1^MR|||520988|||


ADT SAMPLE MESSAGES:


MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711162050||ADT^A04|DSD1184185250|P|2.5||||||

EVN||20070711162050||

PID|1||10284^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||Testpatient1^Adt||20070711000000|M|||123 somwhere st.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||||||||||||||||||||||||||||||||||||||||||||||||||||

IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711162147||ADT^A01|DSD1184185307|P|2.5||||||

EVN||20070711162147||

PID|1||10284^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||Testpatient1^Adt||20070711000000|M|||123 somwhere st.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||OFFICE|||||||||||^^^^NMC^^^^^NoMoreClipboard.com||||2^Horner^Douglas^R^^MD||987654321|||||||||||||||0|||||||0|||20070711000000||||||144^^^^^1.2.840.114398.1.57||

PV2|||||||||||||||||||||||||||||||||||||

IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711162452||ADT^A08|DSD1184185492|P|2.5||||||

EVN||20070711162452||

PID|1||10284^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||Testpatient1^Adt||20070711000000|M|||123 somwhere st.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||||||||||||||||||||||||||||||||||||||||||||||||||||

IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711162521||ADT^A08|DSD1184185521|P|2.5||||||

EVN||20070711162521||

PID|1||10284^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||Testpatient1^Adt||20070711000000|M|||123 somwhere st.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||||||||||||||||||||||||||||||||||||||||||||||||||||

GT1|1|234342|oil^olive^a|Joe Rice|123 street st.^^Fort Wayne^IN^46808|(260) 426-5555||20060328133300|F|||111111234|||||||||||||0|||||M|||||||||||||||||||||||||

IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711163058||ADT^A04|DSD1184185858|P|2.5||||||

EVN||20070711163058||

PID|1||10285^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||testpatient2^Adt||20070711000000|M|||12 riverfront dr.^^Fort Wayne^IN^46805||^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||||||||||||||||||||||||||||||||||||||||||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711163209||ADT^A08|DSD1184185929|P|2.5||||||

EVN||20070711163209||

PID|1||10285^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||testpatient2^Adt||20070711000000|M|||12 riverfront dr.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

PV1||||||||||||||||||||||||||||||||||||||||||||||||||||

GT1|1|234342|oil^olive^a|Joe Rice|123 street st.^^Fort Wayne^IN^46808|(260) 426-5555||20060328133300|F|||111111234|||||||||||||0|||||M|||||||||||||||||||||||||

IN1|1|2903|AHP|ANTHEM/BC BLUE PREF (HMO)-AHP||||123456789||||20070711000000|20090811000000||ANTHEM/BC BLUE PREF (HMO)-AHP|Adt TestPatient1|Self|||||||||||||||||||987654321|||||||||||||

MSH|^~\&|NMC|SENDING_FAC|RECEIVING_APP|RECEIVEING_FAC|20070711163209||ADT^A40|DSD1184185929|P|2.5||||||

EVN||20070711163209||

PID|1||10285^^^^MR^1.3.6.1.4.1.21367.2005.1.1&&ISO~123456789^^^^SS||testpatient2^Adt||20070711000000|M|||12 riverfront dr.^^Fort Wayne^IN^46805||2604596270^PRN^PH|^WPN^PH|||||123456789|||||||||||

MRG|10284^^^ADT1^MR|||520988|||