2 Patient Administration for Pathology
- 1 2.1 Message Control Segments
- 1.1 2.1.2 BHS - batch header segment
- 1.1.1 2.1.2.0 BHS field definitions
- 1.1.2 2.1.2.1 BHS-1 Batch field separator (ST) 00081
- 1.1.3 2.1.2.2 BHS-2 Batch encoding characters (ST) 00082
- 1.1.4 2.1.2.3 BHS-3 Batch sending application (ST) 00083
- 1.1.5 2.1.2.4 BHS-4 Batch sending facility (ST) 00084
- 1.1.6 2.1.2.5 BHS-5 Batch receiving application (ST) 00085
- 1.1.7 2.1.2.6 BHS-6 Batch receiving facility (ST) 00086
- 1.1.8 2.1.2.7 BHS-7 Batch creation date/time (TS) 00087
- 1.1.9 2.1.2.8 BHS-8 Batch security (ST) 00088
- 1.1.10 2.1.2.9 BHS-9 Batch name/ID/type (ST) 00089
- 1.1.11 2.1.2.10 BHS-10 Batch comment (ST) 00090
- 1.1.12 2.1.2.11 BHS-11 Batch control ID (ST) 00091
- 1.1.13 2.1.2.12 BHS-12 Reference batch control ID (ST) 00092
- 1.2 2.1.3 BTS - batch trailer segment
- 1.3 2.1.4 DSC - continuation pointer segment
- 1.4 2.1.5 ERR - error segment
- 1.5 2.1.6 FHS - file header segment
- 1.5.1 HL7 Attribute Table - FHS - File Header
- 1.5.2 2.1.6.0 FHS field definitions
- 1.5.3 2.1.6.1 FHS-1 File field separator (ST) 00067
- 1.5.4 2.1.6.2 FHS-2 File encoding characters (ST) 00068
- 1.5.5 2.1.6.3 FHS-3 File sending application (ST) 00069
- 1.5.6 2.1.6.4 FHS-4 File sending facility (ST) 00070
- 1.5.7 2.1.6.5 FHS-5 File receiving application (ST) 00071
- 1.5.8 2.1.6.6 FHS-6 File receiving facility (ST) 00072
- 1.5.9 2.1.6.7 FHS-7 File creation date/time (TS) 00073
- 1.5.10 2.1.6.8 FHS-8 File security (ST) 00074
- 1.5.11 2.1.6.9 FHS-9 File name/ID (ST) 00075
- 1.5.12 2.1.6.10 FHS-10 File header comment (ST) 00076
- 1.5.13 2.1.6.11 FHS-11 File control ID (ST) 00077
- 1.5.14 2.1.6.12 FHS-12 Reference file control ID (ST) 00078
- 1.6 2.1.7 FTS - file trailer segment
- 1.7 2.1.8 MSA - message acknowledgment segment
- 1.7.1 HL7 Attribute Table - MSA - Message Acknowledgment
- 1.7.2 2.1.8.0 MSA field definitions
- 1.7.3 2.1.8.1 MSA-1 Acknowledgment code (ID) 00018
- 1.7.4 2.1.8.2 MSA-2 Message control ID (ST) 00010
- 1.7.5 2.1.8.3 MSA-3 Text message (ST) 00020
- 1.7.6 2.1.8.4 MSA-4 Expected sequence number (NM) 00021
- 1.7.7 2.1.8.5 MSA-5 Delayed acknowledgment type (ID) 00022
- 1.7.8 2.1.8.6 MSA-6 Error condition (CE) 00023
- 1.8 2.1.9 MSH - message header segment
- 1.8.1 HL7 Attribute Table - MSH - Message Header
- 1.8.2 2.1.9.0 MSH field definitions
- 1.8.3 2.1.9.1 MSH-1 Field separator (ST) 00001
- 1.8.4 2.1.9.2 MSH-2 Encoding characters (ST) 00002
- 1.8.5 2.1.9.3 MSH-3 Sending application (HD) 00003
- 1.8.6 2.1.9.4 MSH-4 Sending facility (HD) 00004
- 1.8.7 2.1.9.5 MSH-5 Receiving application (HD) 00005
- 1.8.8 2.1.9.6 MSH-6 Receiving facility (HD) 00006
- 1.8.9 2.1.9.7 MSH-7 Date/time of message (TS) 00007
- 1.8.10 2.1.9.8 MSH-8 Security (ST) 00008
- 1.8.11 2.1.9.9 MSH-9 Message type (CM) 00009
- 1.8.12 2.1.9.10 MSH-10 Message control ID (ST) 00010
- 1.8.13 2.1.9.11 MSH-11 Processing ID (PT) 00011
- 1.8.14 2.1.9.12 MSH-12 Version ID (VID) 00012
- 1.8.15 2.1.9.13 MSH-13 Sequence number (NM) 00013
- 1.8.16 2.1.9.14 MSH-14 Continuation pointer (ST) 00014
- 1.8.17 2.1.9.15 MSH-15 Accept acknowledgment type (ID) 00015
- 1.8.18 2.1.9.16 MSH-16 Application acknowledgment type (ID) 00016
- 1.8.19 2.1.9.17 MSH-17 Country code (ID) 00017
- 1.8.20 2.1.9.18 MSH-18 Character set (ID) 00692
- 1.8.21 2.1.9.19 MSH-19 Principal language of message (CE) 00693
- 1.8.22 2.1.9.20 MSH-20 Alternate character set handling scheme (ID) 01317
- 1.8.23 2.1.9.21 MSH-21 Conformance statement ID (ID) 01598
- 1.8.24 2.1.9.27 MSH-27 Security Handling Instructions (CWE) 2430
- 1.1 2.1.2 BHS - batch header segment
- 2 2.2 Other segments used in pathology messaging
- 2.1 2.2.1 PID - patient identification segment
- 2.1.1 HL7 Attribute Table – PID – Patient identification
- 2.1.2 2.2.1.0 PID field definition
- 2.1.3 2.2.1.1 PID-1 Set ID PID (SI) 00104
- 2.1.4 2.2.1.2 PID-2 Patient ID (CX) 00105
- 2.1.5 2.2.1.3 PID-3 Patient identifier list (CX) 00106
- 2.1.6 2.2.1.4 PID-4 Alternate patient ID - PID (CX) 00107
- 2.1.7 2.2.1.5 PID-5 Patient name (XPN) 00108
- 2.1.8 2.2.1.6 PID-6 Mother's maiden name (XPN) 00109
- 2.1.9 2.2.1.7 PID-7 Date/time of birth (TS) 00110
- 2.1.10 2.2.1.8 PID-8 Administrative sex (IS) 00111
- 2.1.11 2.2.1.9 PID-9 Patient alias (XPN) 00112
- 2.1.12 2.2.1.10 PID-10 Race (CE) 00113
- 2.1.13 2.2.1.11 PID-11 Patient address (XAD) 00114
- 2.1.14 2.2.1.12 PID-12 County code (IS) 00115
- 2.1.15 2.2.1.13 PID-13 Phone number - home (XTN) 00116
- 2.1.16 2.2.1.14 PID-14 Phone number - business (XTN) 00117
- 2.1.17 2.2.1.15 PID-15 Primary language (CE) 00118
- 2.1.18 2.2.1.16 PID-16 Marital status (CE) 00119
- 2.1.19 2.2.1.17 PID-17 Religion (CE) 00120
- 2.1.20 2.2.1.18 PID-18 Patient account number (CX) 00121
- 2.1.21 2.2.1.19 PID-19 SSN number patient (ST) 00122
- 2.1.22 2.2.1.20 PID-20 Driver's license number - Patient (DLN) 00123
- 2.1.23 2.2.1.21 PID-21 Mother's identifier (CX) 00124
- 2.1.24 2.2.1.22 PID-22 Ethnic group (CE) 00125
- 2.1.25 2.2.1.23 PID-23 Birth place (ST) 00126
- 2.1.26 2.2.1.24 PID-24 Multiple birth indicator (ID) 00127
- 2.1.27 2.2.1.25 PID-25 Birth order (NM) 00128
- 2.1.28 2.2.1.26 PID-26 Citizenship (CE) 00129
- 2.1.29 2.2.1.27 PID-27 Veterans military status (CE) 00130
- 2.1.30 2.2.1.28 PID-28 Nationality (CE) 00739
- 2.1.31 2.2.1.29 PID-29 Patient death date and time (TS) 00740
- 2.1.32 2.2.1.30 PID-30 Patient death indicator (ID) 00741
- 2.1.33 2.2.1.31 PID-31 Identity unknown indicator (ID) 01535
- 2.1.34 2.2.1.32 PID-32 Identity reliability code (IS) 01536
- 2.1.35 2.2.1.33 PID-33 Last update date/time (TS) 01537
- 2.1.36 2.2.1.34 PID-34 Last update facility (HD) 01538
- 2.1.37 2.2.1.35 PID-35 Species code (CE) 01539
- 2.1.38 2.2.1.36 PID-36 Breed code (CE) 01540
- 2.1.39 2.2.1.37 PID-37 Strain (ST) 01541
- 2.1.40 2.2.1.38 PID-38 Production class code (CE) 01542
- 2.2 2.2.2 PV1 - patient visit segment
- 2.2.1 HL7 Attribute Table - PV1 – Patient visit
- 2.2.2 2.2.2.0 PV1 field definitions
- 2.2.3 2.2.2.1 PV1-1 Set ID - PV1 (SI) 00131
- 2.2.4 2.2.2.2 PV1-2 Patient class (IS) 00132
- 2.2.5 2.2.2.3 PV1-3 Assigned patient location (PL) 00133
- 2.2.6 2.2.2.4 PV1-4 Admission type (IS) 00134
- 2.2.7 2.2.2.5 PV1-5 Preadmit number (CX) 00135
- 2.2.8 2.2.2.6 PV1-6 Prior patient location (PL) 00136
- 2.2.9 2.2.2.7 PV1-7 Attending doctor (XCN) 00137
- 2.2.10 2.2.2.8 PV1-8 Referring doctor (XCN) 00138
- 2.2.11 2.2.2.9 PV1-9 Consulting doctor (XCN) 00139
- 2.2.12 2.2.2.10 PV1-10 Hospital service (IS) 00140
- 2.2.13 2.2.2.11 PV1-11 Temporary location (PL) 00141
- 2.2.14 2.2.2.12 PV1-12 Preadmit test indicator (IS) 00142
- 2.2.15 2.2.2.13 PV1-13 Re-admission indicator (IS) 00143
- 2.2.16 2.2.2.14 PV1-14 Admit source (IS) 00144
- 2.2.17 2.2.2.15 PV1-15 Ambulatory status (IS) 00145
- 2.2.18 2.2.2.16 PV1-16 VIP indicator (IS) 00146
- 2.2.19 2.2.2.17 PV1-17 Admitting doctor (XCN) 00147
- 2.2.20 2.2.2.18 PV1-18 Patient type (IS) 00148
- 2.2.21 2.2.2.19 PV1-19 Visit number (CX) 00149
- 2.2.22 2.2.2.20 PV1-20 Financial class (FC) 00150
- 2.2.23 2.2.2.21 PV1-21 Charge price indicator (IS) 00151
- 2.2.24 2.2.2.22 PV1-22 Courtesy code (IS) 00152
- 2.2.25 2.2.2.23 PV1-23 Credit rating (IS) 00153
- 2.2.26 2.2.2.24 PV1-24 Contract code (IS) 00154
- 2.2.27 2.2.2.25 PV1-25 Contract effective date (DT) 00155
- 2.2.28 2.2.2.26 PV1-26 Contract amount (NM) 00156
- 2.2.29 2.2.2.27 PV1-27 Contract period (NM) 00157
- 2.2.30 2.2.2.28 PV1-28 Interest code (IS) 00158
- 2.2.31 2.2.2.29 PV1-29 Transfer to bad debt code (IS) 00159
- 2.2.32 2.2.2.30 PV1-30 Transfer to bad debt date (DT) 00160
- 2.2.33 2.2.2.31 PV1-31 Bad debt agency code (IS) 00161
- 2.2.34 2.2.2.32 PV1-32 Bad debt transfer amount (NM) 00162
- 2.2.35 2.2.2.33 PV1-33 Bad debt recovery amount (NM) 00163
- 2.2.36 2.2.2.34 PV1-34 Delete account indicator (IS) 00164
- 2.2.37 2.2.2.35 PV1-35 Delete account date (DT) 00165
- 2.2.38 2.2.2.36 PV1-36 Discharge disposition (IS) 00166
- 2.2.39 2.2.2.37 PV1-37 Discharged to location (CM) 00167
- 2.2.40 2.2.2.38 PV1-38 Diet type (CE) 00168
- 2.2.41 2.2.2.39 PV1-39 Servicing facility (IS) 00169
- 2.2.42 2.2.2.40 PV1-40 Bed status (IS) 00170
- 2.2.43 2.2.2.41 PV1-41 Account status (IS) 00171
- 2.2.44 2.2.2.42 PV1-42 Pending location (PL) 00172
- 2.2.45 2.2.2.43 PV1-43 Prior temporary location (PL) 00173
- 2.2.46 2.2.2.44 PV1-44 Admit date/time (TS) 00174
- 2.2.47 2.2.2.45 PV1-45 Discharge date/time (TS) 00175
- 2.2.48 2.2.2.46 PV1-46 Current patient balance (NM) 00176
- 2.2.49 2.2.2.47 PV1-47 Total charges (NM) 00177
- 2.2.50 2.2.2.48 PV1-48 Total adjustments (NM) 00178
- 2.2.51 2.2.2.49 PV1-49 Total payments (NM) 00179
- 2.2.52 2.2.2.50 PV1-50 Alternate visit ID (CX) 00180
- 2.2.53 2.2.2.51 PV1-51 Visit indicator (IS) 01226
- 2.2.54 2.2.2.52 PV1-52 Other healthcare provider (XCN) 01274
- 2.3 2.2.3 PV2- patient visit - additional information segment
- 2.3.1 2.2.3.0 PV2 field definitions
- 2.3.2 2.2.3.1 PV2-1 Prior pending location (PL) 00181
- 2.3.3 2.2.3.2 PV2-2 Accommodation code (CE) 00182
- 2.3.4 2.2.3.3 PV2-3 Admit reason (CE) 00183
- 2.3.5 2.2.3.4 PV2-4 Transfer reason (CE) 00184
- 2.3.6 2.2.3.5 PV2-5 Patient valuables (ST) 00185
- 2.3.7 2.2.3.6 PV2-6 Patient valuables location (ST) 00186
- 2.3.8 2.2.3.7 PV2-7 Visit user code (IS) 00187
- 2.3.9 2.2.3.8 PV2-8 Expected admit date/time (TS) 00188
- 2.3.10 2.2.3.9 PV2-9 Expected discharge date/time (TS) 00189
- 2.3.11 2.2.3.10 PV2-10 Estimated length of inpatient stay (NM) 00711
- 2.3.12 2.2.3.11 PV2-11 Actual length of inpatient stay (NM) 00712
- 2.3.13 2.2.3.12 PV2-12 Visit description (ST) 00713
- 2.3.14 2.2.3.13 PV2-13 Referral source code (XCN) 00714
- 2.3.15 2.2.3.14 PV2-14 Previous service date (DT) 00715
- 2.3.16 2.2.3.15 PV2-15 Employment illness related indicator (ID) 00716
- 2.3.17 2.2.3.16 PV2-16 Purge status code (IS) 00717
- 2.3.18 2.2.3.17 PV2-17 Purge status date (DT) 00718
- 2.3.19 2.2.3.18 PV2-18 Special program code (IS) 00719
- 2.3.20 2.2.3.19 PV2-19 Retention indicator (ID) 00720
- 2.3.21 2.2.3.20 PV2-20 Expected number of insurance plans (NM) 00721
- 2.3.22 2.2.3.21 PV2-21 Visit publicity code (IS) 00722
- 2.3.23 2.2.3.22 PV2-22 Visit protection indicator (ID) 00723
- 2.3.24 2.2.3.23 PV2-23 Clinic organization name (XON) 00724
- 2.3.25 2.2.3.24 PV2-24 Patient status code (IS) 00725
- 2.3.26 2.2.3.25 PV2-25 Visit priority code (IS) 00726
- 2.3.27 2.2.3.26 PV2-26 Previous treatment date (DT) 00727
- 2.3.28 2.2.3.27 PV2-27 Expected discharge disposition (IS) 00728
- 2.3.29 2.2.3.28 PV2-28 Signature on file date (DT) 00729
- 2.3.30 2.2.3.29 PV2-29 First similar illness date (DT) 00730
- 2.3.31 2.2.3.30 PV2-30 Patient charge adjustment code (CE) 00731
- 2.3.32 2.2.3.31 PV2-31 Recurring service code (IS) 00732
- 2.3.33 2.2.3.32 PV2-32 Billing media code (ID) 00733
- 2.3.34 2.2.3.33 PV2-33 Expected surgery date and time (TS) 00734
- 2.3.35 2.2.3.34 PV2-34 Military partnership code (ID) 00735
- 2.3.36 2.2.3.35 PV2-35 Military non-availability code (ID) 00736
- 2.3.37 2.2.3.36 PV2-36 Newborn baby indicator (ID) 00737
- 2.3.38 2.2.3.37 PV2-37 Baby detained indicator (ID) 00738
- 2.3.39 2.2.3.38 PV2-38 Mode of arrival code (CE) 01543
- 2.3.40 2.2.3.39 PV2-39 Recreational drug use code (CE) 01544
- 2.3.41 2.2.3.40 PV2-40 Admission level of care code (CE) 01545
- 2.3.42 2.2.3.41 PV2-41 Precaution code (CE) 01546
- 2.3.43 2.2.3.42 PV2-42 Patient condition code (CE) 01547
- 2.3.44 2.2.3.43 PV2-43 Living will code (IS) 00759
- 2.3.45 2.2.3.44 PV2-44 Organ donor code (IS) 00760
- 2.3.46 2.2.3.45 PV2-45 Advance directive code (CE) 01548
- 2.3.47 2.2.3.46 PV2-46 Patient status effective date (DT) 01549
- 2.3.48 2.2.3.47 PV2-47 Expected LOA return date/time (TS) 01550
- 2.4 2.2.4 AL1 - Patient allergy information segment
- 2.4.1 2.2.4.0 AL1 field definitions
- 2.4.2 2.2.4.1 AL1-1 Set ID - AL1 (CE) 00203
- 2.4.3 2.2.4.2 AL1-2 Allergen type code (CE) 00204
- 2.4.4 2.2.4.3 AL1-3 Allergen code/mnemonic/description (CE) 00205
- 2.4.5 2.2.4.4 AL1-4 Allergy severity code (CE) 00206
- 2.4.6 2.2.4.5 AL1-5 Allergy reaction code (ST) 00207
- 2.4.7 2.2.4.6 AL1-6 Identification date (DT) 00208
- 2.5 2.2.5 QRD - original-style query definition segment
- 2.5.1
- 2.5.2 2.2.5.0 QRD field definitions
- 2.5.3 2.2.5.1 QRD-1 Query date/time (TS) 00025
- 2.5.4 2.2.5.2 QRD-2 Query format code (ID) 00026
- 2.5.5 2.2.5.3 QRD-3 Query priority (ID) 00027
- 2.5.6 2.2.5.4 QRD-4 Query ID (ST) 00028
- 2.5.7 2.2.5.5 QRD-5 Deferred response type (ID) 00029
- 2.5.8 2.2.5.6 QRD-6 Deferred response date/time (TS) 00030
- 2.5.9 2.2.5.7 QRD-7 Quantity limited request (CQ) 00031
- 2.5.10 2.2.5.8 QRD-8 Who subject filter (XCN) 00032
- 2.5.11 2.2.5.9 QRD-9 What subject filter (CE) 00033
- 2.5.12 2.2.5.10 QRD-10 What department data code (CE) 00034
- 2.5.13 2.2.5.11 QRD-11 What data code value qual (CM) 00035
- 2.5.14 2.2.5.12 QRD-12 Query results level (ID) 00036
- 2.6 2.2.6 QRF - original style query filter segment
- 2.6.1 2.2.6.1 QRF-1 Where subject filter (ST) 00037
- 2.6.2 2.2.6.2 QRF-2 When data start date/time (TS) 00038
- 2.6.3 2.2.6.3 QRF-3 When data end date/time (TS) 00039
- 2.6.4 2.2.6.4 QRF-4 What user qualifier (ST) 00040
- 2.6.5 2.2.6.5 QRF-5 Other QRY subject filter (ST) 00041
- 2.6.6 2.2.6.6 QRF-6 Which date/time qualifier (ID) 00042
- 2.6.7 2.2.6.7 QRF-7 Which date/time status qualifier (ID) 00043
- 2.6.8 2.2.6.8 QRF-8 Date/time selection qualifier (ID) 00044
- 2.6.9 2.2.6.9 QRF-9 When quantity/timing qualifier (TQ) 00694
- 2.6.10 2.2.6.10 QRF-10 Search confidence threshold (NM) 01442
- 2.1 2.2.1 PID - patient identification segment
- 3 2.3 Localisation Details
- 3.1 2.3.1 Billing
2.1 Message Control Segments
The following segments are necessary to support the functionality described in this chapter.
If a value is the usual default for use in Australia it has been highlighted in blue.
Figure 2-1. HL7 message segments
2.1.2 BHS - batch header segment
The BHS segment defines the start of a batch.
HL7 Attribute Table - BHS – Batch Header
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 | 1 | ST | R |
|
| 00081 | Batch Field Separator |
2 | 3 | ST | R |
|
| 00082 | Batch Encoding Characters |
3 | 15 | ST | O |
|
| 00083 | Batch Sending Application |
4 | 20 | ST | O |
|
| 00084 | Batch Sending Facility |
5 | 15 | ST | O |
|
| 00085 | Batch Receiving Application |
6 | 20 | ST | O |
|
| 00086 | Batch Receiving Facility |
7 | 26 | TS | O |
|
| 00087 | Batch Creation Date/Time |
8 | 40 | ST | O |
|
| 00088 | Batch Security |
9 | 20 | ST | O |
|
| 00089 | Batch Name/ID/Type |
10 | 80 | ST | O |
|
| 00090 | Batch Comment |
11 | 20 | ST | O |
|
| 00091 | Batch Control ID |
12 | 20 | ST | O |
|
| 00092 | Reference Batch Control ID |
2.1.2.0 BHS field definitions
2.1.2.1 BHS-1 Batch field separator (ST) 00081
Definition: This field contains the separator between the segment ID and the first real field, BHS-2-batch encoding characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. Recommended value is |,(ASCII 124).
2.1.2.2 BHS-2 Batch encoding characters (ST) 00082
Definition: This field contains the four characters in the following order: the component separator, repetition separator, escape characters, and subcomponent separator. Australian values are ^~\& (ASCII 94,126, 92, and 38, respectively).
2.1.2.3 BHS-3 Batch sending application (ST) 00083
Definition: This field uniquely identifies the sending application among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise. Entirely site-defined.
2.1.2.4 BHS-4 Batch sending facility (ST) 00084
Definition: This field contains the address of one of several occurrences of the same application within the sending system. Absent other considerations, the Medicare Provider ID might be used with an appropriate sub-identifier in the second component. Entirely user-defined.
2.1.2.5 BHS-5 Batch receiving application (ST) 00085
Definition: This field uniquely identifies the receiving applications among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise. Entirely site-defined.
2.1.2.6 BHS-6 Batch receiving facility (ST) 00086
Definition: This field identifies the receiving application among multiple identical instances of the application running on behalf of different organizations. See comments BHS-4-batch sending facility. Entirely site-defined.
2.1.2.7 BHS-7 Batch creation date/time (TS) 00087
Definition: This field contains the date/time that the sending system created the message. If the time zone is specified, it will be used throughout the message as the default time zone.
2.1.2.8 BHS-8 Batch security (ST) 00088
Definition: In some applications of HL7, this field is used to implement security features. Its use is not yet further specified.
2.1.2.9 BHS-9 Batch name/ID/type (ST) 00089
Definition: This field can be used by the application processing the batch. It can have extra components if needed.
2.1.2.10 BHS-10 Batch comment (ST) 00090
Definition: This field is a comment field that is not further defined in the HL7 protocol.
2.1.2.11 BHS-11 Batch control ID (ST) 00091
Definition: This field is used to uniquely identify a particular batch. It can be echoed back in BHS-12-reference batch control ID if an answering batch is needed.
2.1.2.12 BHS-12 Reference batch control ID (ST) 00092
Definition: This field contains the value of BHS-11-batch control ID when this batch was originally transmitted.
Not present if this batch is being sent for the first time. See definition for BHS-11-batch control ID.
2.1.3 BTS - batch trailer segment
The BTS segment defines the end of a batch.
2.1.3.0 BTS field definitions
HL7 Attribute Table - BTS – Batch Trailer
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 | 10 | ST | O |
|
| 00093 | Batch Message Count |
2 | 80 | ST | O |
|
| 00090 | Batch Comment |
3 | 100 | NM | O | Y |
| 00095 | Batch Totals |
2.1.3.1 BTS-1 Batch message count (ST) 00093
Definition: This field contains the count of the individual messages contained within the batch.
2.1.3.2 BTS-2 Batch comment (ST) 00090
Definition: This field is a comment field that is not further defined in the HL7 protocol.
2.1.3.3 BTS-3 Batch totals (NM) 00095
Definition: We encourage new users of this field to use the HL7 Version 2.3 data type of NM and to define it as “repeating.” This field contains the batch total. Only a single Batch is allowed in Australia.
This field may be defined as a CM data type for backward compatibility with HL7 Versions 2.2 and 2.1with each total being carried as a separate component. Each component in this case is an NM data type.
2.1.4 DSC - continuation pointer segment
The DSC segment is used in the continuation protocol.
2.1.4.0 DSC field definitions
HL7 Attribute Table - DSC – Continuation Pointer
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 | 180 | ST | O |
|
| 00014 | Continuation Pointer |
2 | 1 | ID | O |
| 01354 | Continuation Style |
2.1.4.1 DSC-1 Continuation pointer (ST) 00014
Definition: This field contains the continuation pointer. In an initial query, this field is not present. If the responder returns a value of null or not present, then there is no more data to fulfill any future continuation requests. For use with continuations of unsolicited messages, see HL7 International Standard chapter 5 and section 2.15.2, "Continuation messages and segments.” Note that continuation protocols work with both display- and record-oriented messages.
2.1.4.2 DSC-2 Continuation style (ID) 01354
Definition: Indicates whether this is a fragmented message (see HL7 International Standard Section 2.15.2, "Continuation messages and segments"), or if it is part of an interactive continuation message (see HL7 International Standard Section 5.6.3, "Interactive continuation of response messages").
Refer to HL7 Table 0398 – Continuation style code for valid values.
HL7 Table 0398 - Continuation style code
Value | Description |
|---|---|
F | Fragmentation |
I | Interactive Continuation |
2.1.5 ERR - error segment
The ERR segment is used to add error comments to acknowledgment messages.
HL7 Attribute Table - ERR –Error
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 | 80 | CM | R | Y |
| 00024 | Error Code and Location |
2.1.5.0 ERR field definition
2.1.5.1 ERR-1 Error code and location (CM) 00024
Components: <segment ID (ST)> ^ <sequence (NM)> ^ <field position (NM)> ^ <code identifying error (CE)>
Definition: This field identifies an erroneous segment in another message. The second component is an index if there is more than one segment of type <segment ID>. For systems that do not use the HL7 Encoding Rules, the data item number may be used for the third component. The fourth component (which references HL7 Table 0357 - Message error condition codes, (as a CE data type) is restricted from having any subcomponents as the subcomponent separator is now the CE’s component separator.
2.1.6 FHS - file header segment
The FHS segment is used to head a file as defined in Overview.
HL7 Attribute Table - FHS - File Header
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM # | ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 | 1 | ST | R |
|
| 00067 | File Field Separator |
2 | 4 | ST | R |
|
| 00068 | File Encoding Characters |
3 | 15 | ST | O |
|
| 00069 | File Sending Application |
4 | 20 | ST | O |
|
| 00070 | File Sending Facility |
5 | 15 | ST | O |
|
| 00071 | File Receiving Application |
6 |
The MSH table notes that the values can only be 10 characters long. All of the acceptable values are more than 10 characters. Tony Cruice and Eli Brown. Medical Objects.