Definitions Alternatively fixed alleles Dominant vs. co-dominant markers Genotype.
Appendix A - Fixed Length Segment Definitions...Appendix A - Fixed Length Segment Definitions...
Transcript of Appendix A - Fixed Length Segment Definitions...Appendix A - Fixed Length Segment Definitions...
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging
Ministry of Health Services
Professional and Software Compliance Standards For HL7 Messaging
Appendix A - Fixed Length Segment Definitions
Version 3.1
January 9, 2004
January 9, 2004 Version 3.1 Page 1
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Author: HealthnetBC
Creation Date: February 24, 2003
Last Updated: March 29, 2004
Document Number:
Version: 3.1
Approvals: Project Sponsor
Signature Date
Kathy Hill
healthnetBC Access Services
Compliance Process Standards
Approval
Reviewer
Signature:
Signature:
Name: Kathy Hill Name: Robert Grant
Title:
Manager
healthnetBC Access Services
Title: HL7 Analyst,
Standards & Architecture
Date:
Date:
Page 2 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging
CONTENTS
1 General Information...................................................................................................................................................... 6 1.1 Corrections and updates............................................................................................................................................................ 6 1.2 Who is the audience? ................................................................................................................................................................ 6
2 Overview........................................................................................................................................................................ 6 3 HL7 V2.3 Segment Definitions ..................................................................................................................................... 7
3.1 HNET:AL1 - Allergy Segment .................................................................................................................................................... 7 3.2 HNET:BLG - Billing Segment..................................................................................................................................................... 7 3.3 HNET:DG1 - Diagnosis Segment .............................................................................................................................................. 8 3.4 HNET:ERR - Error Segment .................................................................................................................................................... 9 3.5 HNET:EVN – Event Reason .................................................................................................................................................... 10 3.6 HNET:IN1 - Insurance Segment .............................................................................................................................................. 11 3.7 HNET:MSA - Message Acknowledgment Segment................................................................................................................. 14 3.8 HNET:MSH - Message Header Segment ................................................................................................................................ 15 3.9 HNET:NK1 - Next of Kin/Associated Parties Segment ............................................................................................................ 17 3.10 HNET:NTE - Notes and Comments Segment.......................................................................................................................... 20 3.11 HNET:OBR - Observation Request Segment .......................................................................................................................... 21 3.12 HNET:OBX - Observation Result Segment ............................................................................................................................. 23 3.13 HNET:ORC - Order Common Segment................................................................................................................................... 25 3.14 HNET:PID - Person Identification Segment ............................................................................................................................. 26 3.15 HNET:PRD - Provider Data Segment ...................................................................................................................................... 28 3.16 HNET:PV1 - Patient Visit Segment.......................................................................................................................................... 29 3.17 HNET:PV2 - Patient Visit - Additional Information Segment.................................................................................................... 31 3.18 HNET:QRD - Original-Style Query Definition Segment ........................................................................................................... 33 3.19 HNET:QRF - Original Style Query Filter Segment................................................................................................................... 34 3.20 HNET:RF1 - Referral Information Segment ............................................................................................................................. 35 3.21 HNET:ROL – Role Segment .................................................................................................................................................... 36 3.22 HNET:TXA - Transaction Document Header Segment............................................................................................................ 37
January 9, 2004 Version 3.1 Page 3
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging 4 HL7 V2.4 Segment Definitions ................................................................................................................................... 39
4.1 HNET:ACC – Accident Segment ............................................................................................................................................. 39 4.2 HNET:ADJ - Adjustment Segment........................................................................................................................................... 40 4.3 HNET:CTD - Contact Data Segment ....................................................................................................................................... 41 4.4 HNET:ERR - Error Segment .................................................................................................................................................... 42 4.5 HNET: HDR - Secondary Header Segment............................................................................................................................. 43 4.6 HNET:IN1 - Insurance Segment .............................................................................................................................................. 44 4.7 HNET:IN2 – Insurance Additional Info Segment...................................................................................................................... 47 4.8 HNET:MSA - Message Acknowledgment Segment................................................................................................................. 49 4.9 HNET:MSH – Message Header Segment ............................................................................................................................... 50 4.10 HNET:PID - Person Identification Segment ............................................................................................................................. 53 4.11 HNET:QAK – Query Acknowledgement Segment ................................................................................................................... 55 4.12 HNET:QPD – Query Parameter Definition Segment ............................................................................................................... 55 4.13 HNET:RCP – Response Control Parameter Segment............................................................................................................. 56 4.14 HNET:SFT – SOFTWARE Segment........................................................................................................................................ 57
5 healthnetBC Z-Segments ........................................................................................................................................... 58 5.1 HNET:ZHD - healthnetBC Message Header (MSH) Extension Segment ................................................................................ 58 5.2 HNET:ZIA - healthnetBC Person Identification (PID) Extension Segment .............................................................................. 59 5.3 HNET:ZIC - healthnetBC Current Care Segment .................................................................................................................... 60 5.4 HNET:ZID - healthnetBC Waitlist Segment ............................................................................................................................. 60 5.5 HNET:ZIE - healthnetBC Assessment Segment...................................................................................................................... 61 5.6 HNET:ZIF - healthnetBC Patient Visit (PV1/2) Extension Segment ........................................................................................ 61 5.7 HNET:ZIG - healthnetBC Provider (PRD) Extension Segment................................................................................................ 61 5.8 HNET:ZIH - healthnetBC Insurance (IN1/2) Extension Segment ............................................................................................ 62 5.9 HNET:ZII – healthnetBC Consent Segment ............................................................................................................................ 64 5.10 HNET:ZIJ - healthnetBC Referral (RF1) Extension Segment .................................................................................................. 64 5.11 HNET:ZIK - healthnetBC Transaction Document Header (TXA) Extension Segment ............................................................. 64 5.12 HNET:ZIL - healthnetBC Primary Care Enrollment.................................................................................................................. 65 5.13 HNET:ZIN - healthnetBC Insurance Payment Extension......................................................................................................... 66 5.14 HNET:ZIO - healthnetBC Query Response Extension. ........................................................................................................... 67 5.15 HNET:ZLT - healthnetBC Lab Test Standard Segment........................................................................................................... 67 5.16 HNET:ZPY - healthnetBC Payee Information Segment........................................................................................................... 68 5.17 HNET:ZSG - healthnetBC Digital Signature Segment ............................................................................................................. 68 5.18 HNET:ZTL - healthnetBC Control Segment............................................................................................................................. 69
Page 4 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 MessagingCorrections and updates
January 9, 2004 Version 3.1 Page 5
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
1 General Information
This document and its companion volumes contain the Professional and Software Compliance Standards for HL7 Messaging between the BC Ministry of Health and external clients. These standards are used for the exchange of information with various business areas within the Ministry including: the Client Registry (patient/client demographics), MSP (beneficiary coverage), MSP Employer Services (enrolment of employees and dependants), Primary Health Care (patient rostering) and Continuing Care (client demographics and history).
1.1 Corrections and updates
Corrections and updates to this appendix can be found at the end of the document. A vertical line in the outside boarder denotes corrections within the document. 1
1.2 Who is the audience?
This document is intended for use by:
a) Software Support Organizations (SSO) who wish to develop software that is compliant with the BC standard for the exchange of business area data encompassing Client Registry, MSP, Primary Care, Continuing Care and other Ministry supported transactions.
b) Providers, administrators, health care professionals and MSP Benefits administrators (public and private employers) who are responsible for the implementation of compliant software in their organizations.
2 Overview
This appendix contains the definitions for all HL7 segments used by healthnetBC. It consists of HL7 segments adapted for use by healthnetBC as well as healthnetBC defined ‘Z’ segments.
healthnetBC uses messages based upon the HL7 v2.3. v2.3.1 and v2.4 standards. Segments from each version are listed in separate sections, as are the Z-segment definitions.
Page 6 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3 HL7 V2.3 Segment Definitions
3.1 HNET:AL1 - Allergy Segment
The AL1 segment contains person (patient/client) allergy information of various types. Most of this information will be derived from user-defined tables. Each AL1 segment describes a single person (patient/client) allergy. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “AL1”
1 Set ID - AL1 4 HL7:SI
2 Allergy Type 2 HL7:IS HL7:0127
3 Allergy Code / Mnemonic / Description
211 HNET:CE
4 Allergy Severity 2 HL7:IS HL7:0128
5 Allergy Reaction 15 HL7:ST
6 Identification Date 8 HL7:DT
3.2 HNET:BLG - Billing Segment
The BLG segment is used to provide billing information, on the ordered service, to the filling receiving system software. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “BLG”
1 When to Charge 28 HNET:CM8 HL7:0100
2 Charge Type 2 HL7:ID HNET:0122
3 Account ID 79 HNET:CK
January 9, 2004 Version 3.1 Page 7
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging 3.3 HNET:DG1 - Diagnosis Segment
The DG1 segment contains person (patient/client) diagnosis information of various types (for example admitting, primary, secondary, etc.). The segment must be repeated for multiple diagnosis. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “DG1”
1 Set ID - DG1 4 HL7:SI
2 Diagnosis Coding Method 2 HL7:ID HL7:0053
3 Diagnosis Code 211 HNET:CE HL7:0051
4 Diagnosis Description 40 HL7:ST
5 Diagnosis Date/Time 26 HNET:TS
6 Diagnosis Type 2 HL7:IS HNET:0052
7 Major Diagnostic Category 211 HNET:CE HL7:0118
8 Diagnostic Related Group 4 HL7:IS HL7:0055
9 DRG Approval Indicator 2 HL7:ID HL7:0136
10 DRG Grouper ReviewCode
2 HL7:IS HL7:0056
11 Outlier Type 211 HNET:CE HL7:0083
12 Outlier Days 3 HL7:NM
13 Outlier Cost 12 HL7:NM
14 Grouper Version And Type 4 HL7:ST
15 Diagnosis Priority 2 HL7:NM
Page 8 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
16 Diagnosing Clinician 257 0-4 HNET:XCN
17 Diagnosis Classification 3 HL7:IS HL7:0228
18 Confidential Indicator 1 HL7:ID HL7:0136
19 Attestation Date/Time 26 HNET:TS
3.4 HNET:ERR - Error Segment 2 Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len Data Type
HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ERR”
1 Error Code and Location 400 HNET:CM1 • Segment ID (3) – segment where error occurred
• Sequence (4) – occurrence of segment in transaction where error occurred
• Field Position (4) – field in segment where error occurred
• Code Identifying Error (386)
o Identifier on Code Identifying Error - Message Number; reference table HNET:9000 for valid values; ERR segments are returned in “E”, “W”, “I” order
o Text of Code Identifying Error (72) – Message Text
o Alternate Identifier of Code Identifying Error (15) – Alternate Message Number; must be logged if present in transaction
o Alternate Text of Code Identifying Error (255) – Alternate Message Text; must be logged if present in transaction
o Name of Alternate Coding System of Code Identifying Error (8) – name of system that generated Alternate Identifier of Code Identifying Error
January 9, 2004 Version 3.1 Page 9
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging 3.5 HNET:EVN – Event Reason
The EVN segment is used to communicate necessary trigger event information to receiving applications. Valid event types are listed in HNET table 0003 - Event type. Source: HL7 v2.3, modified by healthnetBC, July 2002.
Seq Element Name Len Rep # HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “EVN”
1 Event Type Code 3 HL7:ID HL7:0003
2 Recorded Date/Time 26 HNET:TS
3 Date/Time Planned Event 26 HNET:TS
4 Event Reason Code
3 HL7:IS HNET:0062
5 Operator ID 60 HNET:XCN HNET:0188
6 Event Occurred 26 HNET:TS
Page 10 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3.6 HNET:IN1 - Insurance Segment
The IN1 segment contains insurance policy information necessary to produce proper insurance bills. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “IN1”
1 Set ID - IN1 4 HL7:SI
2 Insurance Plan ID 211 HNET:CE HL7:0072
3 Insurance Company ID 135 0-4 HNET:CX
4 Insurance Company Name 179 0-4 HNET:XON
5 Insurance CompanyAddress
137 0-4 HNET:XAD
6 Insurance Co. Contact Person
114 0-4 HNET:XPN
7 Insurance Co. Phone Number
211 0-4 HNET:XTN
8 Group Number 12 HL7:ST
9 Group Name 179 0-4 HNET:XON
10 Insured’s Group Emp ID 135 0-4 HNET:CX
11 Insured’s Group Emp Name
179 0-4 HNET:XON
12 Plan Effective Date 8 HL7:DT
13 Plan Expiration Date 8 HL7:DT
14 Authorization Information 55 HNET:CM6
15 Plan Type 3 HL7:IS HNET:0086 11
16 Name of Insured 114 0-4 HNET:XPN
January 9, 2004 Version 3.1 Page 11
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
17 Insured’s Relationship to Patient
2 HL7:IS HNET:0063
18 Insured’s Date of Birth 26 HNET:TS
19 Insured’s Address 137 0-4 HNET:XAD
20 Assignment of Benefits 2 HL7:IS HL7:0135
21 Coordination of Benefits 2 HL7:IS HL7:0173
22 Coord. of Ben. Priority 2 HL7:ST
23 Notice of Admission Flag 2 HL7:ID HL7:0136
24 Notice of Admission Date 8 HL7:DT
25 Report of Eligibility Flag 2 HL7:ID HL7:0136
26 Report of Eligibility Date 8 HL7:DT
27 Release Information Code 2 HL7:IS HL7:0093
28 Pre-Admit Cert (PAC) 15 HL7:ST
29 Verification Date/Time 26 HNET:TS
30 Verification By 257 HNET:XCN
31 Type of Agreement Code 2 HL7:IS HL7:0098
32 Billing Status 2 HL7:IS HL7:0022
33 Lifetime Reserve Days 4 HL7:NM
34 Delay Before L.R. Day 4 HL7:NM
35 Company Plan Code 8 HL7:IS HL7:0042
36 Policy Number 15 HL7:ST
37 Policy Deductible 253 HNET:CP
38 Policy Limit - Amount 253 HNET:CP
39 Policy Limit - Days 4 HL7:NM
40 Room Rate - Semi-Private 253 HNET:CP
Page 12 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
41 Room Rate - Private 253 HNET:CP
42 Insured’s EmploymentStatus
211 HNET:CE HL7:0066
43 Insured’s Sex 1 HL7:IS HL7:0001
44 Insured’s EmployerAddress
137 0-4 HNET:XAD
45 Verification Status 2 HL7:IS HNET:9967 HL7 coded as data type ST without reference to any data definition table for list of values.
46 Prior Insurance Plan ID 8 HL7:IS HL7:0072
47 Coverage Type 3 HL7:IS HNET:0309
48 Handicap 2 HL7:IS HL7:0310
49 Insured’s ID Number 135 0-4 HNET:CX
January 9, 2004 Version 3.1 Page 13
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
3.7 HNET:MSA - Message Acknowledgment Segment
The MSA segment is used by receiving system software to acknowledge processing of an incoming transaction. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len Data Type
HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “MSA”
1 Acknowledgement Code 2 HL7:ID HL7:0008 Indication of success/failure of transaction (2) - valid values are “AA”, “AE”, “AR”; receiving system software will set “AA” for successful completion and “AE” for application errors; “AR” is set by the infrastructure for invalid transactions or transactions that cannot make it through to the receiving system.
2 Message Control ID 20 HL7:ST = Message Control ID on MSH
3 Text Message 80 HL7:ST Error code (8) + English message text (72) - Format of error code is AMMMnnnZ where A is an application identifier, MMM is a module or sub-system identifier, nnn is a sequential number and Z is either “E” = error, “W” = warning, “I" = Information
4 Expected SequenceNumber
15 HL7:NM
5 Delayed AcknowledgementType
1 HL7:ID HL7:0102
6 Error Condition 211 HNET:CE
Page 14 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3.8 HNET:MSH - Message Header Segment
The MSH segment defines the intent, source, destination, and some specifics of the syntax of the transaction. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “MSH”
1 Field Separator 1 HL7:ST “|”
2 Encoding Characters 4 HL7:ST “^~\&”
3 Sending Application 52 HNET:HD HNET:0361 Business application that originated the transaction
• Namespace ID (15) - required; healthnetBC assigned. 3
On response messages other than network “ACK” equals MSH.5 from input message.
4 Sending Facility 52 HNET:HD Sending Network Facility ID
• Namespace ID (20) - required; healthnetBC assigned
On response messages other than network “ACK” equals MSH.6 from input message.
5 Receiving Application 52 HNET:HD HNET:0361 4 Business application that will accept the transaction
• Namespace ID (15) - required; healthnetBC assigned 3
On response messages equals MSH.3 from input message.
6 Receiving Facility 52 HNET:HD Receiving Network Facility ID
• Namespace ID (20) - required; healthnetBC assigned
On response messages equals MSH.4 from input message.
7 Date/Time of Message 26 HNET:TS Date/Time transaction was sent from sending system (24) – YYYYMMDDHHMMSS[.S[S[S[S]]]][+/-ZZZZ] 5
8 Security 40 HL7:ST User id that uniquely identifies sending system user (20).
January 9, 2004 Version 3.1 Page 15
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
9 Message Type 7 HL7:ST
HNET:CM4 6
INPUT: Transaction Identification, used to uniquely identify transaction and segment structure
• Message Type (3) – required. Identifies the structure of the message. See HNET:0076 for valid values.
• Trigger Event (3) - Required. Identifies the business event. See HNET:0003 for valid values. Not supported on some healthnetBC messages. 7
OUTPUT: different value than input, also used to uniquely identify transaction and segment structure
• Message Type (3) - required, identifies the structure of the message. See HNET:0076 for valid values
• Trigger Event (3) – required. Identifies the business event.. See HNET:0003 for valid values. This component of MSH.9 is Not Supported on some healthnetBC messages. 7
Use “ZPN” to indicate Phase 2 (PharmaNet and Continuing Care) style transaction. 8
10 Message Control ID 20 HL7:ST INPUT: A number or other identifier that uniquely identifies the transaction. The receiving system echoes this ID back to the sending system in the Message Acknowledgement segment (MSA).
OUTPUT: The Message Control ID on output is also unique, but generated from the receiving system and so is not the same as the Message Control ID on input.
11 Processing ID 1 HL7:PT 9 HNET:0103 Processing Mode
• Processing ID (1) - required; valid values are “D”, “E”, “T”, “P”
• Processing Mode () – Not Supported.
12 Version ID 8 HL7:ID HL7:0104 HL7 version supported by healthnetBC (8).
Page 16 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
13 Sequence Number 15 HL7:NM
14 Continuation Pointer 180 HL7:ST
15 Accept AcknowledgementType
2 HL7:ID HL7:0155 Only valid for Deferred Processing Mode - Valid value is “AL”.
16 ApplicationAcknowledgement Type
2 HL7:ID HL7:0155 Only valid for Deferred Processing Mode - Valid values are “AL”, “NE”, ER”, “SU”.
17 Country Code 2 HL7:ID Not used/ignored
18 Character Set 6 0-3 HL7:ID HL7:0211
19 Principal Language of Message
211 HNET:CE
3.9 HNET:NK1 - Next of Kin/Associated Parties Segment
The NK1 segment contains information about the person’s (patient’s/client’s) other related parties such as spouses and siblings. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “NK1”
1 Set ID - NK1 4 HL7:SI
2 Name 114 0-1 HNET:XPN
3 Relationship 211 HNET:CE HNET:0063
4 Address 137 0-4 HNET:XAD
5 Phone Number 211 0-1 HNET:XTN
6 Business Phone Number 211 0-1 HNET:XTN
7 Contact Role 211 HNET:CE HL7:0131
January 9, 2004 Version 3.1 Page 17
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
8 Start Date 8 HL7:DT
9 End Date 8 HL7:DT
10 Next of Kin/Associated Parties Job Title
60 HL7:ST
11 Next of Kin/Associated Parties Job Code/Class
20 HL7:JCC
12 Next of Kin/Associated Parties Employee Number
135 HNET:CX
13 Organization Name 179 0-1 HNET:XON
14 Marital Status 2 HL7:IS HNET:0002
15 Sex 1 HL7:IS HL7:0001 Gender
16 Date/Time of Birth 26 HNET:TS
17 Living Dependency 2 0-1 HL7:IS HL7:0223
18 Ambulatory Status 2 0-1 HL7:IS HL7:0009
19 Citizenship 4 0-4 HL7:IS HL7:0171
20 Primary Language 211 HNET:CE HL7:0296
21 Living Arrangement 2 HL7:IS HL7:0220
22 Publicity Indicator 1 HL7:IS HL7:0215
23 Protection Indicator 1 HL7:ID HL7:0136
24 Student Indicator 2 HL7:IS HNET:0231
25 Religion 3 HL7:IS HL7:0006
26 Mother’s Maiden Name 114 HNET:XPN
27 Nationality 211 HNET:CE HL7:0212
28 Ethnic Group 3 HL7:IS HL7:0189
29 Contact Reason 211 0-3 HNET:CE
Page 18 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
30 Contact Person’s Name 114 0-3 HNET:XPN
31 Contact Person’sTelephone Number
211 0-3 HNET:XTN
32 Contact Person’s Address 137 0-3 HNET:XAD
33 Next of Kin/Associated Party’s Identifiers
135 0-4 HNET:CX
34 Job Status 2 HL7:IS HL7:0311
35 Race 1 HL7:IS HL7:0005
36 Handicap 2 HL7:IS HL7:0295
37 Contact Person Social Security Number
16 HL7:ST Ignored
January 9, 2004 Version 3.1 Page 19
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
3.10 HNET:NTE - Notes and Comments Segment
While HL7 defines notes to be of length 64K, this is not really useful to healthnetBC. Therefore, healthnetBC has redefined this to be 1K and if longer lengths are required, then multiple HNET:NTE segments are required in the transaction. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “NTE”
1 Set ID – NTE 4 HL7:SI
2 Source of Comment 8 HL7:ID
3 Comments 1024 0-8 HL7:FT Field length is smaller than HL7 length of 64K
Page 20 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3.11 HNET:OBR - Observation Request Segment
In the reporting of clinical data, the OBR serves as the report header. It identifies the observation set represented by the atomic observations which follow it. It includes the relevant ordering information when that applies. It contains many of the attributes that usually apply to all of the included observations. Source: HL7 v2.3, modified by healthnetBC for LTS, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “OBR”
1 Set ID – OBR 4 HL7:SI
2 Placer Order Number 73 HNET:EI
3 Filler Order Number 73 HNET:EI
4 Universal Service ID 211 HNET:CE BC Test Request Identifier - BCOTC (BC Order Test Code)
[reference table to be confirmed by the BCALP, access methods to be determined by healthnetBC]
5 Priority 2 HL7:ID
6 Requested Date/time 26 HNET:TS
7 Observation Date/Time 26 HNET:TS
8 Observation EndDate/Time
26 HNET:TS
9 Collection Volume 222 HNET:CQ
10 Collector Identifier 257 0-4 HNET:XCN
11 Specimen Action Code 1 HL7:ID HL7:0065
12 Danger Code 211 HNET:CE
13 Relevant Clinical Info. 300 HL7:ST
January 9, 2004 Version 3.1 Page 21
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
14 Specimen ReceivedDate/Time
26 HNET:TS
15 Specimen Source 1009 HNET:CM7 HL7:0070
16 Ordering Provider 257 0-1 HNET:XCN
17 Order Callback Phone Number
211 0-2 HNET:XTN
18 Placer field 1 60 HL7:ST
19 Placer field 2 60 HL7:ST
20 Filler Field 1 60 HL7:ST
21 Filler Field 2 60 HL7:ST
22 Results Rpt/Status Chng - Date/Time
26 HNET:TS
23 Charge to Practice 226 HNET:CM11
24 Diagnostic Serv Sect ID 10 HL7:ID HL7:0074
25 Result Status 1 HL7:ID HL7:0123
26 Parent Result 313 HNET:CM12
27 Quantity/Timing 661 0-5 HNET:TQ
28 Result Copies To 257 0-5 HNET:XCN
29 Parent 147 HNET:CM13
30 Transportation Mode 20 HL7:ID HL7:0124
31 Reason for Study 211 0-4 HNET:CE
32 Principal Result Interpreter 372 HNET:CM14
33 Assistant Result Interpreter 372 0-4 HNET:CM14 See endnote 10
34 Technician 372 0-4 HNET:CM14
35 Transcriptionist 372 0-4 HNET:CM14
Page 22 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
36 Scheduled Date/Time 26 HNET:TS
37 Number of Sample Containers
4 HL7:NM
38 Transport Logistics of Collected Sample
211 0-4 HNET:CE
39 Collector's Comment 211 0-4 HNET:CE
40 Transport ArrangementResponsibility
211 HNET:CE
41 Transport Arranged 30 HL7:ID HL7:0224
42 Escort Required 1 HL7:ID HL7:0225
43 Planned Patient TransportComment
211 0-4 HNET:CE
3.12 HNET:OBX - Observation Result Segment
The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a report. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “OBX”
1 Set ID - OBX 4 HL7:SI
2 Value Type 4 HL7:ID HNET:0125
3 Observation Identifier 211 HNET:CE LOINC Test Result Identifier
reference http://www.loinc.org/ for a list of valid LOINC codes
4 Observation Sub-ID 20 HL7:ST
January 9, 2004 Version 3.1 Page 23
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
5 Observation Value 64K 0-1 Various Length is 65536
6 Units 211 HNET:CE
7 References Range 10 HL7:ST
8 Abnormal Flags 5 0-5 HL7:ID HL7:0078
9 Probability 5 HL7:NM
10 Nature of Abnormal Test 2 0-3 HL7:ID HL7:0080
11 Observe Result Status 1 HL7:ID HNET:0085
12 Date Last Obs Normal Values
26 HNET:TS
13 User Defined Access Checks
20 HL7:ST
14 Date/Time of the Observation
26 HNET:TS
15 Producer's ID 211 HNET:CE
16 Responsible Observer 257 HNET:XCN
17 Observation Method 211 0-3 HNET:CE
Page 24 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3.13 HNET:ORC - Order Common Segment
The Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that are requested). The ORC segment is required in the Order (ORM) transaction. ORC is mandatory in Order Acknowledgment (ORR) transactions if an order detail segment is present, but is not required otherwise. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ORC”
1 Order Control 2 HNET:ID HNET:0119
2 Placer Order Number 73 HNET:EI
3 Filler Order Number 73 HNET:EI
4 Placer Group Number 73 HNET:EI
5 Order Status 2 HL7:ID HNET:0038
6 Response Flag 1 HL7:ID HL7:0121
7 Quantity/Timing 661 HNET:TQ
8 Parent 147 HNET:CM13
9 Date/Time of Transaction 26 HNET:TS
10 Entered By 257 HNET:XCN
11 Verified By 257 HNET:XCN
12 Ordering Provider 257 HNET:XCN
13 Enterer's Location 194 HNET:PL
14 Call Back Phone Number 211 0-2 HNET:XTN
15 Order Effective Date/Time 26 HNET:TS
16 Order Control Code Reason
211 HNET:CE
17 Entering Organization 211 HNET:CE
January 9, 2004 Version 3.1 Page 25
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
18 Entering Device 211 HNET:CE
19 Action By 257 HNET:XCN
3.14 HNET:PID - Person Identification Segment
Name and address data formats are adjusted to match Ministry data standards. This segment is a general purpose identification segment; additional extension segments have been created for application specific attributes to keep changes to this segment to a minimum. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “PID”
1 Set ID – PID 4 HL7:SI
2 External Patient ID 135 HNET:CX
3 Internal Patient ID 135 0-4 HNET:CX
4 Alternate Patient ID 135 0-4 HNET:CX
5 Patient Name 114 HNET:XPN
6 Mother's Maiden Name 114 HNET:XPN
7 Date of Birth 26 HNET:TS
8 Sex 1 HL7:IS HL7:0001 Gender
9 Patient Alias Name 114 0-10 HNET:XPN
10 Race 1 HL7:IS HL7:0005
11 Patient Address 137 0-4 HNET:XAD
Page 26 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
12 County Code 4 HL7:IS
13 Home Phone 211 0-2 HNET:XTN
14 Business Phone 211 0-2 HNET:XTN
15 Language 211 HNET:CE HL7:0296
16 Marital Status 1 HL7:IS HNET:0002 CE datatype in HL7
17 Religion 3 HL7:IS HL7:0006 CE datatype in HL7
18 Patient Account Number 135 HNET:CX
19 SSN Number - Patient 16 HL7:ST
20 Driver's License Number - Patient
45 HL7:DLN
21 Mother's Identifier 135 0-4 HNET:CX
22 Ethnic Group 1 HL7:IS HL7:0189 CE datatype in HL7
23 Birth Place 25 HL7:ST
24 Multiple Birth Indicator 1 HL7:ID HL7:0136
25 Birth Order 2 HL7:NM
26 Citizenship 4 0-4 HL7:IS HL7:0171 CE datatype in HL7
27 Veterans Military Status 211 HNET:CE HNET:0172
28 Nationality 211 HNET:CE
29 Patient Death Date and Time
26 HNET:TS
30 Patient Death Indicator 1 HL7:ID
January 9, 2004 Version 3.1 Page 27
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
3.15 HNET:PRD - Provider Data Segment
This segment is used to identify Providers of health care services. This segment is also used for referrals, in the identification of external referrals to an agency. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “PRD”
1 Role 211 0-4 HNET:CE HL7:0286
2 Provider Name 114 0-4 HNET:XPN
3 Provider Address 137 HNET:XAD
4 Provider Location 194 HNET:PL
5 Provider CommunicationInformation
211 0-4 HNET:XTN
6 Preferred Method of Contact
211 HNET:CE HL7:0185
7 Provider Identifiers 100 0-6 HNET:CM2
8 Effective Start Date of Role 8 HL7:DT
9 Effective End Date of Role 8 HL7:DT
Page 28 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
3.16 HNET:PV1 - Patient Visit Segment
This segment is used to communicate information on a visit specific basis. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “PV1”
1 Set ID - PV1 4 HL7:SI
2 Patient Class 1 HL7:IS HL7:0004
3 Assigned Patient Location 194 HNET:PL
4 Admission Type 2 HL7:IS HL7:0007
5 Preadmit Number 135 HNET:CX
6 Prior Patient Location 194 HNET:PL
7 Attending Doctor 257 0-3 HNET:XCN
8 Referring Doctor 257 0-3 HNET:XCN
9 Consulting Doctor 257 0-3 HNET:XCN
10 Hospital Service 3 HL7:IS HL7:0069
11 Temporary Location 194 HNET:PL
12 Preadmit Test Indicator 2 HL7:IS HL7:0087
13 Readmission Indicator 2 HL7:IS HL7:0092
14 Admit Source 3 HL7:IS HL7:0023
15 Ambulatory Status 2 0-4 HL7:IS HL7:0009
16 VIP Indicator 2 HL7:IS HL7:0099
17 Admitting Doctor 257 0-3 HNET:XCN
18 Patient Type 2 HL7:IS HL7:0018
January 9, 2004 Version 3.1 Page 29
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
19 Visit Number 135 HNET:CX
20 Financial Class 30 0-9 HNET:FC HNET:0064
21 Charge Price Indicator 2 HL7:IS HL7:0032
22 Courtesy Code 2 HL7:IS HL7:0045
23 Credit Rating 2 HL7:IS HL7:0046
24 Contract Code 2 0-1 HL7:IS HL7:0044
25 Contract Effective Date 8 0-1 HL7:DT
26 Contract Amount 12 0-1 HL7:NM
27 Contract Period 3 0-1 HL7:NM
28 Interest Code 2 HL7:IS HL7:0073
29 Transfer to Bad Debt Code 1 HL7:IS HL7:0110
30 Transfer to Bad Debt Date 8 HL7:DT
31 Bad Debt Agency Code 10 HL7:IS HL7:0021
32 Bad Debt Transfer Amount 12 HL7:NM
33 Bad Debt Recovery Amount
12 HL7:NM
34 Delete Account Indicator 1 HL7:IS HL7:0111
35 Delete Account Date 8 HL7:DT
36 Discharge Disposition 3 HL7:IS HNET:0112
37 Discharged to Location 37 HNET:CM3
38 Diet Type 2 HL7:IS HL7:0114
39 Servicing Facility 2 HL7:IS HL7:0115
40 Bed Status 1 HL7:IS HL7:0116
41 Account Status 2 HL7:IS HL7:0117
42 Pending Location 194 HNET:PL
Page 30 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
43 Prior Temporary Location 194 HNET:PL
44 Admit Date/Time 26 HNET:TS
45 Discharge Date/Time 26 HNET:TS
46 Current Patient Balance 12 HL7:NM
47 Total Charges 12 HL7:NM
48 Total Adjustment 12 HL7:NM
49 Total Payments 12 HL7:NM
50 Alternate Visit ID 135 HNET:CX
51 Visit Indicator 1 HL7:IS HL7:0326
52 Other Healthcare Provider 257 0-1 HNET:XCN
3.17 HNET:PV2 - Patient Visit - Additional Information Segment
This segment is used to communicate information on a visit specific basis and is a continuation of the PV1 segment. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “PV2”
1 Prior Pending Location 194 HNET:PL
2 Accommodation Code 211 HNET:CE HL7:0129
3 Admit Reason 211 HNET:CE
4 Transfer Reason 211 HNET:CE
5 Patient Valuables 25 0-4 HL7:ST
6 Patient Valuables Location 194 HNET:PL
January 9, 2004 Version 3.1 Page 31
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
7 Visit User Code 2 HL7:IS HL7:0130
8 Expected Admit Date 8 HL7:DT
9 Expected Discharge Date 8 HL7:DT
10 Estimated Length of Inpatient Stay
3 HL7:NM
11 Actual Length of Inpatient Stay
3 HL7:NM
12 Visit Description 50 HL7:ST
13 Referral Source Code 257 HNET:XCN
14 Previous Service Date 8 HL7:DT
15 Employment IllnessRelated Indicator
1 HL7:ID HL7:0136
16 Purge Status Code 1 HL7:IS HL7:0213
17 Purge Status Date 8 HL7:DT
18 Special Program Code 2 HL7:IS HL7:0214
19 Retention Indicator 1 HL7:ID HL7:0136
20 Expected Number of Insurance Plans
1 HL7:NM
21 Visit Publicity Code 1 HL7:IS HL7:0215
22 Visit Protection Indicator 1 HL7:ID HL7:0136
23 Clinic Organization Name 179 0-4 HNET:XON
24 Patient Status Code 2 HL7:IS HL7:0216
25 Visit Priority Code 1 HL7:IS HL7:0217
26 Previous Treatment Date 8 HL7:DT
27 Expected DischargeDisposition
2 HL7:IS HL7:0112
Page 32 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
28 Signature on File Date 8 HL7:DT
29 First Similar Illness Date 8 HL7:DT
30 Patient Charge Adjustment Code
3 HL7:IS HL7:0218
31 Recurring Service Code 2 HL7:IS HL7:0219
32 Billing Media Code 1 HL7:ID HL7:0136
33 Expected Surgery Date & Time
26 HNET:TS
34 Military Partnership Code 2 HL7:ID HL7:0136
35 Military Non-AvailabilityCode
2 HL7:ID HL7:0136
36 Newborn Baby Indicator 1 HL7:ID HL7:0136
37 Baby Detained Indicator 1 HL7:ID HL7:0136
3.18 HNET:QRD - Original-Style Query Definition Segment
This segment is used to define a query. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “QRD”
1 Query Date/Time 26 HNET:TS
2 Query Format Code 1 HL7:ID HL7:0106
3 Query Priority 1 HL7:ID HL7:0091
4 Query ID 10 HL7:ST
5 Deferred Response Type 1 HL7:ID HL7:0107
January 9, 2004 Version 3.1 Page 33
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
6 Deferred ResponseDate/Time
26 HNET:TS
7 Quantity Limited Request 222 HNET:CQ HL7:0126
8 Who Subject Filter 257 0-4 HNET:XCN
9 What Subject Filter 211 0-4 HNET:CE HNET:0048
10 What Department Data Code
211 0-4 HNET:CE
11 What Data Code Value Qual
20 0-4 HL7:ST
12 Query Results Level 1 HL7:ID HL7:0108
3.19 HNET:QRF - Original Style Query Filter Segment
The QRF segment is used to define an HL7 query. It defines items the sending system requires from data in the receiving system (e.g. show detail information for a person (patient/client)) and is therefore only included on input transactions. Source: HL7 v2.3, modified by healthnetBC, September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “QRF”
1 Where Subject Filter 20 0-4 HL7:ST
2 When Data Start Date/Time
26 HNET:TS
3 When Data End Date/Time 26 HNET:TS
4 What User Qualifier 60 HL7:ST
5 Other QRY Subject Filter 60 0-10 HL7:ST
6 Which Date/Time Qualifier 12 0-4 HL7:ID HL7:0156
Page 34 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
7 Which Date/Time Status Qualifier
12 0-4 HL7:ID HL7:0157
8 Date/Time SelectionQualifier
12 0-4 HL7:ID HL7:0158
9 When Quantity/TimingQualifier
661 HNET:TQ
3.20 HNET:RF1 - Referral Information Segment
This segment represents information that may be useful when sending referrals from the referring Provider to the referred-to Provider. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “RF1”
1 Referral Status 211 HNET:CE HNET:0283
2 Referral Priority 211 HNET:CE HL7:0280
3 Referral Type 211 HNET:CE HNET:0281
4 Referral Disposition 211 0-3 HNET:CE HL7:0282
5 Referral Category 211 HNET:CE HL7:0284
6 Originating ReferralIdentifier
73 HNET:EI
7 Effective Date 8 HL7:DT
8 Expiration Date 8 HL7:DT
9 Process Date 8 HL7:DT
January 9, 2004 Version 3.1 Page 35
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
10 Referral Reason 211 0-4 HNET:CE
11 External Referral Identifier 73 0-4 HNET:EI
3.21 HNET: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. Source: HL7 v2.3 modified by healthnetBC November 2002.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:SI “ROL”
1 Role Instance ID 73 HNET:EI
2 Action Code 2 HL7:ID HL7:0287
3 Role–ROL 211 HNET:CE HNET:0286
4 Role Person 637 0–4 HNET:XCN
5 Role Begin Date/Time 26 HNET:TS
6 Role End Date/Time 26 HNET:TS
7 Role Duration 211 HNET:CE
8 Role Action Reason 211 HNET:CE
Page 36 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.3 Segment Definitions 3.22 HNET:TXA - Transaction Document Header Segment
The TXA segment contains information specific to a transcribed document but does not include the text of the document. The transaction is created as a result of a Document Change Status. This information is used to update other healthcare systems to identify reports that are available in the transcription system. By maintaining the TXA transaction information in these systems, the information is available when constructing queries to the transcription system requesting the full document text. Source: HL7 v2.3, modified by healthnetBC, January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “QRF”
1 Set ID- Document 4 HL7:SI
2 Document Type 30 HL7:IS HL7:0270 Note: some transactions do not restrict values to the domain listed in HL7:0270.
3 Document ContentPresentation
2 HL7:ID HL7:0191
4 Activity Date/Time 26 HNET:TS
5 Primary Activity Provider Code/Name
257 HNET:XCN
6 Origination Date/Time 26 HNET:TS
7 Transcription Date/Time 26 HNET:TS
8 Edit Date/Time 26 0-8 HNET:TS
9 Originator Code/Name 257 HNET:XCN
10 Assigned DocumentAuthenticator
257 0-8 HNET:XCN
11 TranscriptionistCode/Name
257 HNET:XCN
12 Unique Document Number 73 HNET:EI
13 Parent Document Number 30 HL7:ST
January 9, 2004 Version 3.1 Page 37
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
14 Placer Order Number 73 0-4 HNET:EI
15 Filler Order Number 73 HNET:EI
16 Unique Document File Name
60 HL7:ST
17 Document CompletionStatus
2 HL7:ID HNET:0271
18 Document ConfidentialityStatus
2 HL7:ID HL7:0272
19 Document AvailabilityStatus
2 HL7:ID HL7:0273
20 Document Storage Status 2 HL7:ID HL7:0275
21 Document Change Reason 30 HL7:ST
22 Authentication Person,Time Stamp
284 0-4 HNET:CM5
23 Distributed Copies (Code and Name of Recipients)
257 0-4 HNET:XCN
Page 38 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4 HL7 V2.4 Segment Definitions
4.1 HNET:ACC – Accident Segment
The ACC segment contains patient information relative to an accident in which the patient has been involved. Source: HL7 v2.4 modified for HNET:ACC segment from Electronic Health Claim standard, Chiropractic & Physical Therapy, draft, version 2.0 October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “ACC”
1 Accident Date/Time 26 HNET:TS
2 Accident Code 211 HNET:CE HL7:0050
3 Accident Location 40 HL7:ST
4 Auto Accident State 211 HNET:CE HL7:0347
5 Accident Job Related Indicator
1 HL7:ID HL7:0136
6 Accident Death Indicator 1 HL7:ID HL7:0136
7 Entered By 637 HNET:XCN
8 Accident Description 80 HL7:ST
9 Brought In By 80 HL7:ST
10 Police Notified Indicator 1 HL7:ID HL7:0136
January 9, 2004 Version 3.1 Page 39
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
4.2 HNET:ADJ - Adjustment Segment
This segment describes any adjustment, monetary or not, to an Invoice Line Item, Payment/Remittance Advice or similar. Note that this is a custom segment, not found in the HL7 Standard. X12 REF: Same as CAS segment, with a few new fields. The ADJ segment was modified in later versions of the EHCS standard. Source: HNET:ADJ segment from Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “ADJ”
1 Adjustment Number 4 HL7:NM
2 Adjustment Category 4 HL7:ID HNET:9910
3 Adjustment Amount 254 0–5 HNET:CP
4 Adjustment Quantity 222 HNET:CQ HNET:9915
5 Adjustment Reason 211 0–5 HNET:CE HNET:9917
HNET:9924
If Adjustment Category = “PA”, then use HNET:9917
If Adjustment Category = “EA”, then use HNET:9924
If Adjustment Category = “IN”, then use HNET:9908
If Adjustment Category = “PR”, then use HNET:9907
6 Adjustment Description 250 HL7:ST
7 Original Value 250 HL7:ST Original value of data item noted in this adjustment
8 Substitute Value 250 0–10 HL7:ST Substituted value of data item noted in this adjustment
9 Adjustment Action 4 HL7:IS HNET:9904 Action requested of party that receives this adjustment
10 EOB Cross Reference 73 0–10 HNET:EI Cross reference to EOB number pertaining to this adjustment
Page 40 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions 4.3 HNET:CTD - Contact Data Segment
The CTD segment may identify any contact personnel associated with another segment (e.g. PID – patient). Source: HL7 v2.4 modified for HNET:CTD segment. From Electronic Health Claim standard, Chiropractic & Physical Therapy, draft v2.0, October 31, 2000..
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “CTD”
1 Role 211 0–4 HNET:CE HNET:0131
2 Contact Name 466 0–4 HNET:XPN
3 Contact Address 235 HNET:XAD
4 Contact Location 205 HNET:PL
5 Contact CommunicationInformation
211 0–10 HNET:XTN
6 Preferred Method of Contact
211 HNET:CE HL7:0185
7 Contact Identifiers 53 0–10 HNET:CM18
January 9, 2004 Version 3.1 Page 41
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
4.4 HNET:ERR - Error Segment Source: HL7 v2.4, modified by healthnetBC, September 2001
Seq Element Name Len Data Type
HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ERR”
1 Error Code and Location 400 HNET:CM1 • Segment ID (3) – segment where error occurred
• Sequence (4) – occurrence of segment in transaction where error occurred
• Field Position (4) – field in segment where error occurred
• Code Identifying Error (386)
o Identifier on Code Identifying Error - Message Number; reference table HNET:9000 for valid values; ERR segments are returned in “E”, “W”, “I” order
o Text of Code Identifying Error (72) – Message Text
o Alternate Identifier of Code Identifying Error (15) – Alternate Message Number; must be logged if present in transaction
o Alternate Text of Code Identifying Error (255) – Alternate Message Text; must be logged if present in transaction
o Name of Alternate Coding System of Code Identifying Error (8) – name of system that generated Alternate Identifier of Code Identifying Error
Page 42 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4.5 HNET: HDR - Secondary Header Segment
This segment contains additional information about the source of the transaction and is a logical extension of the MSH segment. Note that this is a custom segment, not found in the HL7 Standard, and very similar to HNET:ZHD which serves a comparable function. Source: HNET:HDR segment from Electronic Health Claim standard, Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “SUB”
1 Business Event Date/Time 26 HNET:TS Date/time business event occurred that was cause for transaction
2 Business Organization 183 HNET:XON Business organization that originated the transaction; Ministry of Health defined/assigned
3 Business User Group 30 HL7:ST Service Permission Group that user belongs to.
4 Security Keyword 20 HL7:ST
5 New Security Keyword 20 HL7:ST
6 Person (Patient/Client)Consent Received Indicator
1 HL7:ID HL7:0136
January 9, 2004 Version 3.1 Page 43
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
4.6 HNET:IN1 - Insurance Segment
The IN1 segment contains insurance policy information necessary to produce proper insurance bills. Source: HL7 v2.4, modified by healthnetBC, February 2001.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “IN1”
1 Set ID - IN1 4 HL7:SI
2 Insurance Plan ID 211 HNET:CE HL7:0072
3 Insurance Company ID 135 0-4 HNET:CX
4 Insurance Company Name 179 0-4 HNET:XON
5 Insurance CompanyAddress
137 0-4 HNET:XAD
6 Insurance Co. Contact Person
114 0-4 HNET:XPN
7 Insurance Co. Phone Number
211 0-4 HNET:XTN
8 Group Number 12 HL7:ST
9 Group Name 179 0-4 HNET:XON
10 Insured’s Group Emp ID 135 0-4 HNET:CX
11 Insured’s Group Emp Name
179 0-4 HNET:XON
12 Plan Effective Date 8 HL7:DT
13 Plan Expiration Date 8 HL7:DT
14 Authorization Information 55 HNET:CM6
15 Plan Type 3 HL7:IS HNET:0086 11 Previously HL7:0086
16 Name of Insured 114 0-4 HNET:XPN
Page 44 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
17 Insured’s Relationship to Patient
2 HL7:IS HNET:0063
18 Insured’s Date of Birth 26 HNET:TS
19 Insured’s Address 137 0-4 HNET:XAD
20 Assignment of Benefits 2 HL7:IS HL7:0135
21 Coordination of Benefits 2 HL7:IS HL7:0173
22 Coord. of Ben. Priority 2 HL7:ST
23 Notice of Admission Flag 2 HL7:ID HL7:0136
24 Notice of Admission Date 8 HL7:DT
25 Report of Eligibility Flag 2 HL7:ID HL7:0136
26 Report of Eligibility Date 8 HL7:DT
27 Release Information Code 2 HL7:IS HL7:0093
28 Pre-Admit Cert (PAC) 15 HL7:ST
29 Verification Date/Time 26 HNET:TS
30 Verification By 257 HNET:XCN
31 Type of Agreement Code 2 HL7:IS HL7:0098
32 Billing Status 2 HL7:IS HL7:0022
33 Lifetime Reserve Days 4 HL7:NM
34 Delay Before L.R. Day 4 HL7:NM
35 Company Plan Code 8 HL7:IS HL7:0042
36 Policy Number 15 HL7:ST
37 Policy Deductible 253 HNET:CP
38 Policy Limit - Amount 253 HNET:CP
39 Policy Limit - Days 4 HL7:NM
40 Room Rate - Semi-Private 253 HNET:CP
January 9, 2004 Version 3.1 Page 45
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
41 Room Rate - Private 253 HNET:CP
42 Insured’s EmploymentStatus
211 HNET:CE HL7:0066
43 Insured’s AdministrativeSex
1 HL7:IS HL7:0001
44 Insured’s EmployerAddress
137 0-4 HNET:XAD
45 Verification Status 2 HL7:IS HNET:9967 HL7 coded as data type ST without reference to any data definition table for list of values.
46 Prior Insurance Plan ID 8 HL7:IS HL7:0072
47 Coverage Type 3 HL7:IS HNET:0309
48 HL7:IS HL7:0310 Handicap 2
49 Insured’s ID Number 135 0-4 HNET:CX
Page 46 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4.7 HNET:IN2 – Insurance Additional Info Segment The IN2 segment contains additional insurance policy coverage and benefit information necessary for proper billing and reimbursement.
Source: HL7 v2.4. Adapted for Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “IN2”
1 Insured’s Employee ID 177 0–4 HNET:CX
2 Insured’s Social Security Number
11 HL7:ST
3 Insured’s Employer’sName and ID
637 0–4 HNET:XCN
4 Employer Information Data 1 HL7:IS HL7:0139
5 Mail Claim Party 1 0–4 HL7:IS HL7:0137
6 Medicare Health Ins Card Number
15 HL7:ST
7 Medicaid Case Name 466 0–4 HNET:XPN
8 Medicaid Case Number 15 HL7:ST
9 Military Sponsor Name 466 0–4 HNET:XPN
10 Military ID Number 20 HL7:ST
11 Dependent Of Military Recipient
211 HNET:CE HL7:0342
12 Military Organization 25 HL7:ST
13 Military Station 25 HL7:ST
14 Military Service 14 HL7:IS HL7:0140
15 Military Rank/Grade 2 HL7:IS HL7:0141
16 Military Status 3 HL7:IS HL7:0142
January 9, 2004 Version 3.1 Page 47
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
17 Military Retire Date 8 HL7:DT
18 Military Non–Avail Cert On File
1 HL7:ID HL7:0136
19 Baby Coverage 1 HL7:ID HL7:0136
20 Combine Baby Bill 1 HL7:ID HL7:0136
21 Blood Deductible 1 HL7:ST
22 Special Coverage Approval Name
466 0–4 HNET:XPN
23 Special Coverage Approval Title
30 HL7:ST
24 Non–Covered InsuranceCode
8 0–4 HL7:IS HL7:0143
25 Payor ID 177 0–4 HNET:CX
26 Payor Subscriber ID 177 0–4 HNET:CX
27 Eligibility Source 1 HL7:IS HL7:0144
28 Room CoverageType/Amount
28 0–4 HNET:CM15 HL7:0145/ HL7:0146
29 Policy Type/Amount 24 0–4 HNET:CM16 HL7:0147/ HL7:0193
30 Daily Deductible 26 HNET:CM17
31 Living Dependency 2 HL7:IS HL7:0223
32 Ambulatory Status 2 0–4 HL7:IS HL7:0009
Page 48 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4.8 HNET:MSA - Message Acknowledgment Segment
The MSA segment is used by receiving system software to acknowledge processing of an incoming transaction. Source: HL7 v2.4. Adapted for Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len Data Type
HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “MSA”
1 Acknowledgement Code 2 HL7:ID HL7:0008 Indication of success/failure of transaction (2) - valid values are “AA”, “AE”, “AR”; receiving system software will set “AA” for successful completion and “AE” for application errors; “AR” is set by the infrastructure for invalid transactions or transactions that cannot make it through to the receiving system.
2 Message Control ID 20 HL7:ST = Message Control ID on MSH
3 Text Message 80 HL7:ST Error code (8) + English message text (72) - Format of error code is AMMMnnnZ where A is an application identifier, MMM is a module or sub-system identifier, nnn is a sequential number and Z is either “E” = error, “W” = warning, “I" = Information
4 Expected SequenceNumber
15 HL7:NM
5 Delayed AcknowledgementType
1 HL7:ID HL7:0102
6 Error Condition 211 HNET:CE
January 9, 2004 Version 3.1 Page 49
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
4.9 HNET:MSH – Message Header Segment
The MSH segment defines the intent, source, destination, and some specifics of the syntax of the transaction. Source: HL7 v2.4. Adapted for Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “MSH”
1 Field Separator 1 HL7:ST “|”
2 Encoding Characters 4 HL7:ST “^~\&”
3 Sending Application 52 HNET:HD HNET:0361 Business application that originated the transaction
• Namespace ID (15) - required; healthnetBC assigned. 12
On response messages other than network “ACK” equals MSH.5 from input message.
4 Sending Facility 52 HNET:HD HNET:0362 Sending Network Facility ID
• Namespace ID (20) - required; healthnetBC assigned
On response messages other than network “ACK” equals MSH.6 from input message.
5 Receiving Application 52 HNET:HD HNET:0361 Business application that will accept the transaction
• Namespace ID (15) - required; healthnetBC assigned
On response messages equals MSH.3 from input message.
6 Receiving Facility 52 HNET:HD HNET:0362 Receiving Network Facility ID
• Namespace ID (20) - required; healthnetBC assigned
On response messages equals MSH.4 from input message.
7 Date/Time of Message 26 HNET:TS Date/Time transaction was sent from sending system (24) – YYYYMMDDHHMMSS[.S[S[S[S]]]] [+/-ZZZZ] 5
8 Security 40 HL7:ST User id that uniquely identifies sending system user (20).
Page 50 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
9 Message Type 15 HNET:CM4 13
INPUT: Transaction Identification, used to uniquely identify transaction and segment structure
• Message Type (3) – required. Identifies the structure of the message. See HNET:0076 for valid values.
• Trigger Event (3) - Required. Identifies the business event. See HNET:0003 for valid values. Not supported on some healthnetBC messages. 7
• Message Structure – Not Supported 13
OUTPUT: different value than input, also used to uniquely identify transaction and segment structure
• Message Type (3) - required, identifies the structure of the message. See HNET:0076 for valid values
• Trigger Event (3) – required. Identifies the business event. See HNET:0003 for valid values. This component of MSH.9 is Not Supported on some healthnetBC messages. 7
• Message Structure – Not Supported 13
Use “ZPN” to indicate Phase 2 (PharmaNet and Continuing Care) style transaction. 14
10 Message Control ID 20 HL7:ST INPUT: A number or other identifier that uniquely identifies the transaction. The receiving system echoes this ID back to the sending system in the Message Acknowledgement segment (MSA).
OUTPUT: The Message Control ID on output is also unique, but generated from the receiving system and so is not the same as the Message Control ID on input.
January 9, 2004 Version 3.1 Page 51
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
11 Processing ID 1 HL7:PT HNET:0103 Processing Mode
• Processing ID (1) - required; valid values are “D”, “E”, “T”, “P”
• Processing Mode () – Not Supported.
12 Version ID 432 HNET:VID HL7:0104 HL7 version supported by healthnetBC (8).
• Version ID (8) – required.
• Internationalization Code (211) – Not Supported
• Internal Version ID (211) – Not Supported.
13 Sequence Number 15 HL7:NM
14 Continuation Pointer 180 HL7:ST
15 Accept AcknowledgementType
2 HL7:ID HL7:0155 Only valid for Deferred Processing Mode - Valid value is “AL”.
16 ApplicationAcknowledgement Type
2 HL7:ID HL7:0155 Only valid for Deferred Processing Mode - Valid values are “AL”, “NE”, ER”, “SU”.
17 Country Code 2 HL7:ID Not used/ignored
18 Character Set 6 0-3 HL7:ID HL7:0211
19 Principal Language of Message
211 HNET:CE ISO:639-2
20 Alternate Character Set Handling Scheme
20 HL7:ID HL7:0356
21 Conformance StatementID
128 0-10 HL7:ID HL7:0449 One or more conformance identifiers that relate to healthnetBC implementation. Field length increased from HL7 standard.
Page 52 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions 4.10 HNET:PID - Person Identification Segment
Name and address data formats are adjusted to match Ministry data standards. This segment is a general purpose identification segment; additional extension segments have been created for application specific attributes to keep changes to this segment to a minimum. Source: HL7 v2.4, modified by healthnetBC, February 2001.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “PID”
1 Set ID – PID 4 HL7:SI
2 External Patient ID 135 HNET:CX
3 Patient Identifier List 15 135 0-4 HNET:CX
4 Alternate Patient ID 135 0-4 HNET:CX
5 Patient Name 114 HNET:XPN
6 Mother's Maiden Name 114 HNET:XPN
7 Date of Birth 26 HNET:TS
8 Administrative Sex 1 HL7:IS HL7:0001 Gender
9 Patient Alias Name 114 0-10 HNET:XPN
10 Race 1 HL7:IS HL7:0005
11 Patient Address 137 0-4 HNET:XAD
12 County Code 4 HL7:IS
13 Home Phone 211 0-2 HNET:XTN
14 Business Phone 211 0-2 HNET:XTN
15 Primary Language 211 HNET:CE HL7:0296 Usu. ISO:639-2
16 Marital Status 1 HL7:IS HNET:0002 CE datatype in HL7
17 Religion 3 HL7:IS HL7:0006 CE datatype in HL7
18 Patient Account Number 135 HNET:CX
January 9, 2004 Version 3.1 Page 53
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
19 SSN Number - Patient 16 HL7:ST
20 Driver's License Number - Patient
45 HL7:DLN
21 Mother's Identifier 135 0-4 HNET:CX
22 Ethnic Group 1 HL7:IS HL7:0189 CE datatype in HL7
23 Birth Place 25 HL7:ST
24 Multiple Birth Indicator 1 HL7:ID HL7:0136
25 Birth Order 2 HL7:NM
26 Citizenship 4 0-4 HL7:IS HL7:0171 CE datatype in HL7
27 Veterans Military Status 211 HNET:CE HNET:0172
28 Nationality 211 HNET:CE
29 Patient Death Date and Time
26 HNET:TS
30 Patient Death Indicator 1 HL7:ID
31 Identity Unknown Indicator 1 HL7:ID HL7:0136
32 Identity Reliability Code 2 0-4 HL7:IS HL7:0445
33 Last Update Date/Time 26 HNET:TS
34 Last Update Facility 52 HNET:HD
35 Species Code 211 HNET:CE HL7:0446 Veterinary Medicine
36 Breed Code 211 HNET:CE HL7:0447 Veterinary Medicine
37 Strain 4 HL7:ST Veterinary Medicine
38 Production Class Code 211 0-2 HNET:CE HL7:0429 Veterinary Medicine
Page 54 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4.11 HNET:QAK – Query Acknowledgement Segment
The QAK segment contains information sent with responses to a query. Source: HL7 v2.4. Adapted for Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “QAK”
1 Query Tag 20 HL7:ST Unique query tag
2 Query Response Status 2 HL7:ID HL7:0208
3 Message Query Name 211 HNET:CE HNET:0003 Use Event Type table for query names
4 Hit Count 32 HNET:HCT HCT datatype includes subcomponents for count of this payload and hits remaining.
5 This Payload 10 HL7:NM Not Used
6 Hits Remaining 10 HL7:NM Not Used
4.12 HNET:QPD – Query Parameter Definition Segment
This segment defines the parameter(s) for a query. Source: HL7 v2.4. Adapted for Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “QPD”
1 Message Query Name 211 HNET:CE HNET:0471 16
2 Query Tag 20 HL7:ST Unique query tag
3 User Parameters varies Various Field positions 3, 4, etc. are the actual parameters. Refer to the Query Transaction for the list & position of parameters for the query
January 9, 2004 Version 3.1 Page 55
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging 4.13 HNET:RCP – Response Control Parameter Segment
The RCP segment is used to restrict the amount of data that should be returned in response to query. Source: HL7 v2.4. Adapted and amended from Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000. 17
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:ST “RCP”
1 Query Priority 1 HL7:ID HL7:0091
2 Quantity Limited Request 222 HNET:CQ HL7:0126
3 Response Modalit y 211 HNET:CE HN7:0394
4 Execution and Delivery Time
26 HNET:TS
5 Modify Indicator 1 HL7:ID HL7:0395
6 Sort-by Field 512 HL7:SRT
7 Segment Group Inclusion 256 HL7:ID HL7:0391
Page 56 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging HL7 V2.4 Segment Definitions
4.14 HNET:SFT – SOFTWARE Segment
Added by healthnetBC. This segment provides additional information about a software product used as a Sending Application or Receiving Application. Note that this is a custom segment, not found in the HL7 Standard. Source: Electronic Health Claim standard (EHCS), Chiropractic & Physical Therapy, draft, version 2.0, October 31, 2000.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
1 Standard Version Number 15 HL7:ST Version of this standard that the transaction adheres to
Note: does not use HNET:VID data type due to conflicts with HL7:0104 table values for this field
2 Standard Name 40 HL7:ST Text description of the Standard being used (e.g. “EHCS”, “NECST”)
3 Software VendorOrganization
183 HNET:XON Organization identification information for the software vendor that created this transaction
4 Software Version Number 15 HL7: ST Latest software version number of sending ssystem that has been compliance tested and accepted. e.g “4.10”.
Note: does not use HNET:VID data type due to conflicts with HL7:0104 table values for this field
5 Software Product Name 20 HL7:ST Name of software product that submitted the transaction
Software ProductInformation
20 HL7:ST Software identification information which can be supplied by a software vendor with their transaction
7 Software Install Date 26 HNET:TS Date submitting software was installed
6
January 9, 2004 Version 3.1 Page 57
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
5 healthnetBC Z-Segments
5.1 HNET:ZHD - healthnetBC Message Header (MSH) Extension Segment
The ZHD segment extends the data elements of the MSH segment and are necessary to properly identify source of transaction, organizations, service permission groups (was business user groups) and keyword management, etc. Source: healthnetBC, September 1999
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
Segment ID 3 HL7:SI “ZHD”
Business Event Date/Time 26 HNET:TS Date/time business event occurred that was cause for transaction
Business Organization 179 HNET:XON Business organization that originated the transaction; Ministry of Health defined/assigned
Business User Group 30 HL7:ST Service Permission Group that user belongs to 18
4 Security Keyword 20 HL7:ST
5 New Security Keyword 20 HL7:ST
6 HL7:ID Person (Patient/Client)Consent Received Indicator
1 HL7:0136
Software Version Number Latest software version number of sending system that has been compliance tested and accepted. e.g. “4.10”.
-
1
2
3
7 15 HL7: ST
Page 58 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments
5.2 HNET:ZIA - healthnetBC Person Identification (PID) Extension Segment
The ZIA segment extends the information contained in the PID segment. Source: healthnetBC. September 1999.
Seq Element Name Len RP/# Table
Segment ID 3 HL7:SI “ZIA”
1 Client Research Code 1 0-3 HL7:ST Provider defined
2 BC Residency Date 8 HL7:DT Date person (patient/client) became a resident of BC.
3 Family Unit Size 2 HL7:NM Number of persons in the family considered to be dependents.
4 Last Change Timestamp 26 HNET:TS Date of last change to person (patient/client) information.
5 Last Change Id 20 HL7:ST
6 HL7:DT Latest AssessmentEffective Date
8 Effective date of most recent assessment.
Adult Day Care Count Identifies number of open Adult Day Care services.
Homemaker Care Count 1 HL7:NM Identifies number of open Home Support services.
9 Group Home Count 1 HL7:NM Identifies number of open Group Home Services.
10 Home Nursing Care Indicator
1 HL7:ID HL7:0136 Indicates if person (patient/client) is currently receiving Home Nursing Care services.
11 HL7:ID Physiotherapy Indicator 1 HL7:0136 Indicates if person (patient/client) is currently receiving Physiotherapy services.
Occupational TherapyIndicator
1 HL7:ID HL7:0136 Indicates if person (patient/client) is currently receiving Occupational Therapy services.
13 PHN Verified Flag 1 HL7:ID HL7:0136 Flag to indicate the reliability of the PHN. If PHN for person (patient/client) and
1) surname, birth date, sex = client registry (CR) or
2) surname, initial, sex = CR or
3) surname, initial, birth date = CR, then set to Y.
HL7 Data Type healthnetBC Usage
-
7 1 HL7:NM
8
12
January 9, 2004 Version 3.1 Page 59
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
If no PHN, or 1), 2) or 3) is false, set to N.
14 BC Residency Flag 1 HL7:IS HNET:9998
15 Extended Person Name 162 0-10 HNET:ZPN Based on HNET:XPN with additions
16 Extended Address 532 0-10 HNET:ZAD Extended HNET:XAD to include additional person (patient/client) address information
17 Extended TelephoneNumber
233 0-10 HNET:ZTN Extended HNET:XTN to include additional telephone information
18 Patient Display Address 50 HL7:ST Address suitable for display, typically includes most address components (e.g. number, street name, street type, city)
19 Birth Location 137 HNET:XAD Consists of Country, State or Province, City (town)
20 Death Location 137 HNET:XAD Consists of Country, State or Province, City (town)
21 Death Event Source 4 HL7:ST HNET:9951 Individual or agency who is the source for death event information
22 Set ID – ZIA 4 HL7:SI
23 HL7:0136 If set to “Y” an address that does not pass the validation check will still be stored; if set to “N” an address that cannot be validated will be returned to the calling system for user intervention
Address ValidationOverride Indicator
1 HL7:ID
24 Immigration or Visa Code 1 HL7:ID HNET:9932 Code indicating the person’s (patient’s/client’s) right to reside in Canada
25 Prior Residence Code 2 HL7:ID HNET:9931
5.3
Source: healthnetBC. 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC
HNET:ZIC - healthnetBC Current Care SegmentSource: healthnetBC. 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC.
5.4 HNET:ZID - healthnetBC Waitlist Segment
Page 60 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments 5.5 HNET:ZIE - healthnetBC Assessment Segment
5.7 HNET:ZIG - healthnetBC Provider (PRD) Extension Segment
The ZIG segment contains Provider information not found on the HL7 PRD segment.
Source: healthnetBC. 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC.
5.6 HNET:ZIF - healthnetBC Patient Visit (PV1/2) Extension Segment
The ZIF segment contains data for a person’s (patient’s/client’s) visit (also known as Case, Service Authorization and/or Care Episode). It is an extension to the PV1/2 HL7 segments. Source: healthnetBC. 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC.
Source: healthnetBC. July 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC
January 9, 2004 Version 3.1 Page 61
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
5.8 HNET:ZIH - healthnetBC Insurance (IN1/2) Extension Segment
This segment contains insurance information and extends the IN1/2 HL7 segments.
It also contains information in ZIH.1 – ZIH.12 from Ottawa on GIS (Guaranteed Income Supplement) persons (patients/clients) and other data used by Continuing Care to determine how much a CC person (patient/client) pays for services. Source: healthnetBC. 1998
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- HL7:SI Segment ID 3 “ZIH”
IMS Start Date 8 Date when GIS recipient information was first loaded into the IMS system from GIS tape.
YYYYMM only (no day of month).
2 Latest GIS Payment Date 8 HL7:DT Specifies which year/month recipient received his/her most recent GIS cheque.
YYYYMM only (no day of month).
3 Final GIS Payment Date 8 Date on which GIS recipient received his/her final GIS cheque and is set when GIS Account Status Code on ZIH is set to “deceased”.
HL7:DT
YYYYMM only (no day of month).
4 GIS Recipient Entitlement/Renewal Date
8 HL7:ST Date on which recipient becomes eligible to receive GIS.
YYYYMM only (no day of month).
5 GIS Marital Status 1 HL7:IS HNET:9966 Marital status for GIS recipient (as known by Ottawa). Note different value set than HNET:0002 for marital status codes.
GIS Account Status Code 1 HNET:9967 GIS account status code can be active, unknown or deceased.
GIS Address 30 0-5 GIS unstructured address. Repeats 1-3 are 30 characters, 4 is 16 characters and 5 is 6 characters. Exact format of GIS address is not pre-determined.
1 HL7:DT
6 HL7:IS
7 HL7:ST
Page 62 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
8 Verified GIS Flag 1 HL7:ID HL7:0136 Indicates if the GIS Flag in Continuing Care has been verified using the GIS data that is received monthly from Ottawa.
9 Accommodation Rate Code 1 HL7:IS HNET:9986 Person’s (patient’s/client’s) accommodation rate (subsidy) code. Used to derive Facility User Fee on ZIH.
10 Accommodation RateEffective Date
8 HL7:DT Effective date of person’s (patient’s/client’s) Accommodation Rate Code on ZIH.
11 CCD Set Code 1 HL7:IS HNET:9985 Specifies if CCD Finance sets and controls person’s (patient’s/client’s) accommodation rate (subsidy) updates. This is set to “Y” by the Rate Verification Process or when Head Office Staff set the Accommodation Rate Code, otherwise it is blank.
Facility User Fee 6 Generated field, format 999.99. Indicates the facility daily user fee payable by the person (patient/client) - based on Accommodation Rate Code on ZIH.
Agreement Class 2 HNET:9947 Beneficiary Coverage Agreement Class
Agreement Type 4 HL7:ST HNET:9946 Role of covered party in the agreement, or of a third party in a recognized relationship to the covered party.
End Reason 4 HNET:9945 Beneficiary Coverage End Reason. Reason supplied by an insurer for no longer providing coverage
End Date 8 Exclusion Period End Date
Client Instruction 255
Set ID – ZIH 4 This field contains a number that uniquely identifies the information represented by this segment in this transaction for the purposes of addition, change or deletion.
Payer Cancel Reason 1 HNET:9942 Reasons supplied by employer for ending premium contributions for an employee.
Display Cancel Reason 1 HNET:9934 Simplified eligibility status code, suitable for terminal display.
12 HL7:NM
13 HL7:IS
14
15 HL7:ST
16 HL7:DT
17 HL7:ST
18 HL7:SI
19 HL7:IS
20 HL7:IS
January 9, 2004 Version 3.1 Page 63
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
5.9 HNET:ZII – healthnetBC Consent Segment Source: healthnetBC. July 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC.
5.10 HNET:ZIJ - healthnetBC Referral (RF1) Extension Segment
The ZIJ segment contains data for a referral. It is an extension to the RF1 HL7 segment. Source: healthnetBC. July 1998. No longer used. This segment was developed for Continuing Care messages that are no longer in use. Not supported by healthnetBC healthnetBC
5.11 HNET:ZIK - healthnetBC Transaction Document Header (TXA) Extension Segment
The ZIK segment contains data for a document. It is an extension to the TXA HL7 segment. Source: healthnetBC. September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ZIK”
1 Assigning Facility 52 HNET:HD Agency which assigned the document, within a jurisdiction
2 Document Medium 5 HNET:IS HNET:9948
3 Original DocumentIndicator
1 HNET:IS HNET:9940
4 Repeating group of arguments used to describe documents Document Argument 91 0-
50
HNET:ZRG
5 Document Purpose 20 HNET:IS no longer used
6 Set ID - ZIK 4 HL7:SI
Page 64 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments 5.12 HNET:ZIL - healthnetBC Primary Care Enrollment
The ZIL segment extends the data elements contained in IN1/2 and ZIH and provides information about enrollment in a Primary Health Care program. Source: healthnetBC, June 2002.
Seq Element Name Len HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ZIL”
1 Agreement Type 4 HL7:ST
2 Effective Date 8 HL7:DT PHC Registration effective date.
3 Expiration Date 8 HL7:DT PHC Registration end date
4 HL7:CE Start Reason HNET:9952 Reason assigned for Registration segment start
5 End Reason HL7:CE HNET:9953 Reason assigned by enrollment agent for ending PHC Registration
6 Cancel Reason HL7:CE HNET:9954 Reason assigned for PHC De-Registration by plan administrator.
7 PHC Administrative Code HL7:CE HNET:9955 PHC special needs code
Override Reason HL7:CE HNET:9956;HNET:9957
Reason assigned for overriding a pending registration event (registration or de-registration
RP/#
8
January 9, 2004 Version 3.1 Page 65
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
5.13 HNET:ZIN - healthnetBC Insurance Payment Extension
The ZIN segment contains information on payment of insurance premiums. Source: healthnetBC, July 2002.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
- Segment ID 3 HL7:SI “ZIN”
1 Premium Payment Start Date
8 HL7:DT Start date for the party paying all or part of the premiums for the beneficiary’s plan.
2 Premium Payment End Date
8 HL7:DT End date for the party paying all or part of the premiums for the beneficiary’s plan
8 HL7:DT Start date on which the party paying part or all of the insured’s premiums resumes premium payments on a previously cancelled contract.
4 Segment Action Code HL7:ID HL7:0206 Indicates the action to be carried out using the contents of this segment (add, update, delete...)
3 Premium Payment Renewal Date
Page 66 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments
5.14 HNET:ZIO - healthnetBC Query Response Extension.
The ZIO segment contains information needed for routing a query response to the requestor via external (non-HL7) methods. Source: healthnetBC. June 2002.
Seq Element Name Len RP/# Table healthnetBC Usage
- Segment ID “ZIO”
1 Response Method 6 HL7:IS HNET: 9959 Identifies the method by which query response (output) will be returned to the requestor
2 Electronic Delivery Account 8 HL7:ST Identifies a system account containing an electronic delivery address
3 Delivery Format 6 HL7:IS HL7:0191 Format in which the query response (output) is returned to the requestor.
HL7 Data Type
5.15 HNET:ZLT - healthnetBC Lab Test Standard Segment
The ZLT segment extends the data elements contained in the ORC/OBR pair (lab test). Source: healthnetBC. January 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
Segment ID 3 “ZLT”
Ordering Provider Delivery Mechanism
15 Application ID where test results are to be pushed; may be blank if Ordering Provider cannot receive pushed test results or wishes test results pushed to default Application ID by LIS
2 HL7:ID AcknowledgementIndicator
1 HL7:0136
Restrict Results Indicator 1 HL7:0136
- HL7:SI
1 HL7:ST
3 HL7:ID
January 9, 2004 Version 3.1 Page 67
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging 5.16 HNET:ZPY - healthnetBC Payee Information Segment
The ZPY segment is used to define payee information. Source: healthnetBC. June 2002. Based on HNET:PYE segment developed for the draft ELECTRONIC HEALTH CLAIMS Standard (Chiro/Physio) version 3.0, May 15, 2001.
Seq Len RP/# HL7 Data Type Table healthnetBC Usage
– Segment ID 3 HL7:SI “ZPY”
1 Set ID – ZPY 4 HL7:SI
2 Payee Type 6 HL7:ID HNET:9927
3 Payee Relationship to Invoice
2 HNET:9919 HL7:ID
4 Payee Identification List 183 0-5 HNET:XON
5 0–4 Person Name 114 HNET:XPN
6 Payee Address 0–4 137 HNET:XAD
Element Name
5.17 HNET:ZSG - healthnetBC Digital Signature Segment
The ZSG segment contains digital signature/certificate information. Source: healthnetBC. September 1999.
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
Segment ID 3 HL7:SI
Signatory Level 1 HL7:IS HNET:9949 Indicates the authority level of the application generating the digital signature.
Signature Date/Time 26 HNET:TS
3 Certificate Format 8 HL7:ST Code indicating the format of the digital certificate (which defines the signature format/algorithm). E.g. “X509V2H1” is X.509 V3 format with healthnetBC non-critical extension (signatory level).
- “ZSG”
1
2
Page 68 Version 3.1 January 9, 2004
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments
Seq Element Name Len RP/# HL7 Data Type Table healthnetBC Usage
4 Digital Certificate 2048 HL7:ST Actual digital certificate in hexadecimal notation (as it includes binary data) using the standard HL7 escape sequence |Xdd…dd\.
5 Digital Signature 2048 HL7:ST Actual digital signature in hexadecimal notation (as it includes binary data) using the standard HL7 escape sequence |Xdd…dd\.
The entire preceding HL7 transaction (including the digital certificate and delimiters) are included in the hash function for the digital signature, This field/segment is normally followed by two <cr><cr> characters to indicate end of segment and end of transaction.
5.18 HNET:ZTL - healthnetBC Control Segment Source healthnetBC. September 1999.
Seq Element Name Len RP/# HL7 Data Type Table
Segment ID 3 HL7:SI
1 Transaction SegmentCount
222 HNET:CQ HL7:0126 Count of response segments returned on search transactions
Duplicate OverrideIndicator
1 HL7:ID HL7:0136 Used to allow duplicate names on the Health Registry database
healthnetBC Usage
- “ZTL”
2
January 9, 2004 Version 3.1 Page 69
Appendix A - Fixed Length Segment Definitions Professional and Software Compliance Standards for HL7 Messaging
Page 70 Version 3.1 January 9, 2004
!
Document History
DOCUMENT MODIFICATION HISTORY
Version Release Date Description 2.0 September 1999 Original single document
3.0
• The following Z-segments have been added: ZIL, ZIN, ZIO, ZPY.
November 21, 2003 • Revised format. New section added for HL7 v2.4 segment definitions.
• The following segments are marked as no longer supported: ZIC, ZID, ZIE, ZIF, ZIG, ZII, ZIJ.
• V2.3 segments added: EVN, ROL
• V2.4 segments added: ACC, ADJ, CTD, ERR, HDR, IN1, IN2, MSA, MSH, PID QAK, QPD, RCP, SFT.
• Corrections and changes as described in endnotes.
3.1 January 9, 2004 • Added clarification to v2.4 MSH segment definition for MSH.9 field. No functional change.
• Added clarification for MSH.7. Millisecond and gmt offset components are optional on healthnetBC interface. This requirement is less stringent than some previously published message specifications in which these components are required, hence should not effect existing implementations.
• Corrected PID.3 field name.
• Table reference changed for IN1.15 - Plan Type
• Table reference corrected for QAK.3, QPD.1 Corrections and Update Notes 1 02/Nov/27 – example of correction 2 ERR.1 usage notes expanded to fully describe the complex datatype. No change to previous definition. 3 Note that healthnetBC supported length for this component is less than that permitted for the HD datatype used by this field. 4 Reference Table added per HL7 2.3.1. In HRS v2.0 was published as separate reference in Chapter 4, section 4.1.1.6
Professional and Software Compliance Standards Appendix A - Fixed Length Segment Definitions for HL7 Messaging healthnetBC Z-Segments
January 9, 2004 Version 3.1 Page 71
5 Version 3.1. For HNI implementation of this field the milliseconds and gmt offset components are optional. 6 Correction of datatype to CM, from ST. Component structure unchanged. Note that prior to June 2002 the second component , Trigger Event, was not supported in healthnetBC messages. Hence the use of simple STring datatype did not impact implementation of this field. The correct structure is: <ID datatype>^<ID datatype>. In more recent HL7 nomenclature this variant of the CM (composite) datatype is referenced as CM4. 7 The HL7 required MSH.9.2 Trigger Event code is not supported on earlier healthnetBC messages. 8 The ZPN message type referred to here from the version 2.0 specifications was not implemented. 9 Previously shown as ID datatype to reflect the use of only the first component of the complex PT datatype. Note that the second component of MSH.11, “processing mode”, is not supported in healthnetBC messages. 10 OBR 33, 34, 35 – corrected field length typo (was 372200) 11 Replaces user-defined HL7 table HL7:0086. 12 Note that healthnetBC supported length for this component is less than that permitted for the HD datatype used by this field. 13 healthnetBC uses CM4 datatype for MSH.9. The 3rd component of the HL7 CM datatype (Message Structure) is not supported. 14 The ZPN message type referred to here from the version 2.0 specifications was not implemented. 15 Field name corrected. Formerly Internal Patient ID. Field name changed in HL7 v2.3.1 at the same time PID.2 was deprecated. 16 Version 3.1. Corrected table reference. Previously listed as HNET:0003, should be HNET:0471. 17 RCP segment contains corrections from previous source documents. This version is healthnetBC implementation of HL7 v2.4 definition. 18 Business User Group is now commonly known as Service Permission Group. Note that field name on ZHD.3 has not changed, just the field notes.