Adt Specification and Sample Messages

athenahealth HL7 Native Data Structure
Thank you for reviewing the athenahealth native HL7 data structure. This document identifies the data
athenahealth capture by default and the fields/components in which they are expected (inbound
messages to athena) and sent (outbound messages from athena). On the 'Outbound Patients',
'Outbound Appointments', and 'Inbound Charges' tabs, note that the first component of a field is
denoted with a null value in the 'Component' column, and a row with "1" in the 'Component' column
would actually be the second component of that field.
Example: PID.10 is for Patient Race and is identified as PID10.0 = Race ID, PID10.1 = Race ID Name.
PID||||||||||RACEID^RACEIDNAME|
Version: 16.7
Last Updated: 7/25/2016
Table of Contents
Outbound Patients Provides the layout of the HL7 message type(s) that athena uses
by default to send New Patient and Patient Update messages.
Inbound Patients Provides the layout of the HL7 message type(s) that athena
expects by default to receive New Patient and Patient Update
messages.
Inbound Admit & Discharge Provides the layout of the HL7 message type(s) that athena
expects by default to process Admit and Discharge events into
athenaNet.
Sample Messages Provides sample ADT messages.

Minimum Requirements - Inbound Lists the minimum required elements in order to create a
Patient, Appointment, Charge, and Insurance in athena from an
HL7 message. Please see Interface Scoping Questionnaires (ISQ)
for more information.
Message Layout by Category For each of the message categories that athena supports, this
tab provides a quick reference segment breakdown - required
segments, optional segments, repeatable segments, and the
expected ordering of the segments.
Document Change Log Document version history.

