Академический Документы
Профессиональный Документы
Культура Документы
x
ADT Product Specification
HL7 2.3
03/06/2014
Medicity, Inc. has prepared this document for use by Medicity, Inc. personnel, licensees, and
customers. The information contained herein is the property of Medicity, Inc. and shall not be copied,
photocopied, translated, or reduced to any electronic or machine readable form, either in whole or in
part, without prior written approval from Medicity, Inc.
2014 by Medicity, Inc. All Rights Reserved. Printed in the USA.
Trademarks and registered names:
ProAccess is a trademark of Medicity, Inc.
All other trademarks or registered trademarks are the property of their respective owners.
Medicity, Inc.
257 E. 200 S.
Salt Lake City, UT 84111
Phone 801.322.4444 Fax 801.322.4413
www.medicity.com
Table of Contents
1 Introduction ................................................................................................................................7
1.1 Document Purpose .................................................................................................................. 7
1.2 Document Scope ..................................................................................................................... 7
1.3 Referenced Documents ........................................................................................................... 7
2 Communications ........................................................................................................................8
2.1 Minimal Lower Level Protocol .................................................................................................. 8
1 Introduction
The Medicity ADT Inbound interface supports the receipt of HL7 ADT messages. This document defines
and describes the HL7 event codes and messages that Medicity ADT Inbound will accept. This document
also describes how the Medicity ADT Inbound interface will process each event.
This document contains the following chapters:
Chapter 1: Introduction Includes the purpose and scope of the document and a list of related
documents that can help you understand the subject matter.
Chapter 2: Communications Details the generalized interaction and exchange of data according to
MLLP.
Chapter 3: Medicity Business Rules and Guidelines Describes Medicity specific business rules and
guidelines.
Chapter 4: ADT Trigger Events Describes the supported HL7 trigger events for given HL7 ADT
message types.
Chapter 5: Message Structure Definition Identifies the message structure.
Chapter 6: HL7 Segment Layouts Defines HL7 data segments supported in an ADT interface from a
non-Medicity system to ProAccess.
2 Communications
2.1 Minimal Lower Level Protocol
Medicity will not use data validation mechanisms, such as checksums, often required with less reliable
connections.
The generalized interaction and exchange of data proceeds as follows:
1. The initiating system (i.e. the system with data to send) constructs an HL7 message and transmits the
message via an established connection to the receiving system.
2. The receiving system performs basic checks on the incoming message (ensures an HL7 wrapper
<SB>dddd<EB><CR>). These edits are negotiable, but typically includes checking for the presence
of required segments and possibly fields within segments. These basic checks focus on message
structure validity and do NOT include data validation (e.g., a valid patient number).
3. If the message passes the basic checks in step 2, the receiver commits the message to safe storage.
4. The receiver sends an acknowledgement MSA segment to the initiating system. The receiving system
sends the message on to the application layer, and the initiating system is free to send the next
message once the acknowledgement is received by the sending system.
5. In the event that the sending system does not receive an acknowledgement, Medicity expects the
sending system interface to automatically issue a TCP/IP Close Port Command, then recycle the
interface to a Connect To state. Medicity recommends that the sending system not setup an automatic
retry of sending the message prior to recycling the interface and be configured to recycle the interface
after not receiving an ACK.
6. Medicity recommends setting a maximum ACK timeout value of 5-10 seconds on the sending system.
The Medicity required naming conventions defined for R/O fields will be used in the postvalidator.
The goal of the pre-validators is to ensure that the minimum required dataset is available for the
transformer to perform its transformations.
The goal of the post-validators is to ensure that the minimum required dataset is available in an
incoming message to meet all downstream requirements of the database-layer and applicationlayer.
If a message does not pass the validation rules, the message is de-queued for further attention
from the Applicable Support Team.
3.1.1.1
If a field is a Medicity required field, the post-validators will test that the field has a nonempty string value.
If more complex data validation is required (ex: Data is within a specified range of
values), the validation criteria are to be defined within the comments section of the
segment/field/component row of the data element table.
Pre-validation
If Medicity requires a field but the value for that field is sent in a different location, then Medicity will
generally apply pre-validation that that specific value is sent. This ensures that any error messages are
applicable to the received message.
3.1.1.2
Post-validation
Post-validation requirements may not be altered except by a Product Enhancement. Normally when a
requirement cannot be met by a client the requirement will be met by a transformation (i.e. default value)
or by a client change (i.e. revision to send the missing required value).
3.1.2.1
A client may store up to four of patient identifiers. The most commonly used identifiers are Internal
Patient Identifier and Patient Account Identifier.
Note: Within ProAccess, Internal Patient ID is considered the MRN. External Patient Identifier is used
as an EMPI patient identifier.
Note: Medicity matches identifiers by string and not by number. Medicity interprets 01234 and 1234
as two separate identifiers. It is important that data senders send idenifiers in the same format across all
feeds.
Identifier
Identifier in Medicity
PID:3
PID:2
PID:4
PID:18
3.1.2.2
Add/Update Setting
Typically, as the sole system of authority, the ADT system is the only feed that can both add and update
patient demographic data. The exception is for Reference Lab or Outreach Community Services for
which no ADT feed exists because the ancillary becomes the system of authority.
ProAccess has the capability of handling the creation/update of a patient record in the following ways:
Add/Update:
If the patient identified in an inbound message does not currently exist within this
ProAccess Organization, a new patient record will be added.
If the patient identified in an inbound message does currently exist within this
ProAccess Organization, the patient record will be updated with the patient
demographics within the inbound message.
Add Only:
If the patient identified in an inbound message does not currently exist within this
ProAccess Organization, a new patient record will be added.
If the patient identified in an inbound message does currently exist within this
ProAccess Organization, the patient record will not be updated with the patient
demographics within the inbound message.
Medicity does not require that the patient record exist before it receives a Lab Result.
If a result is received before the patient records exist, the patients record will be created based on
the demographics in the first received result. After that, any result that matches to the patient will not
update the patient demographics.
10
Identifier in Medicity
PID:18
Visit Identifier
PV1:19
The values in the table above should only reflect the values to be used in this interface. If the visit
identifier is not used, the row should be grayed out.
Identifier in Medicity
Guarantor Number
GT1:2
Insureds ID Number
IN1:49
NK1:33
3.1.3.1
If a physician ID is sent, Medicity will match on the ID. If there is no match by ID then Medicity will
create the physician record with the provided ID and name.
If a physician ID is not sent, Medicity attempts to match based on free text matching an agreed
upon free text physician ID and name.
Both ID and last name must be provided. If both are not provided, there will be impacts to
provider to patient relationships, result delivery, etc.
3.1.3.2
If an ID is provided without a provider name, Medicity will write the ID to the provider table with
the name of Unknown Physician.
11
This feature will allow a relationship to be established between a provider ID and a patient/result.
Clients will often default a provider ID to a default provider ID if the provider is not known. This
default value must be included in this specification.
Format of physician ID needs to be standardized. If system A sends 0123 and system B sends
123 for the same provider, the data sender shall normalize the provider ID format between
systems.
The ID format must be consistent or made consistent across the ADT and all other interfaces.
Provider ID
Format
99999
A1234
MNEMONIC
7.1
Provider ID
7.2
Last Name
7.3
First Name
7.4
Middle Name
7.5
Prefix
7.6
Suffix
7.7
Degree
Note: Medicity expects that all Provider IDs will match the format of the Attending
Provider ID as described above.
Note: Medicity does not currently support the degree field.
3.1.3.3
If a physician record is created in freetext mode (we receive a provider name without an ID) Medicity will
create a freetext provider ID by setting the Provider ID to the unique string of FREETEXT.
Unless there is a need for an alternative, the free-text provider ID should always be FREETEXT. For
historical reasons the database parser can tailor this per contributing system but in the interests of
providing a common value to downstream systems, Medicity will now always use FREETEXT as the
default value.
Free-Text Physician Identifier
Identifier in Medicity
Ex. |^Smith^John^A^Jr
12
SendingApplicationID
MSH:3
MessageControlID
MSH:10
Event
MSH:9.2
PatientID
PID:3
AlternatePatientID
PID:4
PatientLastName
PID:5.1
PatientMiddleName
PID:5.3
PatientFirstName
PID:5.2
PatientAccountNo
PID:18
13
14
Event Code
Medicity
Supported
Database Parser
Method
Admit a Patient
A01
Yes
ADMIT
Transfer a Patient
A02
Yes
TRANSFER
Discharge a Patient
A03
Yes
DISCHARGE
Register a Patient
A04
Yes
REGISTER
Pre-admit a Patient
A05
Yes
PREADMIT
A06
Yes
TRANSOUTTOIN
A07
Yes
TRANSINTOOUT
A08
Yes
UPDATEPATIENT
A09
No
A10
No
Cancel Admit
A11
Yes
CANCELADMIT
Cancel transfer
A12
Yes
TRANSFER
Cancel Discharge
A13
Yes
CANCELDISCHARGE
Pending Admit
A14
Yes
UPDATEPATIENT
Pending transfer
A15
No
Pending discharge
A16
No
Swap a Patient
A17
Yes
A18
No
Patient query
A19
No
A20
No
A21
Yes
UPDATEADMIT
A22
Yes
UPDATEADMIT
A23
No
A24
No
A25
No
A26
No
A27
No
A28
Yes
ADDPERSON
A29
Yes
DELETEPATIENT
A30
No
SWAP
Event Code
Medicity
Supported
Database Parser
Method
A31
Yes
UPDATEPERSON
A32
No
A33
No
A34
No
A35
No
A36
No
A37
No
Cancel pre-admit
A38
No
A39
No
A40
Yes
MERGEPATIENT
A41
Yes
MERGEACCOUNT
A42
No
A43
No
A44
Yes
A45
No
Change external ID
A46
No
Change internal ID
A47
No
A48
No
A49
No
A50
No
A51
No
MOVEACCOUNT
15
5.1 Messages
The following sections describe HL7 messages and segments and describe of the structure of those
messages.
5.1.1.1
Message
Event TYPE: ADT
Event CODE: A01
Notes:
16
The cardinal order of the segments below shall be followed as defined in the table below.
Medicity requires the segments to be sent in this specific order.
Any Medicity-optional segments not sent by the data provider should be grayed out in the table
below.
If additional segments are requested by the client, a formal product change request must be
submitted and will be considered for a future product release.
If a client sends a Z segment that contains data that needs to be mapped to a supported
segment, it must be listed in the table below. Custom mapping between the Z segment and the
supporting segment will be defined in the custom processing of the segment that will receive the
Z segment data.
If a client sends a Z segment that Medicity can ignore in its entirety, the segment should be listed
in the table below and grayed out with a comment that Medicity will not support this segment.
Segment
Segment Name
Pre-validator
Post-validator
Comments
MSH
Message Header
Required by Medicity
EVN
Event Type
PID
Patient Identification
Not supported
R
Required by Medicity
[PD1]
Additional
Demographics
[ { NK1 } ]
Next of Kin
PV1
Patient Visit
[PV2]
Additional Patient
Visit
[ { AL1 } ]
Allergy Information
[ { DG1 } ]
Diagnosis
Information
[ { PR1 } ]
Procedures
[ { GT1 } ]
Guarantor
Required by Medicity in
visit-level messages
like the A01. Not
required in person-level
messages like the A31.
[
{ IN1
Insurance
Information
[ IN2] }
Insurance
Additional Info
]
[ACC]
Accident Information
5.1.2.1
Message
Same as the Admit a Patient (A01) message.
17
5.1.3
Medicity ADT Parser will process the A03 discharge message to update the discharge date and time for
any encounter type. Discharge transactions will be sent by the ADT System for all encounter types.
The Medicity ADT Parser server will not null location codes on the encounter row.
5.1.3.1
Message
Same as the Admit a Patient (A01) message.
5.1.4.1
Message
Same as the Admit a Patient (A01) message.
5.1.5.1
Message
Same as the Admit a Patient (A01) message.
5.1.6.1
Message
Same as the Admit a Patient (A01) message.
18
5.1.7.1
Message
Same as the Admit a Patient (A01) message.
5.1.8.1
Message
Same as the Admit a Patient (A01) message.
19
Parser will not automatically null any specific encounter fields; instead, the Medicity ADT Parser expects
the sending system to send the HL7 null to erase unwanted dates or coded data elements.
The ADT System will send the admit date and time back to the future date and time rendering the
encounter as a Pre-registration.
5.1.9.1
Message
Same as the Admit a Patient (A01) message.
20
Segment
Segment Name
MSH
Message Header
EVN
Event Type
PID
Patient Identification
[ PD1 ]
Additional Demographics
PV1
Patient Visit
PID
Comments
[ PD1 ]
PV1
5.1.12 Leave of Absence - Leaving (A21) and Leave of Absence Returning (A22)
Medicity ADT Parser processes the Leave of Absence Leaving (A21) and Leave of Absence Return (A22)
as an A08 Patient Update.
5.1.12.1 Leave of Absence - Leaving (A21) and Leave of Absence Returning (A22) Message Structure
Message
Same as the Admit a Patient (A01) message.
Segment Name
Comments
MSH
Message Header
Required by Medicity
EVN
Event Type
PID
Patient Identification
[ PD1 ]
Additional Demographics
{ [ NK1 ] }
Next of Kin
Required by Medicity
21
Segment Name
Comments
MSH
Message Header
Required by Medicity
EVN
Event Type
PID
Patient Identification
[ PD1 ]
Additional Demographics
{ [ NK1 ] }
Next of Kin
Required by Medicity
22
for notification of real-time Patient Administration events. These events are primarily for demographic
data, but optional historical non-demographic data may be sent as well.
The Medicity database parser will treat an A31 the same as any ADT event if the patient record did not
exist. Some systems include encounter-level data in their A31 messages. The Medicity database parser
will ignore these portions of the messages.
Segment Name
Comments
MSH
Message Header
Required by Medicity
EVN
Event Type
PID
Patient Identification
[ PD1 ]
Additional Demographics
{ [ NK1 ] }
Next of Kin
Required by Medicity
23
Segment Name
MSH
Message Header
EVN
Event Type
Comments
Required by Medicity
{
PID
Patient Identification
[ PD1 ]
Additional Demographics
MRG
Merge Information
Required by Medicity
Required by Medicity
24
Segment Name
Comments
MSH
Message Header
Required by Medicity
EVN
Event Type
{
PID
Patient Identification
[ PD1 ]
Additional Demographics
MRG
Merge Information
[PV1]
Visit Information
Required by Medicity
Required by Medicity
25
Segment Name
MSH
Message Header
EVN
Event Type
Comments
Required by Medicity
{
PID
Patient Identification
Required by Medicity
[ PD1 ]
Additional Demographics
MRG
Merge Information
Required by Medicity
26
Contents
Values
Seq
Name
Defined by HL7.
R/O
Field/Component
Required by ProAccess
Comment
Note: Rows displayed in gray were reviewed but will not be used in this interface.
If a field is marked as not supported by Medicity, an application enhancement would be required to add
the additional data and would need to be a part of a sanctioned product release.
2013-2014 Medicity, Inc - Proprietary & Confidential
27
If a field is marked as required by Medicity and cannot be provided by the data provider, a formal HL7
configuration discussion must take place between Medicity and the client as adverse effects will be
encountered within the product if required data cannot be provided.
6.1
Control Segments
Segment Layout
MSH Seq
Name
R/O
Comments
01
Field separator
Field separator.
Value required is | ASCII(124)
02
Encoding Character
03
Sending Application
04
Sending Facility
05
Receive Application
06
Receiving Facility
07
Date/Time of Message
08
Security
09
Message Type
09.1
Type
09.2
Event
10
28
Message Control ID
MSH Seq
Name
11
Processing ID
R/O
11.1
Processing ID
11.2
Mode
12
Version ID
13
Sequence Number
14
Continuation Number
15
16
17
Country Code
18
Character Set
19
Language of Message
Comments
unique. Medicity will replace the received value with a
unique Medicity identifier (aka thread ID).
Acceptable values:
P = Production
Segment Layout
MSA Seq
Name
01
Acknowledge Code
R/O
R
Comments
Acceptable values:
AA = ACK = message stored
AE = NACK = message rejected due to content
issue.
AR = NACK = message rejected due to internal
system error.
See HL7 CH 2 for more information on this topic.
02
Message Control ID
03
Text Message
04
05
06
Error Condition
Original Message:
MSH|^~\&|ABCADT|ABC|Medicity||19960214134522||ADT^A01|A13345.78|P|2.3
29
Segment Layout
EVN Seq
Name
R/O
01
02
Date/Time of Event
03
04
05
Operator ID
06
Event Occurred
Comments
Segment Layout
PID Seq
Name
01
Set ID - PID
02
External Patient ID
Comments
02.1
Patient ID
02.2
Check Digit
02.3
02.4
Assigning Authoring
02.5
Identifier Type
02.6
Assigning Facility
03
30
R/O
Internal Patient ID
PID Seq
Name
R/O
Comments
Unfortunately, Medicity does not yet support
repetitions in this field.
This is a criteria in the Medicity Enterprise
Patient Matching (EMPI).
03.1
Patient ID
03.2
Check Digit
03.3
03.4
Assigning Authoring
03.5
Identifier Type
03.6
Assigning Facility
Alternate Patient ID
04
04.1
Patient ID
04.2
Check Digit
04.3
04.4
Assigning Authoring
04.5
Identifier Type
04.6
Assigning Facility
Patient Name
05.1
Last Name
05.2
First Name
05.3
Middle Name
05.4
Suffix
05.5
Prefix
05.6
Degree
05
06
07
Date of Birth
08
Sex
09
Patient Alias
09.1
Last Name
09.2
First Name
09.3
Middle Name
09.4
Suffix
31
PID Seq
32
Name
R/O
Comments
09.5
Prefix
09.6
Degree
10
Race
11
Patient Address
11.1
Address Line 1
11.2
Address Line 2
11.3
City
11.4
State
11.5
ZIP Code
11.6
Country
11.7
Type
11.8
11.9
County/Parish
11.10
Census Tract
12
County Code
13
14
15
Language Patient
16
Marital Status
17
Religion
18
18.1
18.2
Check Digit
18.3
18.4
Assigning Authority
18.5
Identifier Type
18.6
Assigning Facility
PID Seq
Name
R/O
Comments
Patient Matching (EMPI) and Community
Patient Matching (CMPI). Formatting does not
impact its matching.
19
SSN Patient
20
21
Mothers Identifier
22
Ethnic Group
23
Birth Place
Acceptable values:
Y = Yes
N = No
24
25
Birth Order
26
Citizenship
27
28
Nationality
29
Acceptable values:
Y = the patient is deceased
N = the patient is not deceased
30
Segment Layout
PD1 Seq
Name
R/O
01
Living Dependency
02
Living Arrangement
03
04
04.1
04.2
Last Name
04.3
First Name
04.4
Middle Name
04.5
Suffix
04.6
Prefix
04.7
Degree
Comments
33
04.8
Source Table
04.9
Assigning Authority
04.10
Name Type
04.11
Check Digit
04.12
04.13
Identifier Type
05
Student Indicator
06
Handicap
07
Living Will
08
Organ Donor
09
Separate Bill
10
Duplicate Patient
11
Privacy Type
12
Protection Indicator
13
Protection Indicator
Effective Date/Time
6.2.3.1
Protection Indicator
Definitions include:
HIPAA OPT-IN
HIPAA OPT-OUT
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the consent status of
a patient within the HIE. Medicity will use this field to allow the upstream ADT system of authority to
indicate the patients OPT-IN or OPT-OUT setting. The Codeset will use the definition values of "HIPAA
OPT-IN" and "HIPAA OPT-OUT".
The standard Codeset value for Opt-In is OI and OO for Opt-Out. Medicity highly recommends the use
of these two codes because they are the defined HL7 2.6 standard values. Medicity can support other
Codeset values on a per-implementation basis, but does not recommend this.
The Subdefinition is required for the HIPAA defined codes.
The Subdefinition is required for legacy clients (using PA 5) that are populating PD1:12 with their VIP
indicator values.
34
The Subdefinition will determine if the values with no definition of HIPAA OPT-IN/OUT are protected or
not at the data source level
Protection Indicator Effective Date/Time
To ensure a value is set Medicity commonly uses the following rules. If appropriate, custom processing
may be defined below in the custom processing section.
Look at PD1:12. If valued, and the value has a Definition of HIPAA OPT-IN or HIPAA OPT-OUT,
PD1:13 MUST be populated.
MRG Seq
Name
R/O
01
02
03
04
Prior Patient ID
05
06
07
Comments
Required for A40 and A44 messages.
Required for A41 and A44 messages.
Segment Layout
NK1 Seq
Name
R/O
01
Set ID - NK1
02
02.1
Last Name
02.2
First Name
02.3
Middle Name
02.4
Suffix
02.5
Prefix
02.6
Degree
03
04
Comments
35
NK1 Seq
36
Name
R/O
04.1
Address Line 1
04.2
Address Line 2
04.3
City
04.4
State
04.5
ZIP Code
04.6
Country
04.7
Type
04.8
Other Geographic
04.9
County/Parish
04.10
Census Tract
Comments
05
06
07
Contact Role
08
Start Date
09
End Date
10
11
11.1
Job Code
11.2
Job Class
12
13
Organization Name
14
Marital Status
15
Sex
16
Date of Birth
17
Living Dependency
18
Ambulatory Status
19
Citizenship
20
Primary Language
21
Living Arrangement
22
Privacy Type
23
Protection Indicator
24
Student Indicator
25
Religion
26
27
Nationality
28
Ethnic Group
29
Contact Reason
NK1 Seq
Name
30
31
Contact Phone
32
Contact Address
33
NK1 Identifiers
34
Job Status
35
Race
36
Handicap
37
38
39
VIP Indicator
6.2.2.1
R/O
Comments
The sending system must include all NK1 segments for this encounter. The Medicity ADT Parser will
update NK1 segments as a unit.
Example: Transaction 1 for same patient & encounter is sent with 2 NK1 segments. Transaction 2 for
same patient & encounter is sent with 1 NK1 segment. Only the NK1 segment sent in the second
transaction is preserved as HL7 does not support the discrete removal of NK1 entries.
Protection Indicator
Definitions include:
HIPAA OPT-IN
HIPAA OPT-OUT
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the protection
indicator confidentiality status of a provided insurance at the encounter level. The Subdefinition for the
codeset will determine if the specified diagnosis for the encounter is now confidential (not viewable) or
notconfidential (viewable).
37
Segment Layout
PV1 Seq
Name
01
Set ID - PV1
Starts at 1; increments by 1.
02
Patient Class
03
Patient Location
03.1
03.2
Patient Room
03.3
Patient Bed
03.4
Facility ID
03.5
Bed Status
03.6
Location Type
03.7
Building
03.8
Floor
Comments
04
Admission Type
05
Pre-admit Number
06
07
Attending Doctor
07.1
Attending Doctor ID
07.2
Last Name
07.3
First Name
07.4
Middle Name
07.5
Suffix
07.6
Prefix
07.7
Degree
07.8
Source Table
07.9
Assigning Authority
07.10
Name Type
07.11
Check Digit
07.12
07.13
Identifier Type
Referring Doctor
08
08.1
38
R/O
Referring Doctor ID
PV1 Seq
Name
R/O
Comments
08.2
Last Name
08.3
First Name
08.4
Middle Name
08.5
Suffix
08.6
Prefix
08.7
Degree
08.8
Source Table
08.9
Assigning Authority
08.10
Name Type
08.11
Check Digit
08.12
08.13
Identifier Type
Consulting Doctor
09
09.1
Consulting Doctor ID
09.2
Last Name
09.3
First Name
09.4
Middle Name
09.5
Suffix
09.6
Prefix
09.7
Degree
09.8
Source Table
09.9
Assigning Authority
09.10
Name Type
09.11
Check Digit
09.12
09.13
Identifier Type
10
Hospital Service
11
Temporary Location
12
13
Re-admission Indicator
14
Admission Source
15
Ambulatory Status
16
VIP Indicator
39
PV1 Seq
Name
17
Admitting Doctor
Comments
17.1
Admitting Doctor ID
17.2
Last Name
17.3
First Name
17.4
Middle Name
17.5
Suffix
17.6
Prefix
17.7
Degree
17.8
Source Table
17.9
Assigning Authority
17.10
Name Type
17.11
Check Digit
17.12
17.13
Identifier Type
18
Patient Type
19
Visit Number
20
Financial Class
21
22
Courtesy Code
23
Credit Rating
24
Contract Code
25
26
Contract Amount
27
Contract Period
28
Interest Code
29
30
31
32
33
34
35
36
Discharge Disposition
37
Discharge To Location
37.1
40
R/O
Code
PV1 Seq
Name
37.2
Description
R/O
Comments
38
Diet Type
39
Servicing Facility
40
Bed Status
41
Account Status
42
Pending Location
43
44
Admit Date/Time
45
Discharge Date/Time
46
47
Total Charges
48
Total Adjustment
49
Total Payments
50
Alternate Visit ID
51
Visit Indicator
52
6.2.3.1
VIP Indicator
Subdefinitions include:
N^Normal
V^Very Restricted
R^Restricted
Medicity will use this field to allow the upstream ADT system of authority to indicate the VIP indicator
status for down stream delivery of results. Within the scope of the HIE, the organization sending VIP
indicator must consider what its intended purpose of this field is.
Is VIP indicator being used to protect the patient within the scope of the organization only?
i. If so, PV1:16 may be copied to PV2:22 which Medicity uses to protect patients at the data
source level.
Is VIP indicator being used to protect the patient within the scope of the HIE as a whole?
i. If so, PV1:16 may be copied to PD1:12 which Medicity uses to protect patients at the HIE
level. See the Protection indicator business rules in section 6.2.3.
41
Segment Layout
This segment is optional. If the segment is used, the required fields are listed below. If not used, all
fields must be grayed out.
PV2 Seq
Name
R/O
01
02
Accommodation Code
03
Admit Reason
03.1
03.2
04
Transfer Reason
Comments
See Codeset: CS_ACCOMODATION
04.1
04.2
05
Patient Valuables
06
07
08
09
10
11
12
Visit Description
13
14
15
16
17
18
19
Retention Indicator
20
Expected Number of
Insurance Plans
21
22
6.2.4.1
Protection Indicator
42
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the protection status
of a patient at the data source level. A subdefinition of Y will make a patient not viewable from the
specific data source for users who do not have access to protected data.
Medicity stores allergies at the encounter level but only displays the allergies attached to the most
current encounter.
For some systems we only get allergy updates and need to maintain all allergies that were ever
sent.
An agreement needs to be made with the client on how we should process their allergy data.
Segment Layout
This segment is optional. If the segment is used, the required fields are listed below. If not used, all
fields must be grayed out.
AL1 Seq
Name
R/O
01
Set ID - AL1
02
Allergy Type
03
Allergy Code
03.1
Identifier
03.2
Description
03.3
Comments
Required if an AL1 segment is sent.
04
Allergy Severity
05
Allergy Reaction
06
Identification Date
43
Segment Layout
44
DG1 Seq
Name
R/O
Comments
01
Set ID - DG1
02
See Codeset:
CS_DIAGNOSIS_CODE_METHOD
Medicity requires that DG1:2 and DG1:3.3
match.
03
Diagnosis Code
03.1
Identifier
03.2
Description
03.3
04
Diagnosis Description
05
06
Diagnosis Type
07
08
09
10
11
Outlier Type
12
Outlier Days
13
Outlier Cost
14
15
Diagnosis Priority
16
Diagnosing Clinician
17
Diagnosis Classification
18
Confidential Indicator
19
Attestation Date/Time
6.2.6.1
The HL7 Standard does not provide a reliable way to identify and update a particular instance of
repeating segments. Consequently, the Medicity ADT Parser will use Set ID Diagnosis (DG1:1) only to
represent the sequencing of DG1 segments within a message. The sending system must include all
diagnoses for a given type (e.g., all finals). Medicity ADT Parser will update all diagnoses of this type as a
unit. Medicity ADT Parser will automatically delete (inactivate) extra instances in the ProAccess database
not included in the HL7 message.
There are specific rules surrounding DG1:2, DG1:3, and DG1:4 requirements.
If the Diagnosis Coding Method (DG1:2) is FT (for FreeText), the Diagnosis Code (DG1:3) may
be used if all three components are populated. If all three components in DG1:3 are not or cannot
be populated, the Diagnosis Description (DG1:4) is required.
Examples of supported DG1:2, DG1:3, and DG1:4 formatting when DG1:2 is FT:
DG1|1|FT|1^Abdominal Pain^FT||
DG1|1|FT||Abdominal Pain||
If the Diagnosis Coding Method is I9 or I10, then Diagnosis Code (DG1:3) must contain a CE
Data Type. This means the ID (DG1:3.1), Description (DG1:3.2), and Name of Coding System
(DG1:3.3) must be populated in their respective DG1:3 components. When DG1:3.1 and
DG1:3.2 are sent DG1:3.3 is a required field and must be populated with the code method (I9 or
I10).
Examples of supported DG1:2, DG1:3 formatting when DG1:2 is I9 or I10:
DG1|1|I9|995.91^Sepsis^I9||
Protection Indicator
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the protection status
of a patient at the data source level. A subdefinition of Y will make a patient not viewable from the
specific data source for users who do not have access to protected data.
PR1 Seq
Name
R/O
01
Set ID - PR1
02
Procedure Coding
Use PR1:3.3.
Comments
45
Method
03
46
Procedure Code
03.1
Identifier
03.2
Text
03.3
Name of Coding
System
03.4
Alternate Identifier
03.5
Alternate Text
03.6
Name of Alternate
Coding System
04
Procedure Description
05
Procedure Date/Time
06
Procedure Functional
Type
07
Procedure Minutes
08
Anesthesiologist
Use PR1:3.2.
Acceptable values:
A = Anesthesia
P = Procedure for treatment (therapeutic, including
operations)
I = Invasive Procedure not classified elsewhere (i.e.
IV catheter)
D = Diagnostic procedure
08.1
Identifier
08.2
Last Name
08.3
First Name
08.4
Middle Name
08.5
Prefix
08.6
Suffix
08.7
Degree
08.8
Source Table
08.9
Assigning Authority
08.9.1
Namespace ID
08.9.2
Universal ID
08.9.3
Universal ID Type
08.10
08.11
08.12
08.13
Acceptable values:
DEA = Drug Enforcement Administration
Registration Number
DN = Doctor Number
MD = Medical License Number
NP = Nurse Practitioner Number
NPI = National Provider Identifier
PA = Physician Assistant Number
PRN = Provider Number
RN = Registered Nurse Number
UPIN = Medicare/CMS Universal physician
Identification number
RPH = Pharmacist License Number
SL = State License
Codeset User defined
09
Anesthesia Code
10
Anesthesia Minutes
11
Surgeon
11.1
Identifier
11.2
Last Name
11.3
First Name
11.4
Middle Name
11.5
Prefix
11.6
Suffix
11.7
Degree
11.8
Source Table
11.9
Assigning Authority
11.9.1
Namespace ID
11.9.2
Universal ID
11.9.3
Universal ID Type
11.10
11.11
11.12
11.13
Procedure Practitioner
12
12.1
Identifier
12.2
Last Name
47
12.3
First Name
12.4
Middle Name
12.5
Prefix
12.6
Suffix
12.7
Degree
12.8
Source Table
12.9
Assigning Authority
12.9.1
Namespace ID
12.9.2
Universal ID
12.9.3
Universal ID Type
12.10
12.11
12.12
12.13
13
Consent Code
13.1
Identifier
13.2
Text
13.3
Name of Coding
System
13.4
Alternate Identifier
13.5
Alternate Text
13.6
Name of Alternate
Coding System
14
Procedure Priority
15
48
Associated Diagnosis
Code
15.1
Identifier
15.2
Text
15.3
Name of Coding
System
15.4
Alternate Identifier
15.5
Alternate Text
O
2013-2014 Medicity, Inc - Proprietary & Confidential
15.6
16
Name of Alternate
Coding System
Procedure Code
Modifier
O
O
16.1
Identifier
16.2
Text
16.3
Name of Coding
System
16.4
Alternate Identifier
16.5
Alternate Text
16.6
Name of Alternate
Coding System
17
18
18.1
Identifier
18.2
Text
18.3
Name of Coding
System
18.4
Alternate Identifier
18.5
Alternate Text
18.6
Name of Alternate
Coding System
19
Procedure Identifier
19.1
Entity Identifier
19.2
Namespace ID
19.3
Universal ID
19.4
Universal ID Type
20
49
The GT1 segment contains guarantor (person or organization with financial responsibility for payment of a
patient account) data for patient and insurance billing applications. All pre-validators shall be configured
to check for client required fields. All post-validators shall be configured to check for all Medicity required
fields.
50
GT1 Seq
Name
R/O
01
Set ID - GT1
02
Guarantor Number
03
Guarantor Name
03.1
Last Name
03.2
First Name
03.3
Middle Name
03.4
Prefix
03.5
Suffix
03.6
Degree
04
05
Guarantor Address
05.1
Address Line 1
05.2
Address Line 2
05.3
City
05.4
State
05.5
ZIP
05.6
Country
05.7
Type
05.8
Other Geographic
05.9
County/Parish
Comments
06
07
08
09
Guarantor Sex
10
Guarantor Type
11
Guarantor Relationship
12
Guarantor SSN
13
14
15
Guarantor Priority
16
17
GT1 Seq
Name
R/O
17.1
Address Line 1
17.2
Address Line 2
17.3
City
17.4
State
17.5
ZIP
17.6
Country
17.7
Type
17.8
Other Geographic
17.9
County/Parish
18
19
20
21
Guarantor Organization
21.1
Organization Name
21.2
21.3
ID Number
21.4
Check Digit
21.5
21.6
Assigning Authority
21.7
21.8
Assigning Facility
Comments
22
23
24
25
26
27
28
29
30
31
32
33
Living Dependency
34
Ambulatory Status
35
Citizenship
36
Primary Language
37
Living Arrangement
38
Privacy Type
51
GT1 Seq
Name
R/O
39
Protection Indicator
40
Student Indicator
41
Religion
42
43
Nationality
44
Ethnic Group
45
46
47
Contact Reason
48
Contact Relationship
49
Job Title
50
Job Code
50.1
Job Code
50.2
Job Class
51
52
Handicap
53
Job Status
54
54.1
Financial Class
54.2
Effective Date
55
Guarantor Race
56
57
VIP Indicator
6.2.8.1
Comments
The Medicity ADT Parser will accept multiple instances of the GT1 segment. The sending system must
send all instances for this encounter.
Protection Indicator
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the protection status
of a patient at the data source level. A subdefinition of Y will make a patient not viewable from the
specific data source for users who do not have access to protected data.
52
Segment Layout
IN1 Seq
Name
R/O
01
Set ID - IN1
02
Insurance Plan ID
03
Insurance Company ID
03.1
ID
03.2
03.3
Assigning Authority
03.4
03.5
Assigning Facility
04
05
05.1
Street Address
05.2
Other Designation
05.3
City
05.4
State or Province
05.5
05.6
Address Type
05.7
05.8
Country/Parish Code
05.9
Census Tract
06
07
08
Group Number
09
Group Name
10
11
12
13
14
Authorization Information
14.1
Authorization Number
14.2
Date
14.3
Source
Comments
Set ID begins at 1 and increments by 1
53
IN1 Seq
Name
R/O
15
Plan Type
16
Name of Insured
16.1
Last Name
16.2
First Name
16.3
Middle Name
16.4
Prefix
16.5
Suffix
16.6
Degree
17
18
19
Insureds Address
19.1
Address Line 1
19.2
Address Line 2
19.3
City
19.4
State
19.5
ZIP
19.6
Country
19.7
Type
19.8
Other Geographic
19.9
County/Parish
20
Assignment of Benefits
21
Coordination of Benefits
22
Comments
If IN1:16 is sent, 16.1 and 16.2 are required
54
23
24
25
26
27
28
29
Verification Date/Time
30
Verification By
31
32
Billing Status
IN1 Seq
Name
R/O
33
34
35
36
Policy Number
37
Policy Deductible
38
39
40
41
42
43
Insureds Sex
44
45
Verification Status
46
47
Coverage Type
48
Handicap
49
Insureds ID Number
50
Signature Code
51
52
53
VIP Indicator
Comments
Segment Layout
IN2 Seq
Name
R/O
01
Insureds Employee ID
02
Insureds SSN
03
03.1
Employer ID
03.2
Employer Name
04
05
06
07
Comments
55
IN2 Seq
Name
08
09
10
Champus ID Number
11
12
Champus Organization
13
Champus Station
14
Champus Service
15
Champus Rank/Grade
16
Champus Status
17
18
19
Baby Coverage
20
21
Blood Deductible
22
23
24
25
Payor ID
26
Payor Sub ID
27
Eligibility Source
28
28.1
Room Type
28.2
Amount Type
28.3
Coverage Amount
Policy Type/Amount
29
56
R/O
29.1
Policy Type
29.2
Amount Class
29.3
Amount
Comments
30
Daily Deductible
31
Living Dependency
32
Ambulatory Status
33
Citizenship
34
Primary Language
35
Living Arrangement
36
Privacy Type
37
Protection Indicator
38
Student Indicator
IN2 Seq
Name
R/O
Comments
39
Religion
40
41
Nationality
42
Ethnic Group
43
Marital Status
44
45
46
Job Title
47
Job
48
Job Status
49
50
51
52
53
54
55
56
57
58
59
Policy Scope
60
Policy Source
61
62
63
64
65
66
Suspend Flag
67
68
69
70
71
Race
72
57
Protection Indicator
Subdefinitions include:
Medicity will use this field to allow the upstream ADT system of authority to indicate the protection status
of a patient at the data source level. A subdefinition of Y will make a patient not viewable from the
specific data source for users who do not have access to protected data.
Segment Layout
58
ACC Seq
Name
R/O
01
Accident Date/Time
02
Accident Code
03
Accident Location
04
05
06
07
Entered By
08
Accident Description
09
Brought In By
10
11
Accident Address
Comments
See Codeset: CS_ACCIDENT_CODE
See: Medicity Base Codeset
59