LINKMED® Interface Tutorial: HL7 ADT Segments and Fields

The following HL7 segment are used in HL7 version 2.6 and above

6.14 SFT - Software segment (New)
Definition: This segment provides additional information about the software product(s) used as a Sending Application. The primary purpose of this segment is for diagnostic use. There may be additional uses per site-specific agreements.

Seq
Element Name
Req
Len
Comments
0
Segment ID (SFT)
R
3
SFT
1
Software Vendor Organizationl
R
567
 
2
Software Certified Version or Release Number (ST)
R
15
 
3
Software Product Name (ST)
R
20
 
4
Software Binary ID (ST)
R
20
 
5
Software Product Information (TX)
O
1024
 
6
Software Install Date (DTM)
O
24
 
R = Required, CR = Conditionally Required, O = Optional, N = Numeric, AN = Alpha/Numeric, ID = Segment Identification

6.15 UAC - User Authentication Credential Segment (New)
Definition:
This optional segment provides user authentication credentials, a Kerberos Service Ticket or SAML assertion, to be used by the receiving system to obtain user identification data. It is to be used in when the receiving application system requires the sending system to provide end-user identification for accountability or access control in interactive applications. Since user authentication implementations often limit the time period for validity of the session authentication credentials, this segment is not intended for use in non-interactive applications.
It is possible that various user authentication credential standards' data may be communicated. Kerberos and SAML are two such standards. A user authentication credential is an encapsulated data (ED type) element, as defined by standards, with no HL7-relevant structure.

Seq
Element Name
Req
Len
Comments
0
Segment ID UAC
R
3
UAC
1
User Authentication Credential Type Code
R
705
2
User Authentication Credential
R
65536  
R = Required, CR = Conditionally Required, O = Optional, N = Numeric, AN = Alpha/Numeric, ID = Segment Identification

6.16 ARV Access Restrictions segment
The ARV segment is used to communicate the requested/required type of access restrictions from system to system, at both the person/patient and the encounter/visit level.
Examples:
A person/patient may have the right to object to any or all of his/her information to be disclosed. In addition, the patient may request that protected information not be disclosed to family members or friends who may be involved in their care or for notification purposes.

Seq
Element Name
Req
Len
Comments
0
Segment ID ARV
R
3
ARV
1
Set ID
I
4
 
2
Access Restriction Action Code
R
705
 
3
Access Restriction Value
R
705
 
4
Access Restriction Reason
O
705
 
5
Special Access Restriction Instructions
O
250
 
6
Access Restriction Date Range
O
49
 
R = Required, CR = Conditionally Required, O = Optional, N = Numeric, AN = Alpha/Numeric, ID = Segment Identification

6.17 ROL - Role Segment
The role segment contains the data necessary to add, update, correct, and delete from the record persons involved, as well as their functional involvement with the activity being transmitted.
In general, the ROL segment is used to describe a person playing a particular role within the context of the message. In PM, for example, in the Grant Certificate/Permission message (B07), the ROL segment is used to describe the roles a person may perform pertinent to the certificate in the message.
The positional location of the ROL segment in ADT and Finance messages indicates the relationship. When the segment is used following the IN3 segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the health plan. When the segment is used following the PID segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the person. When the segment is used following the PV2 segment, and the role-ROL value is PCP or FHCP, the PP or FHCP is related to the patient visit.

Seq
Element Name
Req
Len
Comments
0
Segment ID ROL
R
3
ROL
1
Role Instance ID
C
60
 
2
Action Code
R
2
 
3
Role-ROL
R
250
 
4
Role Person
R
250
 
5
Role Begin Date/Time
O
250
 
6
Role End Date/Time
O
250
 
7
Role Duration
O
250
 
8
Role Action Reason
O
250
 
9
Provider Type
O
250
 
10
Organization Unit Type
O
250
 
11
Office/Home Address/Birthplace
O
250
 
12
Phone
O
250
 
13
Person's Location
O
1230
 
R = Required, CR = Conditionally Required, O = Optional, N = Numeric, AN = Alpha/Numeric, ID = Segment Identification

NOTE: HL7 PD1 and DB1 segments and fields will not be described in this tutorial.


| HL7 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 |