Table of Contents
MSG Category Direction MSG TYPE Segment = Field (0.0) Field
ADT OUT A04,A08,A28,A31 MSH 1
ADT OUT A04,A08,A28,A31 EVN 1
ADT OUT A04,A08,A28,A31 PID 1
ADT OUT A04,A08,A28,A31 PD1 1
ADT OUT A04,A08,A28,A31 NK1 1
ADT OUT A04,A08,A28,A31 PV1 1
ADT OUT A04,A08,A28,A31 DB1 1
ADT OUT A04,A08,A28,A31 ROL 1
ADT OUT A04,A08,A28,A31 GT1 1
ADT OUT A04,A08,A28,A31 IN1 1
ADT OUT A04,A08,A28,A31 ACC 1
In the MSH
values of ^~\&.
segment
These areonly, the the
pipe
component '|'
delimiter
that immediately
separator,
follows
repitition the 'MSH'
segment
separator,headerescapeis
considered the
Component athena Field character,
first Notes
field
and
of the Sent by Default
subcomponent
0 Field Separator segment.
separator, Yes
0 Encoding CharacterThis is the
respectively.
athena sends Yes
practice's
to 40 unique
0 Sending ApplicationUp'ATHENANET'.
identifier Yes
characterswithin will be
0 Context ID athena.
sent in this Yes
1 Practice's Name component. Yes
2 Provider Group's ID Yes
3 Provider Group's Name Yes
0 Interface Name This is the Yes
In formatcontrol
message
0 Trading Partner Name YYYYMMDDHH24 Yes
number generated Yes
0 Date/Time of Mess MM.by athenaNet and
0 SUBSCRIPTION.MESSAGETYPEGROUP
should be Yes
0 Message Category acknowledged by Yes
the
The receiving
default value
1 Message Type application if HL7 Yes
is 'T' but athena
0 Message ID ACKs are enabled.
can also send 'P' Yes
0 Processing ID or 'D'. Yes
0 HL7 Version Yes
0 ** NOT SPECIFIED **
0 ** NOT SPECIFIED ** This is a numeric
0 ** NOT SPECIFIED ** identifier. For
This is a numeric
clients with
identifier. For
0 ** NOT SPECIFIED ** multiple Provider
clients with
0 ** NOT SPECIFIED ** Groups in athena,
multiple Provider
0 ** NOT SPECIFIED ** the patient's
Groups in athena,
Enterprise
the patient's ID is
0 ** NOT SPECIFIED ** common
Enterprisefor IDtheis
0 ** NOT SPECIFIED ** entire
common tablespace,
for the
In format
across all Provider
0 Message Type entire tablespace,
YYYYMMDDHH12 Yes
Groups. allIfProvider
there is
0 Trigger Event Time across
MM.
only oneIfProvider Yes
Groups. there is
0 ** NOT SPECIFIED ** athenaNet
Group
only one in the
Provider
username
tablespace of
thenthe
0 Event Reason Code Group
user
patients
in the
that triggered
tablespace thennot
would
Yes
0 Created by: Usern have
the message.
patientsEnterprise
would not
The
IDs patient's
and this field
0 ** NOT SPECIFIED ** have Enterprise
athenaNet ID is
would
IDs andjustthis contain
field
0 Set ID - PID specific
the athenato apatient
would just contain
Provider Group for
0 Patient's athenaNetID.
the athena Yes
clients withpatient
0 Patient's athenaNetID.
multiple Provider Yes
0 Patient's athenaNetGroups. Yes
0 Patient's Last Name Yes
1 Patient's First Name Yes
2 Patient's Middle Name Yes
3 Patient's Name Suffix Yes
0 ** NOT SPECIFIED ** In format
Please refer to
0 Patient's Date of Bi YYYYMMDD.
athenaNet
athena sends Global Yes
0 Patient's Sex Tables
either 'F'document.
or 'M'. Yes
Athena sends
0 Patient's Preferred Name
CDC_UNIQUEIDEN Yes
0 Patient's Race ID TIFIER by default. Yes
Please refer to
athenaNet Global
1 Patient's Race Nam Tables document. Yes
0 Patient's Street Address Yes
1 Patient's Street Address (ctd) Yes
2 Patient's Address City Yes
3 Patient's Address State Yes
4 Patient's Address Zip Yes
5 Patient's Address Country Name Yes
0 Patient's Phone Number - HOME Yes
1 Patient's Phone Number Yes
Please- WORK
refer to
2 Patient Email AddressathenaNet Global Yes
3 Tables- document.
Patient's Phone Number MOBILE Yes
A=Separated,
Athena sends
0 Patient's Phone Number - WORK by
D=Divorced,
ISO6392CODE Yes
Please refer to
M=Married,
0 Patient's Primary default.
athenaNet Yes
S=Single, Global
1 Patient's Primary Tables document.
W=Widowed, Yes
0 Patient's Marital StaU=Unknown Yes
0 Religion Name Patient SSN; 9
digits, no dashes,
0 ** NOT SPECIFIED ** in #########
0 Patient's SSN format Yes
0 PATIENT.EMPLOYERNAME Yes
0 Patient's Ethnic Group ID Yes
1 Patient's Ethnic Group Name Yes
0 Former Last Name
0 Patient's Death Date Yes
0 Patient Death Indicator
0 PCP's ID Yes
1 PCP's Last Name Yes
2 PCP's First Name Yes
3 PCP's Middle Initial Yes
0 Organ Donor Yes
0 Set ID - NK1 Yes
0 Contact Name Yes
0 Relationship to Patient Yes
0 Contact Phone Number - HOME Yes
1 Contact Phone Number - MOBILE
C = Emergency
0 Contact Phone Number - WORK
Contact; N = Next Yes
0 Contact Role/Type of Kin Yes
0 Set ID - PV1 Yes
0 Patient's Primary Department ID Yes
1 Patient's Primary Department Name Yes
3 Patient's Primary Department Name Yes
0 Primary Provider's NPI Number (else Pr Yes
1 Primary Provider's Last name Yes
2 Primary Provider's First Name Yes
3 Primary Provider's Middle Initial Yes
0 Referring Provider's NPI Number (else P Yes
1 Referring Provider's Last name Yes
2 Referring Provider's First Name Yes
3 Referring Provider's Middle Initial Yes
0 PCP's NPI # (else Provider ID)
1 PCP's Last Name
2 PCP's First Name
3 PCP's Middle Initial
0 Usual Provider's NPI Number (else athe Yes
1 Usual Provider's Last Name Yes
2 Usual Provider's First Name Yes
0 Appointment ID
0 ** NOT SPECIFIED ** Segment Count
0 Set ID - GT1 Identifier Yes
0 Guarantor's Last Name Yes
1 Guarantor's First Name Yes
2 Guarantor's Middle Name Yes
3 Guarantor's Name Suffix Yes
0 Guarantor's Address 1 Yes
1 Guarantor's Address 2 Yes
2 Guarantor's Address City Yes
3 Guarantor's Address State Yes
4 Guarantor's Address Zip Yes
5 Guarantor's Address Country Name Yes
0 Guarantor's Phone Number Yes
1 Guarantor's Email Address Yes
0 Guarantor's Date of Birth Yes
0 Patient's Relationship to Guarantor Yes
0 Guarantor's Employer Name Yes
0 Guarantor's Employer Street Address 1 Yes
1 Guarantor's Employer Street Address 2
2 Guarantor's Employer Address City Yes
3 Guarantor's Employer Address State Yes
4 Guarantor's Employer Address Zip Cod Yes
0 Guarantor's Employer Phone Number Yes
0 ** NOT SPECIFIED ** <family
name>^<given
0 ** NOT SPECIFIED ** name>^<middle
0 Patient's Emergenc initial or name> Yes
contact phone, in
1 PATIENT.CONTACTNAME (xxx)yyy-zzzz Yes
0 Patient's Emergen format Yes
0 Emergency Contact's Relationship to Pa Yes
<athenaNet’s
0 ** NOT SPECIFIED ** 1 - for primary
<athenaNet’s
globally assigned
insurance, 2 for
globally assigned
insurancepackagei
0 ** NOT SPECIFIED ** secondary,
d for this if
insurancepackagei
Yes
0 Set ID - IN1 present
d for this
insurance>^<athe
0 Insurance Package naNet’s
insurance> insurance
<athenaNet’s Yes
1 name>
Insurance Package insurance Max length
name> Yes
Usually, same
for insurance as
0 Insurance ReportingIN1.2
package name is Yes
1 Insurance Company100 characters.
athenaNet's Yes
0 Insurance Compan insurance name Yes
0 Insurance Company Address 1 Yes
1 Insurance Company Address 2 Yes
2 Insurance Company<insurance
Address City Yes
3 contact
Insurance Company Address State Yes
lastname>^<insur
4 Insurance CompanyanceAddress Zip
contact Yes
0 insurance
Mapped tomain
Insurance Companyfirstname> Yes
contact phone, in
PATIENTINSURANC
1 PATIENTINSURANCELIST[i].INSURAN
(xxx)yyy-zzzz Yes
E.POLICYNUMBER.
0 Insurance Compan format
The group Yes
0 Insurance Group N ID/number. Yes
0 Insurance Group NameMapped
Mapped to to
PATIENTINSURANC
PATIENTINSURANC
0 Insured's Group Employee
Mapped IDto
E.EMPLOYERNAM
E.ISSUEDATE,
PATIENTINSURANC in
0 Insured's Group E EYYYYMMDD Yes
E.EXPIRATIONDAT
0 Plan Effective Date format.
E, in YYYYMMDD Yes
0 Plan Expiration Dat format. Yes
0 PATIENTINSURANCELIST[i].REFERRAL Yes
0 Plan Type Policy Holder Yes
Mapped to Yes
0 Insured's Last Nam information
Policy Holder
PATIENTINSURANC
1 Insured's First Nam information
E.INSUREDDOB,
Policy Holder in Yes
Mapped to
2 Insured's Middle N YYYYMMDD
information
PATIENTINSURANC
SELF, SPOUSE, Yes
format.; "Policy
0 Insured’s RelationshE.SEQUENCENUM
CHILD,
Holder"or OTHER Yes
0 Insured's Date of BiBER (also
Information Yes
determines
0 Insured's Street Address
whether1 this Yes
1 patientinsurance
Insured's Street Address 2 Yes
2 record
Insured's Address City is Yes
PRIMARYPATIENTI
3 Insured's Address State
NSURANCEID or Yes
4 SECONDARYPATIE
Insured's Address Zip Code Yes
NTINSURANCEID Yes
5 Insured's Address Country Code IDIf
on the claim).
6 Insured's SSN null, indicates a Yes
0 ** NOT SPECIFIED ** case-policy
insurance.
0 ** NOT SPECIFIED ** Example, "1" or
0 Coordination of Bene"2." Yes
0 Report of Eligibility Flag Yes
0 Report of Eligibility Date Yes
0 ** NOT SPECIFIED ** Mapped to
0 ** NOT SPECIFIED ** PATIENTINSURANC
0 ** NOT SPECIFIED ** E.INSUREDIDNUM
BER; The
0 ** NOT SPECIFIED ** insurance
0 Insurance Policy N ID/number. Yes
0 ** NOT SPECIFIED ** Mapped to
0 ** NOT SPECIFIED ** PATIENTINSURANC
E.INSUREDSEX.
0 ** NOT SPECIFIED ** F,M,O [other], U
0 Insured's Sex [unknown] Yes
0 Accident Date/Time Yes
0 VISITCASE.RELATEDTOEMPLOYMENTYN Yes
Table of Contents
MSG Category Direction MSG TYPE Segment = Field (0.0) Field Component
ADT IN A04,A08,A28,A31 MSH 1 0
ADT IN A04,A08,A28,A31 MSH 10 0
ADT IN A04,A08,A28,A31 MSH 11 0
ADT IN A04,A08,A28,A31 MSH 12 0
ADT IN A04,A08,A28,A31 MSH 13 0
ADT IN A04,A08,A28,A31 MSH 14 0
ADT IN A04,A08,A28,A31 MSH 15 0
ADT IN A04,A08,A28,A31 MSH 16 0
ADT IN A04,A08,A28,A31 MSH 17 0
ADT IN A04,A08,A28,A31 MSH 18 0
ADT IN A04,A08,A28,A31 MSH 19 0
ADT IN A04,A08,A28,A31 MSH 20 0
ADT IN A04,A08,A28,A31 EVN 1 0
ADT IN A04,A08,A28,A31 PID 1 0
ADT IN A04,A08,A28,A31 PID 10 0
ADT IN A04,A08,A28,A31 PID 10 1
ADT IN A04,A08,A28,A31 PID 11 0
ADT IN A04,A08,A28,A31 PID 11 1
ADT IN A04,A08,A28,A31 PID 11 2
ADT IN A04,A08,A28,A31 PID 11 3
ADT IN A04,A08,A28,A31 PID 11 4
ADT IN A04,A08,A28,A31 PID 11 5
ADT IN A04,A08,A28,A31 PID 12 0
ADT IN A04,A08,A28,A31 PID 13 0
ADT IN A04,A08,A28,A31 PID 13 1
ADT IN A04,A08,A28,A31 PID 13 2
ADT IN A04,A08,A28,A31 PID 14 0
ADT IN A04,A08,A28,A31 PID 15 0
ADT IN A04,A08,A28,A31 PID 15 1
ADT IN A04,A08,A28,A31 PID 16 0
ADT IN A04,A08,A28,A31 PID 16 1
ADT IN A04,A08,A28,A31 PID 17 0
ADT IN A04,A08,A28,A31 PID 18 0
ADT IN A04,A08,A28,A31 PID 19 0
ADT IN A04,A08,A28,A31 PID 20 0
ADT IN A04,A08,A28,A31 PID 21 0
ADT IN A04,A08,A28,A31 PID 22 0
ADT IN A04,A08,A28,A31 PID 22 1
ADT IN A04,A08,A28,A31 PV1 1 0
ADT IN A04,A08,A28,A31 PV1 2 0
ADT IN A04,A08,A28,A31 PV1 3 3
ADT IN A04,A08,A28,A31 PV1 4 0
ADT IN A04,A08,A28,A31 PV1 5 0
ADT IN A04,A08,A28,A31 PV1 6 0
ADT IN A04,A08,A28,A31 PV1 7 0
ADT IN A04,A08,A28,A31 PV1 7 1
ADT IN A04,A08,A28,A31 PV1 7 2
ADT IN A04,A08,A28,A31 PV1 7 3
ADT IN A04,A08,A28,A31 PV1 8 0
ADT IN A04,A08,A28,A31 PV1 8 1
ADT IN A04,A08,A28,A31 PV1 8 2
ADT IN A04,A08,A28,A31 PV1 8 3
ADT IN A04,A08,A28,A31 PV1 9 0
ADT IN A04,A08,A28,A31 PV1 10 0
ADT IN A04,A08,A28,A31 PV1 11 0
ADT IN A04,A08,A28,A31 PV1 12 0
ADT IN A04,A08,A28,A31 PV1 13 0
ADT IN A04,A08,A28,A31 PV1 14 0
ADT IN A04,A08,A28,A31 PV1 15 0
ADT IN A04,A08,A28,A31 PV1 16 0
ADT IN A04,A08,A28,A31 PV1 17 0
ADT IN A04,A08,A28,A31 PV1 18 0
ADT IN A04,A08,A28,A31 PV1 19 0
ADT IN A04,A08,A28,A31 PV1 20 0
ADT IN A04,A08,A28,A31 PV1 21 0
ADT IN A04,A08,A28,A31 PV1 22 0
ADT IN A04,A08,A28,A31 PV1 23 0
ADT IN A04,A08,A28,A31 PV1 24 0
ADT IN A04,A08,A28,A31 PV1 25 0
ADT IN A04,A08,A28,A31 PV1 26 0
ADT IN A04,A08,A28,A31 PV1 27 0
ADT IN A04,A08,A28,A31 PV1 28 0
ADT IN A04,A08,A28,A31 PV1 29 0
ADT IN A04,A08,A28,A31 PV1 30 0
ADT IN A04,A08,A28,A31 PV1 31 0
ADT IN A04,A08,A28,A31 PV1 32 0
ADT IN A04,A08,A28,A31 PV1 33 0
ADT IN A04,A08,A28,A31 PV1 34 0
ADT IN A04,A08,A28,A31 PV1 35 0
ADT IN A04,A08,A28,A31 PV1 36 0
ADT IN A04,A08,A28,A31 PV1 37 0
ADT IN A04,A08,A28,A31 PV1 38 0
ADT IN A04,A08,A28,A31 PV1 39 0
ADT IN A04,A08,A28,A31 PV1 40 0
ADT IN A04,A08,A28,A31 PV1 44 0
ADT IN A04,A08,A28,A31 PV2 1 0
ADT IN A04,A08,A28,A31 PV2 2 0
ADT IN A04,A08,A28,A31 PV2 3 0
ADT IN A04,A08,A28,A31 PV2 4 0
ADT IN A04,A08,A28,A31 PV2 5 0
ADT IN A04,A08,A28,A31 PV2 6 0
ADT IN A04,A08,A28,A31 PV2 7 0
ADT IN A04,A08,A28,A31 PV2 8 0
ADT IN A04,A08,A28,A31 PV2 9 0
ADT IN A04,A08,A28,A31 PV2 10 0
ADT IN A04,A08,A28,A31 PV2 11 0
ADT IN A04,A08,A28,A31 PV2 12 0
ADT IN A04,A08,A28,A31 PV2 13 0
ADT IN A04,A08,A28,A31 PV2 14 0
ADT IN A04,A08,A28,A31 PV2 15 0
ADT IN A04,A08,A28,A31 PV2 16 0
ADT IN A04,A08,A28,A31 PV2 17 0
ADT IN A04,A08,A28,A31 PV2 18 0
ADT IN A04,A08,A28,A31 PV2 19 0
ADT IN A04,A08,A28,A31 PV2 20 0
ADT IN A04,A08,A28,A31 PV2 21 0
ADT IN A04,A08,A28,A31 PV2 22 0
ADT IN A04,A08,A28,A31 PV2 23 0
ADT IN A04,A08,A28,A31 PV2 24 0
ADT IN A04,A08,A28,A31 PV2 25 0
ADT IN A04,A08,A28,A31 PV2 26 0
ADT IN A04,A08,A28,A31 PV2 27 0
ADT IN A04,A08,A28,A31 PV2 28 0
ADT IN A04,A08,A28,A31 PV2 29 0
ADT IN A04,A08,A28,A31 PV2 30 0
ADT IN A04,A08,A28,A31 GT1 1 0
ADT IN A04,A08,A28,A31 GT1 2 0
ADT IN A04,A08,A28,A31 GT1 3 0
ADT IN A04,A08,A28,A31 GT1 3 1
ADT IN A04,A08,A28,A31 GT1 3 2
ADT IN A04,A08,A28,A31 GT1 3 3
ADT IN A04,A08,A28,A31 GT1 4 0
ADT IN A04,A08,A28,A31 GT1 5 0
ADT IN A04,A08,A28,A31 GT1 5 1
ADT IN A04,A08,A28,A31 GT1 5 2
ADT IN A04,A08,A28,A31 GT1 5 3
ADT IN A04,A08,A28,A31 GT1 5 4
ADT IN A04,A08,A28,A31 GT1 5 5
ADT IN A04,A08,A28,A31 GT1 6 0
ADT IN A04,A08,A28,A31 GT1 7 0
ADT IN A04,A08,A28,A31 GT1 8 0
ADT IN A04,A08,A28,A31 GT1 9 0
ADT IN A04,A08,A28,A31 GT1 10 0
ADT IN A04,A08,A28,A31 GT1 11 0
ADT IN A04,A08,A28,A31 GT1 12 0
ADT IN A04,A08,A28,A31 GT1 13 0
ADT IN A04,A08,A28,A31 GT1 13 0
ADT IN A04,A08,A28,A31 GT1 13 0
ADT IN A04,A08,A28,A31 GT1 14 0
ADT IN A04,A08,A28,A31 GT1 15 0
ADT IN A04,A08,A28,A31 GT1 16 0
ADT IN A04,A08,A28,A31 GT1 16 1
ADT IN A04,A08,A28,A31 GT1 17 0
ADT IN A04,A08,A28,A31 GT1 18 0
ADT IN A04,A08,A28,A31 GT1 19 0
ADT IN A04,A08,A28,A31 GT1 20 0
ADT IN A04,A08,A28,A31 GT1 21 0
ADT IN A04,A08,A28,A31 GT1 22 0
ADT IN A04,A08,A28,A31 GT1 23 0
ADT IN A04,A08,A28,A31 GT1 24 0
ADT IN A04,A08,A28,A31 GT1 25 0
ADT IN A04,A08,A28,A31 GT1 26 0
ADT IN A04,A08,A28,A31 GT1 27 0
ADT IN A04,A08,A28,A31 GT1 28 0
ADT IN A04,A08,A28,A31 GT1 29 0
ADT IN A04,A08,A28,A31 GT1 30 0
ADT IN A04,A08,A28,A31 GT1 31 0
ADT IN A04,A08,A28,A31 GT1 32 0
ADT IN A04,A08,A28,A31 GT1 33 0
ADT IN A04,A08,A28,A31 GT1 34 0
ADT IN A04,A08,A28,A31 GT1 35 0
ADT IN A04,A08,A28,A31 GT1 36 0
ADT IN A04,A08,A28,A31 GT1 37 0
ADT IN A04,A08,A28,A31 GT1 38 0
ADT IN A04,A08,A28,A31 GT1 39 0
ADT IN A04,A08,A28,A31 GT1 40 0
ADT IN A04,A08,A28,A31 GT1 41 0
ADT IN A04,A08,A28,A31 GT1 42 0
ADT IN A04,A08,A28,A31 GT1 43 0
ADT IN A04,A08,A28,A31 GT1 44 0
ADT IN A04,A08,A28,A31 GT1 45 0
ADT IN A04,A08,A28,A31 GT1 45 1
ADT IN A04,A08,A28,A31 GT1 46 0
ADT IN A04,A08,A28,A31 GT1 47 0
ADT IN A04,A08,A28,A31 GT1 48 0
ADT IN A04,A08,A28,A31 GT1 49 0
ADT IN A04,A08,A28,A31 IN1 1 0
ADT IN A04,A08,A28,A31 IN1 2 0
ADT IN A04,A08,A28,A31 IN1 3 0
ADT IN A04,A08,A28,A31 IN1 4 0
ADT IN A04,A08,A28,A31 IN1 5 0
ADT IN A04,A08,A28,A31 IN1 5 1
ADT IN A04,A08,A28,A31 IN1 5 2
ADT IN A04,A08,A28,A31 IN1 5 3
ADT IN A04,A08,A28,A31 IN1 5 4
ADT IN A04,A08,A28,A31 IN1 6 0
ADT IN A04,A08,A28,A31 IN1 7 0
ADT IN A04,A08,A28,A31 IN1 8 0
ADT IN A04,A08,A28,A31 IN1 9 0
ADT IN A04,A08,A28,A31 IN1 10 0
ADT IN A04,A08,A28,A31 IN1 11 0
ADT IN A04,A08,A28,A31 IN1 12 0
ADT IN A04,A08,A28,A31 IN1 13 0
ADT IN A04,A08,A28,A31 IN1 14 0
ADT IN A04,A08,A28,A31 IN1 15 0
ADT IN A04,A08,A28,A31 IN1 16 0
ADT IN A04,A08,A28,A31 IN1 16 1
ADT IN A04,A08,A28,A31 IN1 16 2
ADT IN A04,A08,A28,A31 IN1 17 0
ADT IN A04,A08,A28,A31 IN1 17 1
ADT IN A04,A08,A28,A31 IN1 18 0
ADT IN A04,A08,A28,A31 IN1 19 0
ADT IN A04,A08,A28,A31 IN1 19 1
ADT IN A04,A08,A28,A31 IN1 19 2
ADT IN A04,A08,A28,A31 IN1 19 3
ADT IN A04,A08,A28,A31 IN1 19 4
ADT IN A04,A08,A28,A31 IN1 20 0
ADT IN A04,A08,A28,A31 IN1 21 0
ADT IN A04,A08,A28,A31 IN1 22 0
ADT IN A04,A08,A28,A31 IN1 23 0
ADT IN A04,A08,A28,A31 IN1 24 0
ADT IN A04,A08,A28,A31 IN1 25 0
ADT IN A04,A08,A28,A31 IN1 26 0
ADT IN A04,A08,A28,A31 IN1 27 0
ADT IN A04,A08,A28,A31 IN1 28 0
ADT IN A04,A08,A28,A31 IN1 29 0
ADT IN A04,A08,A28,A31 IN1 30 0
ADT IN A04,A08,A28,A31 IN1 31 0
ADT IN A04,A08,A28,A31 IN1 32 0
ADT IN A04,A08,A28,A31 IN1 33 0
ADT IN A04,A08,A28,A31 IN1 34 0
ADT IN A04,A08,A28,A31 IN1 35 0
ADT IN A04,A08,A28,A31 IN1 36 0
ADT IN A04,A08,A28,A31 IN1 37 0
ADT IN A04,A08,A28,A31 IN1 38 0
ADT IN A04,A08,A28,A31 IN1 39 0
ADT IN A04,A08,A28,A31 IN1 40 0
ADT IN A04,A08,A28,A31 IN1 41 0
ADT IN A04,A08,A28,A31 IN1 42 0
ADT IN A04,A08,A28,A31 IN1 43 0
ADT IN A04,A08,A28,A31 IN2 1 0
ADT IN A04,A08,A28,A31 IN2 2 0
ADT IN A04,A08,A28,A31 IN2 3 0
ADT IN A04,A08,A28,A31 IN2 4 0
ADT IN A04,A08,A28,A31 IN2 5 0
ADT IN A04,A08,A28,A31 IN2 6 0
ADT IN A04,A08,A28,A31 IN2 7 0
ADT IN A04,A08,A28,A31 IN2 8 0
ADT IN A04,A08,A28,A31 IN2 9 0
ADT IN A04,A08,A28,A31 IN2 10 0
ADT IN A04,A08,A28,A31 IN2 11 0
ADT IN A04,A08,A28,A31 IN2 12 0
ADT IN A04,A08,A28,A31 IN2 13 0
ADT IN A04,A08,A28,A31 IN2 14 0
ADT IN A04,A08,A28,A31 IN2 15 0
ADT IN A04,A08,A28,A31 IN2 16 0
ADT IN A04,A08,A28,A31 IN2 17 0
ADT IN A04,A08,A28,A31 IN2 18 0
ADT IN A04,A08,A28,A31 IN2 19 0
ADT IN A04,A08,A28,A31 IN2 20 0
ADT IN A04,A08,A28,A31 IN2 21 0
ADT IN A04,A08,A28,A31 IN2 22 0
ADT IN A04,A08,A28,A31 IN2 23 0
ADT IN A04,A08,A28,A31 IN2 24 0
ADT IN A04,A08,A28,A31 IN2 25 0
ADT IN A04,A08,A28,A31 IN2 26 0
ADT IN A04,A08,A28,A31 IN2 27 0
ADT IN A04,A08,A28,A31 IN2 28 0
ADT IN A04,A08,A28,A31 IN2 29 0
ADT IN A04,A08,A28,A31 IN2 30 0
ADT IN A04,A08,A28,A31 IN2 31 0
ADT IN A04,A08,A28,A31 IN2 32 0
ADT IN A04,A08,A28,A31 IN2 33 0
ADT IN A04,A08,A28,A31 IN2 34 0
ADT IN A04,A08,A28,A31 IN2 35 0
ADT IN A04,A08,A28,A31 IN2 36 0
ADT IN A04,A08,A28,A31 IN2 37 0
ADT IN A04,A08,A28,A31 IN2 38 0
ADT IN A04,A08,A28,A31 IN2 39 0
ADT IN A04,A08,A28,A31 IN2 40 0
ADT IN A04,A08,A28,A31 IN2 41 0
ADT IN A04,A08,A28,A31 IN2 42 0
ADT IN A04,A08,A28,A31 IN2 43 0
ADT IN A04,A08,A28,A31 IN2 44 0
ADT IN A04,A08,A28,A31 IN2 45 0
ADT IN A04,A08,A28,A31 IN2 46 0
ADT IN A04,A08,A28,A31 IN2 47 0
ADT IN A04,A08,A28,A31 IN2 48 0
ADT IN A04,A08,A28,A31 IN2 49 0
ADT IN A04,A08,A28,A31 IN2 50 0
ADT IN A04,A08,A28,A31 IN2 51 0
ADT IN A04,A08,A28,A31 IN2 52 0
ADT IN A04,A08,A28,A31 IN2 53 0
ADT IN A04,A08,A28,A31 IN2 54 0
ADT IN A04,A08,A28,A31 IN2 55 0
ADT IN A04,A08,A28,A31 IN2 56 0
ADT IN A04,A08,A28,A31 IN2 57 0
ADT IN A04,A08,A28,A31 IN2 58 0
ADT IN A04,A08,A28,A31 IN2 59 0
ADT IN A04,A08,A28,A31 IN2 60 0
ADT IN A04,A08,A28,A31 IN2 61 0
ADT IN A04,A08,A28,A31 IN2 62 0
ADT IN A04,A08,A28,A31 IN2 63 0
ADT IN A04,A08,A28,A31 IN2 64 0
ADT IN A04,A08,A28,A31 IN2 65 0
ADT IN A04,A08,A28,A31 IN2 66 0
ADT IN A04,A08,A28,A31 IN2 67 0
ADT IN A04,A08,A28,A31 IN2 68 0
ADT IN A04,A08,A28,A31 IN2 69 0
ADT IN A04,A08,A28,A31 IN2 70 0
ADT IN A04,A08,A28,A31 IN2 71 0
ADT IN A04,A08,A28,A31 IN2 72 0
ADT IN A04,A08,A28,A31 IN3 1 0
ADT IN A04,A08,A28,A31 IN3 2 0
ADT IN A04,A08,A28,A31 IN3 3 0
ADT IN A04,A08,A28,A31 IN3 4 0
ADT IN A04,A08,A28,A31 IN3 5 0
ADT IN A04,A08,A28,A31 IN3 6 0
ADT IN A04,A08,A28,A31 IN3 7 0
ADT IN A04,A08,A28,A31 IN3 8 0
ADT IN A04,A08,A28,A31 IN3 9 0
ADT IN A04,A08,A28,A31 IN3 10 0
ADT IN A04,A08,A28,A31 IN3 11 0
ADT IN A04,A08,A28,A31 IN3 12 0
ADT IN A04,A08,A28,A31 IN3 13 0
ADT IN A04,A08,A28,A31 IN3 14 0
ADT IN A04,A08,A28,A31 IN3 15 0
ADT IN A04,A08,A28,A31 IN3 16 0
ADT IN A04,A08,A28,A31 IN3 17 0
ADT IN A04,A08,A28,A31 IN3 18 0
ADT IN A04,A08,A28,A31 IN3 19 0
ADT IN A04,A08,A28,A31 IN3 20 0
ADT IN A04,A08,A28,A31 IN3 21 0
ADT IN A04,A08,A28,A31 IN3 22 0
ADT IN A04,A08,A28,A31 IN3 23 0
ADT IN A04,A08,A28,A31 IN3 24 0
ADT IN A04,A08,A28,A31 IN3 25 0
athena Field / Expected Value Notes
Field Separator In the MSH segment only, the pipe delimiter '|' that immediately
^~\& athena expects the HL7 recommended values of ^~\&. These are
Sending Application Source_Vendor
Sending Facility Source_Vendor
Receiving Application Standard Format (e.g. 'ATHENANET')
athenaNet Context ID
Context Name
Message Timestamp Standard Format
** NOT USED **
Message Category Standard Format
Message Type Standard Format
Message ID Standard Format
Processing ID Standard Format
HL7 Version Standard Format
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Event Type (Message Type) Standard Format
Recorded/Creation Date Standard Format
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Set ID - PID
CUSTOM.PID2DATA It is used for patientmatch as internal purpose
External Patient ID (Sender ID) External vendor patient id, MRN or other mutually agr
Patient ID Assigning Authority Authority used to identify the source system which ge
athenaNet Patient ID Sent back to athena if the other vendor's sytem is stor
Patient's Last Name Standard Format
Patient's First Name Standard Format
Patient's Middle Initial
Patient's Name Suffix Standard Format
** NOT USED **
Patient's Date of Birth
Patient's Sex Male/Female
** NOT USED **
Patient's Race Code Must be mapped to athena global value
Patient's Race Name "Foreign Value" associated with mapping
Address Line 1
Address Line 2
Patient's Address City
Patient's Address State
Patient's Address Zip
Patient's Address Country Name
** NOT USED **
Patient's Phone Number - Home Format: #########, (###)###-####, ###-###-####
Patient's Phone Number - Mobile Format: #########, (###)###-####, ###-###-####
Patient's Email Please be aware if you update a patient’s email address
Patient's Phone Number - Work Format: #########, (###)###-####, ###-###-####
Patient's Primary Language Code Must be mapped to athena Global value
Patient's Primary Language Name "Foreign Value" associated with mapping
Patient's Marital Status Code Must be mapped to athena Global value
Patient's Marital Status Information "Foreign Value" associated with mapping
** NOT USED **
** NOT USED **
Patient's SSN
PATIENT.LICENSESTATEID/ PATIENT.LICENSENUMBER
** NOT USED **
Patient's Ethnic Group ID Must be mapped to athena Global value
Patient's Ethnic Group Name "Foreign Value" associated with mapping
Set ID - PV1
CUSTOM.ISOUTPATIENTVISITYN
Patient's Primary Department Name
CUSTOM.ISEDVISITYN
** NOT USED **
** NOT USED **
Primary Provider's ID the athenaNet MX engine will try to match this ID to an
Primary Provider's Last Name
Primary Provider's First Name
Primary Provider's Middle Initial
Referring Provider's ID the athenaNet MX engine will try to match this ID to an NPI in the
Referring Provider's Last Name
Referring Provider's First Name
Referring Provider's Middle Initial
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
VISIT.ADMISSIONSOURCEID
** NOT USED **
** NOT USED **
** NOT USED **
VISIT.LEVELOFCAREID
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
COMMONFIELDS.CLAIM.FROMHOSPITALIZATIONDATE Technically this is populated in COMMONFIELDS becau
SET ID - PV2
VISIT.ACCOMMODATIONID
VISIT.MAINCOMPLAINT
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
SET ID - GT1
** NOT USED **
Guarantor Last Name
Guarantor First Name
Guarantor Middle Initial
Guarantor Name Suffix
** NOT USED **
Guarantor's Address Line 1
Guarantor's Address Line 2
Guarantor's Address City
Guarantor's Address State
Guarantor's Address Zip
Guarantor's Address Country
Guarantor Phone Number
** NOT USED **
Guarantor DOB
PATIENT.RPSEX Guarantor Sex, Not Visible on Portal
** NOT USED **
Patient's Relationship to Guarantor ID Must be mapped to athena Global value
Guarantor SSN
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Guarantor's Employer Foreign ID Must be mapped to athena Global value
Guarantor's Employer Foreign Information "Foreign Value" associated with mapping
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Patient's Emergency Contact Name (Last)
Patient's Emergency Contact Name (First)
Patient's Emergency Contact Phone Number - HOME
** NOT USED **
Emergency Contact's Relationship to Patient
Patient Occupation
Set ID - IN1
Insurance Package Code IN1.2 + IN1.4 + IN1.5 together form the Foreign ID t
** NOT USED **
Insurance Package Name
Insurance Package Address 1
Insurance Package Address 2
Insurance Package Address City
Insurance Package Address State
Insurance Package Address Zip
** NOT USED **
Insurance Package Phone Number Value For Mapping to athena Global Insurance Tables
Insurance Group Number External Value for Code
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Insured's Last Name
Insured's First Name
Insured's Middle Initial
Relationship to Insured External ID Value For Mapping to athena Global Mapping Values
Relationship to Insured External Information External Value for Code
Insured's Date of Birth
Insured's Street Address Line 1 Standard Format
Insured's Street Address Line 2 Standard Format
Insured's Address City Standard Format
Insured's Address State Standard Format
Insured's Address Zip Code Standard Format
PATIENTINSURANCELIST[i].ASSIGNMENTOFBENEFITS
** NOT USED **
Coordination of Benefits Priority/Sequence Number Ranking 1-3
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Insurance Policy Number/ID Number
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Insured's Sex Format: M/F or Male/Female
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
** NOT USED **
Expected by Default
er '|' that immediately follows the 'MSH' segment header is considered the first field of the segment.
ues of ^~\&. These are the component separator, repitition separator, escape character, and subcomponent separator, respectively.
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
h this ID to an NPI in the appropriate client's tablespace. If that match fails it will attempt to match to an athenaNet provider ID, and if that
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
arator, respectively.
Net provider ID, and if that also fails then a mapping task will be triggered to associate the foreign ID to an athenaNet provider ID.
athenaNet provider ID.
Table of Contents
MSG Category Direction MSG TYPE Segment = Field (0.0)
ADT IN A01-A03, A04-A07 MSH
ADT IN A01-A03, A04-A07 EVN
ADT IN A01-A03, A04-A07 PID
ADT IN A04,A08,A28,A31 PID
ADT IN A01-A03, A04-A07 PV1
ADT IN A01-A03, A04-A07 GT1
ADT IN A01-A03, A04-A07 IN1
In the MSH
athena segment
expects the HL7
only, the pipe delimiter
recommended values of
'|' thatThese
^~\&. immediately
are the
follows
component the 'MSH'
separator,
segment
repititionheader is
separator,
Field Component athena Field / Expected Value
considered Notes
the first field
escape character, and
1 0 Field Separator of the segment.
subcomponent
2 0 ^~\& separator, respectively.
3 0 Sending Application Source_Vendor
4 0 Sending Facility Source_Vendor
Standard Format (e.g.
5 0 Receiving Application 'ATHENANET')
6 0 athenaNet Context ID
6 1 Context Name
7 0 Message Timestamp Standard Format
8 0 ** NOT USED **
9 0 Message Category Standard Format
9 1 Message Type Standard Format
10 0 Message ID Standard Format
11 0 Processing ID Standard Format
12 0 HL7 Version Standard Format
13 0 ** NOT USED **
14 0 ** NOT USED **
15 0 ** NOT USED **
16 0 ** NOT USED **
17 0 ** NOT USED **
18 0 ** NOT USED **
19 0 ** NOT USED **
20 0 ** NOT USED **
1 0 Event Type (Message TypeStandard Format
2 0 Recorded/Creation Date Standard Format
3 0 ** NOT USED **
4 0 ** NOT USED **
5 0 ** NOT USED **
6 0 ** NOT USED **
1 0 Set ID - PID External vendor patient
2 0 CUSTOM.PID2DATA id,
It isMRN
used or other
for
Sent to patientmatc
backagreed
mutually athena if
2 1 ** NOT USED ** Authority
the other used toupon
vendor's
ID, oftenthe
identify used for
source
3 0 External Patient ID (Sendesytem
patient
system
ismatching.
storing
which
it. New
generates
patients to athena
3 2 Patient ID Assigning Authothis
would ID not
number
have this
4 0 athenaNet Patient ID filled.
5 0 Patient's Last Name Standard Format
5 1 Patient's First Name Standard Format
5 2 Patient's Middle Initial
5 3 Patient's Name Suffix Standard Format
6 0 ** NOT USED **
7 0 Patient's Date of Birth
8 0 Patient's Sex Male/Female
9 0 ** NOT USED ** Must be mapped to
10 0 Patient's Race Code athena global value
Please be aware if you
update a patient’s email
address in Quickview,
they’ll
"Foreign need to re-
Value"
10 1 Patient's Race Name register to your
associated with mapping
organization’s Patient
11 0 Address Line 1 Portal at the new email
11 1 Address Line 2 address and will not be
11 2 Patient's Address City able to access that
Patient Portal using the
11 3 Patient's Address State athenahealth account
11 4 Patient's Address Zip associated with the
previous email address.
11 5 Patient's Address CountryAn Name
email#########,
invitation to
Format:
12 0 ** NOT USED ** the Patient Portal###-
(###)###-####, is
Format: #########,
automatically sent to the
13 0 Patient's Phone Number ###-####
(###)###-####, ###-
new email address when
13 1 Patient's Phone Number -###-####
an
Format: #########,for
email is updated
13 2 Patient's Email an existing portal###-
(###)###-####, user
14 0 Patient's Phone Number ###-####
Must be mapped to
15 0 Patient's Primary Langua athena
"ForeignGlobal
Value"value
15 1 Patient's Primary Langua associated
Must be mapped with mapping
to
16 0 Patient's Marital Status C athena
"Foreign Value"value
Global
16 1 Patient's Marital Status I associated with mapping
17 0 ** NOT USED **
18 0 Visit Number
19 0 Patient's SSN
20 0 PATIENT.LICENSESTATEID/ PATIENT.LICENSENUMBE
21 0 ** NOT USED ** Must be mapped to
22 0 Patient's Ethnic Group ID athena
"ForeignGlobal
Value"value
22 1 Patient's Ethnic Group N associated with mapping
1 0 Set ID - PV1 the athenaNet MX
2 0 Patient Class engine will try to match
3 0 Rounding Department this ID to an NPI in the
appropriate client's
3 1 Room Number tablespace. If that match
3 2 Bed Number fails it will attempt
the athenaNet MX to
match
engine to an athenaNet
will try to match
3 3 Patient's Primary Department
providerName ID,
4 0 this ID
VISIT.ADMISSIONTYPEID also fails thento an and
NPI if
inthat
the
appropriate client's a mapping
5 0 ** NOT USED ** task will be triggered
tablespace. to
If that match
associate the foreign
fails it will attempt to ID
6 0 ** NOT USED ** to an athenaNet
match to an athenaNet
7 0 Primary Provider's ID provider
provider ID. ID, and if that
7 1 Attending Provider's Last Name
also fails then a mapping
7 2 Attending Provider's First task
Name will be triggered to
associate the foreign ID
7 3 Primary Provider's MiddletoInitial
an athenaNet
8 0 Referring Provider's ID provider ID.
8 1 Referring Provider's Last Name
8 2 Referring Provider's First Name
8 3 Referring Provider's Middle Initial
9 0 ** NOT USED **
10 0 ** NOT USED **
11 0 ** NOT USED **
12 0 ** NOT USED **
13 0 ** NOT USED **
14 0 VISIT.ADMISSIONSOURCEID
15 0 ** NOT USED **
16 0 ** NOT USED **
17 0 Admitting Provider
18 0 VISIT.LEVELOFCAREID
19 0 ** NOT USED **
20 0 ** NOT USED **
21 0 ** NOT USED **
22 0 ** NOT USED **
23 0 ** NOT USED **
24 0 ** NOT USED **
25 0 ** NOT USED **
26 0 ** NOT USED **
27 0 ** NOT USED **
28 0 ** NOT USED **
29 0 ** NOT USED **
30 0 ** NOT USED **
31 0 ** NOT USED **
32 0 ** NOT USED **
33 0 ** NOT USED **
34 0 ** NOT USED **
35 0 ** NOT USED **
36 0 VISIT.DISCHARGEDISPOSITIONID
37 0 ** NOT USED **
38 0 ** NOT USED **
39 0 ** NOT USED **
40 0 ** NOT USED **
44 0 Admit Date
45 0 Discharge Date
1 0 SET ID - PV2
2 0 VISIT.ACCOMMODATIONID
3 0 Admit Reason
4 0 Transfer Reason
5 0 ** NOT USED **
6 0 ** NOT USED **
7 0 ** NOT USED **
8 0 ** NOT USED **
9 0 ** NOT USED **
10 0 ** NOT USED **
11 0 ** NOT USED **
12 0 Visit Description
13 0 ** NOT USED **
14 0 ** NOT USED **
15 0 ** NOT USED **
16 0 ** NOT USED **
17 0 ** NOT USED **
18 0 ** NOT USED **
19 0 ** NOT USED **
20 0 ** NOT USED **
21 0 ** NOT USED **
22 0 ** NOT USED **
23 0 ** NOT USED **
24 0 ** NOT USED **
25 0 ** NOT USED **
26 0 ** NOT USED **
27 0 ** NOT USED **
28 0 ** NOT USED **
29 0 ** NOT USED **
30 0 ** NOT USED **
## 0 Segment Not Used
Expected by Default
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Table of Contents
ADTÂ28 New Patient Message
MSH|^~\&|ATHENANET|99999^MA - athenahealth Testing^1^Test Clinic|TestInterface||201505181454||ADTÂ28|211M900
EVN|A28|201505180254|||username
PID||123456|123456|123456|PATIENTLASTNAME^PATIENTFIRSTNAME||19900101|M|||^^^^ÛNITED STATES||(111)111-1
PV1|||2^TEST DEPARTMENT^^TEST DEPARTMENT||||12345678^SEUSS^DOCTOR||||||||||12345678^SEUSS^DOCTOR
GT1|1||PATIENT^TEST||^^^^ÛNITED STATES|(111)111-1111||19880601|||Self
ADTÂ31 Patient Update Message

EVN|A31|201505180146|||username
PID||456789|456789|456789|LASTNAME^FIRSTNAME^MIDDLE^SUFFIX||19900101|M|PREFERREDNAME|2028-9Âsian|AD
PD1||||A12123^PCPLASTNAME^PCPFIRSTNAME
NK1|1|KIN^NEXTOF|CHILD||||N
NK1|2|CONTACTÊMERGENCY|PARENT||||C
PV1|||2^TEST DEPARTMENT^^TEST DEPARTMENT||||12345678^SEUSS^DOC|98765432^REFERRING^DOC|||||||||1234567
GT1|1||GTORLASTNAME^GTORFIRSTNAME^GTORMIDDLE^GTORSUFFIX||ADDRESSÂDDRESS (CTD)^CITY^STATE^00000^COU
IN1|1|982ÛNITED HEALTHCARE|123Ûnited Healthcare|United Healthcare|PO BOX 740800^ÂTLANTA^GA^30374-0800||(
ADTÂ40 Patient Merge Message

EVN|A40|201505180254|||username
PID||456789|456789|456789|LASTNAME^FIRSTNAME^MIDDLENNAME^SUFFIX||19900101|M|PREFERREDNAME|2028-9Â
MRG||||123456
^^Patientemail@email.com~(222)222-2222ÔRN^CP^^1^222^2222222|(333)333-3333^WPN^PH^^1^333^3333333|engÊnglish|S|||00
GENCY CONTACT|(EChomephone||PARENT
9||||||||||12345|||||||M
mail.com^NET^^Patientemail@email.com~(222)222-2222ÔRN^CP^^1^222^2222222|(333)333-3333^WPN^PH^^1^333^3333333|eng^
3^3333333|engÊnglish|S|||000000000||ATHENA|2186-5^Not Hispanic or Latino
PN^PH^^1^333^3333333|engÊnglish|S|||000000000||ATHENA|2186-5^Not Hispanic or Latino

Table of Contents
Inbound Data Element HL7 Field
Appointments Date/Time SCH_11
Appointments Provider PV1_7
Appointments Department PV1_3
Appointments Appointment Type SCH_8
Appointments Appointment Notes SCH_7
Appointments Appointment Cancel Reason SCH_6
Appointments Appointment Status SCH_25
Charges Appointment ID PV1_19
Charges Rendering Provider FT1.20, or derived from
appointment
Charges Department FT1.16, or derived from
appointment
Charges Service Date
FT1.4, or derived from appointment
Charges Procedure Code FT1_25
Charges Modifier FT1_26
Charges Diagnosis Code FT1_19
Charges ICD Code Set FT1_19_2
Patients Patient ID PID_3
Patients Last Name PID_5_0
Patients First Name PID_5_1
Patients Date of Birth PID_7
Insurance Package ID IN1_2
Insurance Package Name IN1_4
Insurance Policy Number IN1_36
Insurance Relationship to Insured IN1_17
Admit/Discharge (Rounding List) Visit Number PID_18
Admit/Discharge (Rounding List) Rounding Department PV1_3_0
Admit/Discharge (Rounding List) Attending Provider PV1_7_0
Admit/Discharge (Rounding List) Admit Date PV1_44
Admit/Discharge (Rounding List) Patient Class PV1_2
Admit/Discharge (Rounding List) Room Number PV1_3_1
Admit/Discharge (Rounding List) Bed Number PV1_3_2
Admit/Discharge (Rounding List) Admitting Provider PV1_17_0
Admit/Discharge (Rounding List) Discharge Date PV1_45
Admit/Discharge (Rounding List) Notes no default
Notes
If applicable
If applicable
If applicable
If required for procedure code
Not required for the interface to process, but will be processed by default if present
Not required for the interface to process, but can be processed
Table of Contents
The messages segments are sequenced as per the HL7 v2.3.1

reference manual. The only significant difference is that for scheduling
messages, the HL7 manual defines the PID segment as optional and
repeating, whereas athenaNet specifies that the PID segment must be
required and non-repeating.
Legend:
Red Fill Required Segment
Yellow Fill Optional Segment []
Blue Fill Required and Repeatable Segment {}
Green Fill Optional and Repeatable Segment [{}]
Updated (6/19/17)
ADT (A04/A08/A28/A31) Category Message Layout
Segment Definition
MSH Message Header
[ EVN ] Event Type
PID Patient Identification
[ PD1 ] Additional Demographics
[ { NK1 } ] Next of Kin /Associated Parties
PV1 Patient Visit
[ PV2 ] Patient Visit - Additional Info.
[ { DB1 } ] Disability Information
[ { OBX } ] Observation/Result
[ { AL1 } ] Allergy Information
[ { DG1 } ] Diagnosis Information
[ DRG ] Diagnosis Related Group
[{
PR1 Procedures
[ { ROL } ] Role
}]
[ { GT1 } ] Guarantor
[{
IN1 Insurance
[ IN2 ] Insurance Additional Info.
[ { IN3 } ] Insurance Additional Info - Cert.
[ ACC ] Accident Information
}]
[ UB1 ] Universal Bill Information
[ UB2 ] Universal Bill 92 Information
ADT (A40) Category Message Layout

Segment Definition
MSH Message Header
EVN Event Type
PID Patient Identification
[MRG] Merge Patient Information
Table of Contents
Version Release Date
15.2 3/13/2015
15.5 5/8/2015
15.5 5/13/2015
15.5 5/18/2015
15.8 8/15/2015
15.12 12/11/2015
16.7 7/25/2016
3/8/2017
Changes
Initial formatting and layout design. Previously this document was in MS Word.
> Changed the 'Read Me' tab to 'Table of Contents' and added the table of contents.
> Split the 'Message Breakdown' tab into three tabs: Outbound Patients; Outbound
Appointments, and Inbound Charges, and corrected some issues in the 'athena Field'
columns.
> Updated the 'Message Layout by Category' tab.
> Added the 'Minimum Requirements - Inbound' tab.
> Removed ORU specification. Lab result messages are currently available in another
document.
> Broke out 'Outbound Patients' into its own document.

> Added Sample Messages.
> Added Notes column to 'Outbound Patients' tab

> Consolidated message types on the ''Outbound Patients' tab
> Added 'Inbound Patients' tab
> Removed the DFT and SIU category layouts from the 'Message Layout by Category' tab
> Added 'Inbound Admit & Discharge' tab
> Corrected MSH.2 Encoding Characters
> Corrected Minimum Requirements - Inbound
>Removed segments that are not available on BASE::DEFAULT (UB1,UB2,PR1,DRG,DG1,AL1,OBX,DB1)

Adt Specification and Sample Messages

Uploaded by

Copyright:

Available Formats

You might also like

Adt Specification and Sample Messages

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Adt Specification and Sample Messages

Uploaded by

Copyright:

Available Formats

athenahealth HL7 Native Data Structure

Sample Messages Provides sample ADT messages.

Document Change Log Document version history.

ADT^A31 Patient Update Message

ADT^A40 Patient Merge Message

PN^PH^^1^333^3333333|eng^English|S|||000000000||ATHENA|2186-5^Not Hispanic or Latino

If required for procedure code

The messages segments are sequenced as per the HL7 v2.3.1

ADT (A40) Category Message Layout

> Broke out 'Outbound Patients' into its own document.

> Added Notes column to 'Outbound Patients' tab

You might also like