References to other Chapters
Index HL7
Chapter 1
Chapter 2
Chapter 3
Chapter 4
Chapter 5
Chapter 6
Chapter 7
Chapter 8
1
1
1.1 PURPOSE
1.2 BACKGROUND
1.3 NEED FOR A STANDARD
1.4 GOALS OF THE STANDARD
1.5 HISTORY OF HL7 DEVELOPMENT
1.6 OVERVIEW
1.6.1 HL7 encoding rules
1.6.2 Local variations
1.6.3 Evolutionary changes to the standards
1.6.4 Applicability to file transfers (batch processing)
1.6.5 Relationship to other protocols
1.6.5.1 Lower layer protocols
1.6.5.2 Other applications protocols
1.7 REFERENCE DOCUMENTS
1.7.1 ANSI standards
1.7.2 ISO standards
1.7.3 Codes and terminology sources
1.7.4 Other Applicable Documents
1.8 SUGGESTIONS AND COMMENTS
2
2
2.1 INTRODUCTION
2.2 CONCEPTUAL APPROACH
2.2.1 Trigger events
2.2.2 Acknowledgements: original mode
2.2.3 Acknowledgements: enhanced mode
2.2.4 Queries
2.3 COMMUNICATIONS ENVIRONMENT
2.4 HL7 MESSAGES
2.4.1 Message definition
2.4.2 Segments
2.4.3 Fields
2.4.4 Message delimiters
2.4.5 Data types
2.4.5.1 ST string data
2.4.5.2 TX text data
2.4.5.3 FT formatted text data
2.4.5.4 NM numeric
2.4.5.5 DT date
2.4.5.6 TM time
2.4.5.7 TS time stamp
2.4.5.8 PN person name
2.4.5.9 TN telephone number
2.4.5.10 AD address
2.4.5.11 ID coded value
2.4.5.12 SI sequence ID
2.4.5.13 CM composite
2.4.5.14 CK composite ID with check digit
2.4.5.15 CN composite ID number and name
2.4.5.16 CQ composite quantity with units
2.4.5.17 CE coded element
2.4.5.18 CF coded element with formatted values
2.4.5.19 RP reference pointer
2.4.5.20 TQ timing quantity
2.4.5.21 MO money
2.4.6 Use of escape sequences in text fields
2.4.6.1 Formatting codes
2.4.6.2 Highlighting
2.4.6.3 Special character
2.4.6.4 Hexadecimal
2.4.6.5 Formatted text
2.4.6.6 Local
2.4.7 Message construction rules
2.4.8 Chapter formats for defining HL7 messages
2.4.8.1 HL7 abstract message syntax example
2.5 APPLICATION (LEVEL 7) PROCESSING RULES
2.5.1 Original and enhanced processing rules
2.5.1.1 Initiation
2.5.1.2 Response
2.5.1.2.1 When the original acknowledgement rules apply
2.5.1.2.2 When enhanced acknowledgement rules apply
2.5.2 Application (level 7) processing rules, deferred processing two phase reply (original acknowledgement mode only)
2.5.2.1 Initiation
2.5.2.2 Response
2.6 ACKNOWLEDGEMENT MESSAGES
2.6.1 ACK: general acknowledgement
2.6.2 MCF: Delayed acknowledgement
2.7 DISPLAY MESSAGES
2.7.1 Display vs. record-oriented messages
2.7.2 Unsolicited display update message (trigger event Q05)
2.7.3 Continuation of unsolicited display update message
2.8 QUERIES
2.8.1 Display vs. record-oriented queries
2.8.2 Message definition
2.8.3 Immediate vs. deferred response
2.8.4 Interactive continuation of display messages
2.8.5 Logical display break points
2.8.6 Query trigger events and message definitions
2.8.6.1 A query is made for immediate response (Trigger Event Q01)
2.8.6.1.1 Display query variants
2.8.6.2 Deferred access
2.8.6.2.1 A query is sent for deferred response (trigger event Q02)
2.8.6.2.2 Deferred response to a query (trigger event Q03)
2.8.7 Query message implementation considerations
2.9 SPECIAL HL7 PROTOCOLS
2.9.1 Sequence number protocol
2.9.2 Continuation messages and segments
2.9.3 HL7 batch protocol
2.9.3.1 HL7 batch file structure
2.9.3.2 Related segments and data usage
2.9.3.3 Acknowledging batches
2.9.3.4 Batch message as a query response
2.10 MESSAGE CONTROL SEGMENTS
2.10.1 MSH - message header segment -
2.10.1.1 Field separator (ST) 00001
2.10.1.2 Encoding characters (ST) 00002
2.10.1.3 Sending application (ST) 00003
2.10.1.4 Sending facility (ST) 00004
2.10.1.5 Receiving application (ST) 00005
2.10.1.6 Receiving facility (ST) 00006
2.10.1.7 Date/time of message (TS) 00007
2.10.1.8 Security (ST) 00008
2.10.1.9 Message type (CM) 00009
2.10.1.10 Message control ID (ST) 00010
2.10.1.11 Processing ID (ID) 00011
2.10.1.12 Version ID (ID) 00012
2.10.1.13 Sequence number (NM) 00013
2.10.1.14 Continuation pointer (ST) 00014
2.10.1.15 Accept acknowledgement type (ID) 00015
2.10.1.16 pplication acknowledgement type (ID) 00016
2.10.1.17 Country code (ID) 00017
2.10.2 MSA - message acknowledgement segment -
2.10.2.1 Acknowledgement code (ID) 00018
2.10.2.2 Message control ID (ST) 00010
2.10.2.3 Text message (ST) 00020
2.10.2.4 Expected sequence number (NM) 00021
2.10.2.5 Delayed acknowledgement type (ID) 00022
2.10.2.6 Error condition (CE) 00023
2.10.3 ERR - error segment -
2.10.3.1 Error code and location (CM) 00024
2.10.4 QRD - query definition segment
2.10.4.1 Query date/time (TS) 00025
2.10.4.2 Query format code (ID) 00026
2.10.4.3 Query priority (ID) 00027
2.10.4.4 Query ID (ST) 00028
2.10.4.5 Deferred response type (ID) 00029
2.10.4.6 Deferred response date/time (TS) 00030
2.10.4.7 Quantity limited request (CQ) 00031
2.10.4.8 Who subject filter (ST) 00032
2.10.4.9 What subject filter (ID) 00033
2.10.4.10 What department data code (ST) 00034
2.10.4.11 What data code value qual (CM) 00035
2.10.4.12 Query results level (ID) 00036
2.10.5 QRF - query filter segment
2.10.5.1 Where subject filter (ST) 00037
2.10.5.2 When data start date/time (TS) 00038
2.10.5.3 When data end date/time (TS) 00039
2.10.5.4 What user qualifier (ST) 00040
2.10.5.5 Other QRY subject filter (ST) 00041
2.10.5.6 Which date/time qualifier (ID) 00042
2.10.5.7 Which date/time status qualifier (ID) 00043
2.10.5.8 Date/time selection qualifier (ID) 00044
2.10.6 URD - results/update definition segment
2.10.6.1 R/U date/time (TS) 00045
2.10.6.2 Report priority (ID) 00046
2.10.6.3 R/U who subject definition (ST) 00047
2.10.6.4 R/U what subject definition (ID) 00048
2.10.6.5 R/U what department code (ST) 00049
2.10.6.6 R/U display/print locations (ST) 00050
2.10.6.7 R/U results level (ID) 00051
2.10.7 URS - unsolicited selection segment
2.10.7.1 R/U where subject definition (ST) 00052
2.10.7.2 R/U when data start date/time (TS) 00053
2.10.7.3 R/U when data end date/time (TS) 00054
2.10.7.4 R/U what user qualifier (ST) 00055
2.10.7.5 R/U other results subject definition (ST) 00056
2.10.7.6 R/U Which date/time qualifier (ID) 00057
2.10.7.7 R/U Which date/time status qualifier (ID) 00058
2.10.7.8 R/U Date/time selection qualifier (ID) 00059
2.10.8 DSC - Continuation pointer segment
2.10.8.1 Continuation pointer (ST) 00060
2.10.9 DSP - display data segment
2.10.9.1 Set ID - display data (SI) 00061
2.10.9.2 Display level (SI) 00062
2.10.9.3 Data line (TX) 00063
2.10.9.4 Logical break point (ST) 00064
2.10.9.5 Result ID (TX) 00065
2.10.10 ADD - addendum segment -
2.10.10.1 Addendum continuation pointer (ST) 00066
2.10.11 FHS - file header segment -
2.10.11.1 File field separator (ST) 00067
2.10.11.2 File encoding characters (ST) 00068
2.10.11.3 File sending application (ST) 00069
2.10.11.4 File sending facility (ST) 00070
2.10.11.5 File receiving application (ST) 00071
2.10.11.6 File receiving facility (ST) 00072
2.10.11.7 File creation date/time (TS) 00073
2.10.11.8 File security (ST) 00074
2.10.11.9 File name/ID (ST) 00075
2.10.11.10 File header comment (ST) 00076
2.10.11.11 File control ID (ST) 00077
2.10.11.12 Reference file control ID (ST) 00078
2.10.12 FTS - file trailer segment-
2.10.12.1 File batch count (NM) 00079
2.10.12.2 File trailer comment (ST) 00080
2.10.13 BHS - batch header -
2.10.13.1 Batch field separator (ST) 00081
2.10.13.2 Batch encoding characters (ST) 00082
2.10.13.3 Batch sending application (ST) 00083
2.10.13.4 Batch sending facility (ST) 00084
2.10.13.5 Batch receiving application (ST) 00085
2.10.13.6 Batch receiving facility (ST) 00086
2.10.13.7 Batch creation date/time (TS) 00087
2.10.13.8 Batch security (ST) 00088
2.10.13.9 Batch name/ID/type (ST) 00089
2.10.13.10 Batch comment (ST) 00090
2.10.13.11 Batch control ID (ST) 00091
2.10.13.12 Reference batch control ID (ST) 00092
2.10.14 BTS - batch trailer segment -
2.10.14.1 Batch message count (ST) 00093
2.10.14.2 Batch comment (ST) 00094
2.10.14.3 Batch totals (CM) 00095
2.10.15 NTE - notes and comments segment -
2.10.15.1 Set ID - notes and comments (SI) 00096
2.10.15.2 Source of comment (ID) 00097
2.10.15.3 Comment (FT) 00098
2.10.16 Miscellaneous HL7 tables used across all chapters.
2.10.16.1 Yes/No indicator table
2.11 SAMPLE CONTROL AND QUERY MESSAGES
2.11.1 General Acknowledgement
2.11.2 Error return
2.11.3 Sequence number: initial message
2.11.4 Query with display-oriented response
2.11.5 Master file update examples: with original and enhanced acknowledgement protocol
2.11.5.1 Original mode example:
2.11.5.2 Enhanced mode example
2.11.5.2.1 Initial Message with accept acknowledgement
2.11.5.2.2 Application acknowledgement message
2.11.5.3 Delayed application acknowledgement
2.11.5.3.1 Initial message with accept acknowledgement
2.11.5.3.2 Delayed application acknowledgement
2.12 OUTSTANDING ISSUES
3
3
Admission, Discharge, and Transfer
3.1 PURPOSE
3.2 TRIGGER EVENTS AND MESSAGE DEFINITIONS
3.2.1 Admit a patient (event code A01)
3.2.2 Transfer a patient (event code A02)
3.2.3 Discharge a patient (event code A03)
3.2.4 Register a patient (event code A04)
3.2.5 Pre-admit a patient (event code A05)
3.2.6 Transfer an outpatient to inpatient (event code A06)
3.2.7 Transfer an inpatient to outpatient (event code A07)
3.2.8 Update patient information (event code A08)
3.2.9 Patient departing (event code A09)
3.2.10 Patient arriving (event code A10)
3.2.11 Cancel admit (event code A11)
3.2.12 Cancel transfer (event code A12)
3.2.13 Cancel discharge (event code A13)
3.2.14 Pending admit (event code A14)
3.2.15 Pending transfer (event code A15)
3.2.16 Pending discharge (event code A16)
3.2.17 Swap patients (event code A17)
3.2.18 Merge patient information (event code A18)
3.2.19 Patient query (event code A19)
3.2.19.1 A19 usage notes
3.2.20 Bed status update (event code A20)
3.2.21 Patient goes on a "leave of absence" (event code A21)
3.2.22 Patient returns from a "leave of absence" (event code A22)
3.2.23 Delete a patient record (event code A23)
3.2.24 Link patient information (event code A24)
3.2.25 Cancel pending discharge (event code A25)
3.2.26 Cancel pending transfer (event code A26)
3.2.27 Cancel pending admit (event code A27)
3.2.28 Add person information (event code A28)
3.2.29 Delete person information (event code A29)
3.2.30 Merge person information (event code A30)
3.2.31 Update person information (event code A31)
3.2.32 Cancel patient arriving (event code A32)
3.2.33 Cancel patient departing (event code A33)
3.2.34 Merge patient information - patient ID only (event code A34)
3.2.35 Merge patient information - account number only (event code A35)
3.2.36 Merge patient information - patient ID & account number (event code A36)
3.2.37 Un-link patient information (event code A37)
3.3 MESSAGE SEGMENTS
3.3.1 EVN - Event type -
3.3.1.1 Event type code (ID) 00099
3.3.1.2 Date/time of event (TS) 00100
3.3.1.3 Date/time planned event (TS) 00101
3.3.1.4 Event reason code (ID) 00102
3.3.1.5 Operator ID (ID) 00103
3.3.2 PID - Patient Identification
3.3.2.1 Set ID - patient ID (SI) 00104
3.3.2.2 Patient ID (external ID) (CK) 00105
3.3.2.3 Patient ID (internal ID) (CM) 00106
3.3.2.4 Alternate patient ID (ST) 00107
3.3.2.5 Patient name (PN) 00108
3.3.2.6 Mother's maiden name (ST) 00109
3.3.2.7 Date of birth (TS) 00110
3.3.2.8 Sex (ID) 00111
3.3.2.9 Patient alias (PN) 00112
3.3.2.10 Race (ID) 00113
3.3.2.11 Patient address (AD) 00114
3.3.2.12 County code (ID) 00115
3.3.2.13 Phone number - home (TN) 00116
3.3.2.14 Phone number - business (TN) 00117
3.3.2.15 Language - patient (ST) 00118
3.3.2.16 Marital status (ID) 00119
3.3.2.17 Religion (ID) 00120
3.3.2.18 Patient account number (CK) 00121
3.3.2.19 SSN number - patient (ST) 00122
3.3.2.20 Driver's lic num - patient (CM) 00123
3.3.2.21 Mother's identifier (CK) 00124
3.3.2.22 Ethnic group (ID) 00125
3.3.2.23 Birth place (ST) 00126
3.3.2.24 Multiple birth indicator (ID) 00127
3.3.2.25 Birth order (NM) 00128
3.3.2.26 Citizenship (ID) 00129
3.3.2.27 Veterans military status (CE) 00130
3.3.2.28 Usage notes: PID patient identification
3.3.3 PV1 - Patient visit -
3.3.3.1 Set ID - patient visit (SI) 00131
3.3.3.2 Patient class (ID) 00132
3.3.3.3 Assigned patient location (CM) 00133
3.3.3.4 Admission type (ID) 00134
3.3.3.5 Pre-admit number (ST) 00135
3.3.3.6 Prior patient location (CM) 00136
3.3.3.7 Attending doctor (CN) 00137
3.3.3.8 Referring doctor (CN) 00138
3.3.3.9 Consulting doctor (CN) 00139
3.3.3.10 Hospital service (ID) 00140
3.3.3.11 Temporary location (CM) 00141
3.3.3.12 Pre-admit test indicator (ID) 00142
3.3.3.13 Re-admission indicator (ID) 00143
3.3.3.14 Admit source (ID) 00144
3.3.3.15 Ambulatory status (ID) 00145
3.3.3.16 VIP indicator (ID) 00146
3.3.3.17 Admitting doctor (CN) 00147
3.3.3.18 Patient type (ID) 00148
3.3.3.19 Visit number (NM) 00149
3.3.3.20 Financial class (CM) 00150
3.3.3.21 Charge price indicator (ID) 00151
3.3.3.22 Courtesy code (ID) 00152
3.3.3.23 Credit rating (ID) 00153
3.3.3.24 Contract code (ID) 00154
3.3.3.25 Contract effective date (DT) 00155
3.3.3.26 Contract amount (NM) 00156
3.3.3.27 Contract period (NM) 00157
3.3.3.28 Interest code (ID) 00158
3.3.3.29 Transfer to bad debt code (ID) 00159
3.3.3.30 Transfer to bad debt date (DT) 00160
3.3.3.31 Bad debt agency code (ID) 00161
3.3.3.32 Bad debt transfer amount (NM) 00162
3.3.3.33 Bad debt recovery amount (NM) 00163
3.3.3.34 Delete account indicator (ID) 00164
3.3.3.35 Delete account date (DT) 00165
3.3.3.36 Discharge disposition (ID) 00166
3.3.3.37 Discharged to location (CM) 00167
3.3.3.38 Diet type (ID) 00168
3.3.3.39 Servicing facility (ID) 00169
3.3.3.40 Bed status (ID) 00170
3.3.3.41 Account status (ID) 00171
3.3.3.42 Pending location (CM) 00172
3.3.3.43 Prior temporary location (CM) 00173
3.3.3.44 Admit date/time (TS) 00174
3.3.3.45 Discharge date/time (TS) 00175
3.3.3.46 Current patient balance (NM) 00176
3.3.3.47 Total charges (NM) 00177
3.3.3.48 Total adjustments (NM) 00178
3.3.3.49 Total payments (NM) 00179
3.3.3.50 Alternate visit ID (CM) 00180
3.3.3.51 PV1 usage notes
3.3.4 PV2 - Patient visit - additional information
3.3.4.1 Prior pending location (CM) 00181
3.3.4.2 Accommodation code (CE) 00182
3.3.4.3 Admit reason (CE) 00183
3.3.4.4 Transfer reason (CE) 00184
3.3.4.5 Patient valuables (ST) 00185
3.3.4.6 Patient valuables location (ST) 00186
3.3.4.7 Visit user code (ID) 00187
3.3.4.8 Expected admit date (DT) 00188
3.3.4.9 Expected discharge date (DT) 00189
3.3.5 NK1 - Next of kin -
3.3.5.1 Set ID - next of kin (SI) 00190
3.3.5.2 Name (PN) 00191
3.3.5.3 Relationship (CE) 00192
3.3.5.4 Address (AD) 00193
3.3.5.5 Phone number (TN) 00194
3.3.5.6 Business phone number (TN) 00195
3.3.5.7 Contact role (CE) 00196
3.3.5.8 Start date (DT) 00197
3.3.5.9 End date (DT) 00198
3.3.5.10 Next of kin job title (ST) 00199
3.3.5.11 Next of kin job code/class (CM) 00200
3.3.5.12 Next of kin employee number (ST) 00201
3.3.5.13 Organization name (ST) 00202
3.3.6 AL1 - Patient allergy information
3.3.6.1 Set ID - allergy (SI) 00203
3.3.6.2 Allergy type (ID) 00204
3.3.6.3 Allergy code/mnemonic/description (CE) 00205
3.3.6.4 Allergy severity (ID) 00206
3.3.6.5 Allergy reaction (ST) 00207
3.3.6.6 Identification date (DT) 00208
3.3.7 NPU - Bed status update
3.3.7.1 Bed location (CM) 00209
3.3.7.2 Bed status (ID) 00170
3.3.8 MRG - Merge patient information -
3.3.8.1 Prior patient ID - internal (CM) 00211
3.3.8.2 Prior alternate patient ID (ST) 00212
3.3.8.3 Prior patient account number (CK) 00213
3.3.8.4 Prior patient ID - external (CK) 00214
3.3.8.5 Segment notes: MRG merge patient information
3.4 EXAMPLE TRANSACTIONS
3.4.1 Admit a patient - trigger event A01 (basic example) -
3.4.2 Merge patient information - trigger event A18 (basic example) -
3.4.3 Admit a patient - trigger event A01 (complex example)
3.5 IMPLEMENTATION CONSIDERATIONS
3.5.1 Swapping a patient
3.5.2 Merging patient/person information
3.5.3 Patient record links
3.6 OUTSTANDING ISSUES
4
4
Order Entry
4.1 OVERVIEW
4.1.1 Preface (organization of this chapter)
4.1.2 Glossary
4.2 ORDER MESSAGE DEFINTIONS
4.2.1 ORM - general order message -
4.2.1.1 ORM use notes
4.2.2 ORR - general order response message (response to any ORM)-
4.3 SEGMENTS COMMON TO ALL ORDERS
4.3.1 ORC - common order segment -
4.3.1.1 Order control (ID) 00215
4.3.1.1.1 Table notes for order control codes of ORC
4.3.1.2 Placer order number (CM) 00216
4.3.1.3 Filler order number (CM) 00217
4.3.1.4 Placer group number (CM) 00218
4.3.1.5 Order status (ID) 00219
4.3.1.6 Response flag (ID) 00220
4.3.1.7 Quantity/timing (TQ) 00221
4.3.1.8 Parent (CM) 00222
4.3.1.9 Date/time of transaction (TS) 00223
4.3.1.10 Entered by (CN) 00224
4.3.1.11 Verified by (CN) 00225
4.3.1.12 Ordering provider (CN) 00226
4.3.1.13 Enterer's location (CM) 00227
4.3.1.14 Call back phone number (TN) 00228
4.3.1.15 Order effective date/time (TS) 00229
4.3.1.16 Order control code reason (CE) 00230
4.3.1.17 Entering organization (CE) 00231
4.3.1.18 Entering device (CE) 00232
4.3.1.19 Action By (CN) 00233
4.3.2 BLG - Billing Segment
4.3.2.1 When to charge (CM) 00234
4.3.2.2 Charge type (ID) 00235
4.3.2.3 Account ID (CK) 00236
4.4 QUANTITY/TIMING (TQ) DEFINITION
4.4.1 Quantity component (CQ)
4.4.2 Interval component (CM)
4.4.2.1 Repeat Pattern
4.4.2.2 Explicit time interval subcomponent
4.4.3 Duration component
4.4.4 Start date/time component (TS)
4.4.5 End date/time component (TS)
4.4.6 Priority component (ID)
4.4.7 Condition component (ST)
4.4.8 Text component (TX)
4.4.9 Conjunction component (ID)
4.4.10 Order sequencing component (complex)
4.4.10.1 Subcomponents of Sequences
4.4.10.2 Cyclic placer order groups
4.4.10.3 Inheritance of order status
4.4.11 Examples of quantity/timing usage
4.5 OBSERVATION AND DIAGNOSTIC STUDY ORDERS
4.5.1 OBR - observation request segment -
4.5.1.1 Set ID - observation request (SI) 00237
4.5.1.2 Placer order number (CM) 00216
4.5.1.3 Filler order number (CM) 00217
4.5.1.4 Universal service ID (CE) 00238
4.5.1.5 Priority (ID) 00239
4.5.1.6 Requested date/time (TS) 00240
4.5.1.7 Observation date/time (TS) 00241
4.5.1.8 Observation end date/time (TS) 00242
4.5.1.9 Collection volume (CQ) 00243
4.5.1.10 Collector identifier (CN) 00244
4.5.1.11 Specimen action code (ID) 00245
4.5.1.12 Danger code (CE) 00535
4.5.1.13 Relevant clinical information (ST) 00247
4.5.1.14 Specimen received date/time (TS) 00248
4.5.1.15 Specimen source (CM) 00249
4.5.1.16 Ordering provider (CN) 00226
4.5.1.17 Order callback phone number (TN) 00250
4.5.1.18 Placer field #1 (ST) 00251
4.5.1.19 Placer field #2 (ST) 00252
4.5.1.20 Filler field #1 (ST) 00253
4.5.1.21 Filler field #2 (ST) 00254
4.5.1.22 Results rpt/status chng - date/time (TS) 00255
4.5.1.23 Charge to practice (CM) 00256
4.5.1.24 Diagnostic serv sect ID (ID) 00257
4.5.1.25 Result status (ID) 00258
4.5.1.26 Parent result (CM) 00259
4.5.1.27 Quantity/timing (TQ) 00221
4.5.1.28 Result copies to (CN) 00260
4.5.1.29 Parent number (CM) 00261
4.5.1.30 Transportation mode (ID) 00262
4.5.1.31 Reason for study (CE) 00263
4.5.1.32 Principal result interpreter (CM) 00264
4.5.1.33 Assistant result interpreter (CM) 00265
4.5.1.34 Technician (CM) 00266
4.5.1.35 Transcriptionist (CM) 00267
4.5.1.36 Scheduled - date/time (TS) 00268
4.5.2 Examples of use
4.5.2.1 An order replaced by three orders
4.6 DIET ORDERS
4.6.1 ODS - dietary orders, supplements, and preferences-
4.6.1.1 Type (ID) 00269
4.6.1.2 Service period (CE) 00270
4.6.1.3 Diet, supplement, or preference code (CE) 00271
4.6.1.4 Text instruction (ST) 00272
4.6.2 ODT - diet tray instructions segment -
4.6.2.1 Tray type (CE) 00273
4.6.2.2 Service period (CE) 00274
4.6.2.3 Text Instruction (ST) 00272
4.6.3 Example diet messages
4.6.3.1 Typical progression of orders for a surgery patient
4.6.3.2 Complex order
4.6.3.3 Tube feeding
4.6.3.4 Patient preference
4.7 SUPPLY ORDERS
4.7.1 RQD - requisition detail
4.7.1.1 Requisition line number (SI) 00275
4.7.1.2 Item code - internal (CE) 00276
4.7.1.3 Item code - external (CE) 00277
4.7.1.4 Hospital item code (CE) 00278
4.7.1.5 Requisition quantity (NM) 00279
4.7.1.6 Requisition unit of measure (CE) 00280
4.7.1.7 Dept. cost center (ID) 00281
4.7.1.8 Item natural account code (ID) 00282
4.7.1.9 Deliver to ID (CE) 00283
4.7.1.10 Date needed (DT) 00284
4.7.2 RQ1 - requisition detail-1 segment
4.7.2.1 Anticipated price (SI) 00285
4.7.2.2 Manufacturer ID (CE) 00286
4.7.2.3 Manufacturer's catalog (ST) 00287
4.7.2.4 Vendor ID (CE) 00288
4.7.2.5 Vendor catalog (ST) 00289
4.7.2.6 Taxable (ID) 00290
4.7.2.7 Substitute allowed (ID) 00291
4.7.3 Examples of the use of RQD and RQ1 segments
4.8 PHARMACY ORDERS
4.8.1 ORM - pharmacy prescription message
4.8.2 RXO - pharmacy prescription order segment
4.8.2.1 Requested give code (CE) 00292
4.8.2.2 Requested give amount - minimum (NM) 00293
4.8.2.3 Requested give amount - maximum (NM) 00294
4.8.2.4 Requested give units (CE) 00295
4.8.2.5 Requested dosage form (CE) 00296
4.8.2.6 Provider's pharmacy instructions (CE) 00297
4.8.2.7 Provider's administration instructions (CE) 00298
4.8.2.8 Deliver-to location (CM) 00299
4.8.2.9 Allow Substitution (ID) 00300
4.8.2.10 Requested dispense code (CE) 00301
4.8.2.11 Requested dispense amount (NM) 00302
4.8.2.12 Requested dispense units (CE) 00303
4.8.2.13 Number of refills (NM) 00304
4.8.2.14 Ordering Provider's DEA number (CN) 00305
4.8.2.15 Pharmacist verifier ID (CN) 00306
4.8.2.16 Needs human review (ID) 00307
4.8.2.17 Requested give per (time unit) (ST) 00308
4.8.3 RXR - pharmacy route segment
4.8.3.1 Route (CE) 00309
4.8.3.2 Administrative site (CE) 00310
4.8.3.3 Administration device (CE) 00311
4.8.3.4 Administration method (CE) 00312
4.8.4 RXC - Pharmacy component order segment
4.8.4.1 RX component type (ID) 00313
4.8.4.2 Component code (CE) 00314
4.8.4.3 Component amount (NM) 00315
4.8.4.4 Component units (CE) 00316
4.8.5 IV solution groups
4.8.6 RDE message: pharmacy encoded order
4.8.7 RXE - Pharmacy encoded order segment
4.8.7.1 Quantity/timing (TQ) 00221
4.8.7.2 Give code (CE) 00317
4.8.7.3 Give amount - minimum (NM) 00318
4.8.7.4 Give amount - maximum (NM) 00319
4.8.7.5 Give units (CE) 00320
4.8.7.6 Give dosage form (CE) 00321
4.8.7.7 Provider's administration instructions (CE) 00298
4.8.7.8 Deliver-to location (CM) 00299
4.8.7.9 Substitution Status (ID) 00322
4.8.7.10 Dispense amount (NM) 00323
4.8.7.11 Dispense units (CE) 00324
4.8.7.12 Number of refills (NM) 00304
4.8.7.13 Ordering Provider's DEA number (CN) 00305
4.8.7.14 Pharmacist verifier ID (CN) 00306
4.8.7.15 Prescription number (ST) 00325
4.8.7.16 Number of refills remaining (NM) 00326
4.8.7.17 Number of refills/doses dispensed (NM) 00327
4.8.7.18 D/T of most recent refill or dose dispensed (TS) 00328
4.8.7.19 Total daily dose (CQ) 00329
4.8.7.20 Needs human review (ID) 00307
4.8.7.21 Pharmacy special dispensing instructions (CE) 00330
4.8.7.22 Give per (time unit) as encoded by the pharmacy (ST) 00331
4.8.7.23 Give rate amount (CE) 00332
4.8.7.24 Give rate units (ST) 00333
4.8.8 Usage notes for Pharmacy messages
4.8.9 RDS - Pharmacy dispense message
4.8.10 RXD - Pharmacy dispense segment
4.8.10.1 Dispense sub-ID counter (NM) 00334
4.8.10.2 Dispense/give code (CE) 00335
4.8.10.3 Date/time dispensed (TS) 00336
4.8.10.4 Actual dispense amount (NM) 00337
4.8.10.5 Actual dispense units (CE) 00338
4.8.10.6 Actual dosage form (CE) 00339
4.8.10.7 Prescription number (NM) 00325
4.8.10.8 Number of refills remaining (NM) 00326
4.8.10.9 Dispense notes (ST) 00340
4.8.10.10 Dispensing provider (CN) 00341
4.8.10.11 Substitution status (ID) 00342
4.8.10.12 Total daily dose (NM) 00328
4.8.10.13 Dispense-to location (CM) 00299
4.8.10.14 Needs human review (ID) 00307
4.8.10.15 Pharmacy special dispensing instructions (CE) 00330
4.8.11 RGV - pharmacy give message
4.8.12 RXG - pharmacy give segment
4.8.12.1 Give sub-ID counter (NM) 00342
4.8.12.2 Dispense sub-ID (NM) 00334
4.8.12.3 Quantity/timing (TQ) 00221
4.8.12.4 Give code (CE) 00317
4.8.12.5 Give amount - minimum (NM) 00318
4.8.12.6 Give amount - maximum (NM) 00319
4.8.12.7 Give units (CE) 00320
4.8.12.8 Give dosage form (CE) 00321
4.8.12.9 Administration notes (CE) 00343
4.8.12.10 Substitution status (ID) 00322
4.8.12.11 Dispense-to location (CM) 00299
4.8.12.12 Needs human review (ID) 00307
4.8.12.13 Pharmacy special administration instructions (CE) 00344
4.8.12.14 Give per (time unit) (ST) 00331
4.8.12.15 Give rate amount (ST) 00332
4.8.12.16 Give rate units (CE) 00333
4.8.13 RAS - pharmacy administration message
4.8.14 RXA - pharmacy administration segment
4.8.14.1 Give sub-ID counter (NM) 00342
4.8.14.2 Administration sub-ID counter (NM) 00344
4.8.14.3 Date/time start of administration (TS) 00345
4.8.14.4 Date/time end of administration (if applies) (TS) 00346
4.8.14.5 Administered code (CE) 00347
4.8.14.6 Administered amount (NM) 00348
4.8.14.7 Administered units (CE) 00349
4.8.14.8 Administered dosage form (CE) 00350
4.8.14.9 Administration notes (CE) 00351
4.8.14.10 Administering provider (CN) 00352
4.8.14.11 Administered at location (CM) 00353
4.8.14.12 Administered per (time unit) (ST) 00354
4.8.15 Pharmacy queries
4.8.16 Examples of use
4.8.16.1 Example of various levels of coding in an order
4.8.16.2 Custom IV example
4.8.16.3 Other examples - responses to queries
4.9 OUTSTANDING ISSUES
4.10 HL7 PHARMACY ORDERS AND RESULTS
4.10.1 Pharmacy orders and results transaction flow diagram
5
5
Query
5.1
6
6
6.1 PURPOSE
6.2 PATIENT ACCOUNTING MESSAGE SET
6.3 TRIGGER EVENTS AND MESSAGE DEFINITIONS
6.3.1 Add and update patient accounts (event code P01)
6.3.2 Purge patient accounts (event code P02)
6.3.3 Post detail financial transactions (event code P03)
6.3.4 Generate bills and accounts receivable statements (event code P04)
6.4 MESSAGE SEGMENTS
6.4.1 FT1 - financial transaction-
6.4.1.1 Set ID - financial transaction (SI) 00355
6.4.1.2 Transaction ID (ST) 00356
6.4.1.3 Transaction batch ID (ST) 00357
6.4.1.4 Transaction date (DT) 00358
6.4.1.5 Transaction posting date (DT) 00359
6.4.1.6 Transaction type (ID) 00360
6.4.1.7 Transaction code (CE) 00361
6.4.1.8 Transaction description (ST) 00362
6.4.1.9 Transaction description - alt (ST) 00363
6.4.1.10 Transaction quantity (NM) 00364
6.4.1.11 Transaction amount - extended (NM) 00365
6.4.1.12 Transaction amount - unit (NM) 00366
6.4.1.13 Department code (CE) 00367
6.4.1.14 Insurance plan ID (ID) 00368
6.4.1.15 Insurance amount (NM) 00369
6.4.1.16 Assigned patient location (CM) 00133
6.4.1.17 Fee schedule (ID) 00370
6.4.1.18 Patient type (ID) 00148
6.4.1.19 Diagnosis code (CE) 00371
6.4.1.20 Performed by code (CN) 00372
6.4.1.21 Ordered by code (CN) 00373
6.4.1.22 Unit cost (NM) 00374
6.4.1.23 Filler order number (CM) 00217
6.4.2 DG1 - Diagnosis -
6.4.2.1 Set ID - diagnosis (SI) 00375
6.4.2.2 Diagnosis coding method (ID) 00376
6.4.2.3 Diagnosis code (ID) 00377
6.4.2.4 Diagnosis description (ST) 00378
6.4.2.5 Diagnosis date/time (TS) 00379
6.4.2.6 Diagnosis/DRG type (ID) 00380
6.4.2.7 Major diagnostic category (CE) 00381
6.4.2.8 Diagnostic related group (ID) 00382
6.4.2.9 DRG approval indicator (ID) 00383
6.4.2.10 DRG grouper review code (ID) 00384
6.4.2.11 Outlier type (ID) 00385
6.4.2.12 Outlier days (NM) 00386
6.4.2.13 Outlier cost (NM) 00387
6.4.2.14 Grouper version and type (ST) 00388
6.4.2.15 Diagnosis/DRG priority (NM) 00389
6.4.2.16 Diagnosing clinician (CN) 00390
6.4.3 PR1 - Procedures -
6.4.3.1 Set ID - procedure (SI) 00391
6.4.3.2 Procedure coding method (ID) 00392
6.4.3.3 Procedure code (ID) 00393
6.4.3.4 Procedure description (ST) 00394
6.4.3.5 Procedure date/time (TS) 00395
6.4.3.6 Procedure type (ID) 00396
6.4.3.7 Procedure minutes (NM) 00397
6.4.3.8 Anesthesiologist (CN) 00398
6.4.3.9 Anesthesia code (ID) 00399
6.4.3.10 Anesthesia minutes (NM) 00400
6.4.3.11 Surgeon (CN) 00401
6.4.3.12 Procedure Practitioner (CM) 00402
6.4.3.13 Consent code (ID) 00403
6.4.3.14 Procedure priority (NM) 00404
6.4.4 GT1 - guarantor -
6.4.4.1 Set ID - guarantor (SI) 00405
6.4.4.2 Guarantor number (CK) 00406
6.4.4.3 Guarantor name (PN) 00407
6.4.4.4 Guarantor spouse name (PN) 00408
6.4.4.5 Guarantor address (AD) 00409
6.4.4.6 Guarantor ph num - home (TN) 00410
6.4.4.7 Guarantor ph. num-business (TN) 00411
6.4.4.8 Guarantor date of birth (DT) 00412
6.4.4.9 Guarantor sex (ID) 00413
6.4.4.10 Guarantor type (ID) 00414
6.4.4.11 Guarantor relationship (ID) 00415
6.4.4.12 Guarantor SSN (ST) 00416
6.4.4.13 Guarantor date - begin (DT) 00417
6.4.4.14 Guarantor date - end (DT) 00418
6.4.4.15 Guarantor priority (NM) 00419
6.4.4.16 Guarantor employer name (ST) 00420
6.4.4.17 Guarantor employer address (AD) 00421
6.4.4.18 Guarantor employ phone number (TN) 00422
6.4.4.19 Guarantor employee ID num (ST) 00423
6.4.4.20 Guarantor employment status (ID) 00424
6.4.4.21 Guarantor organization (ST) 00425
6.4.5 IN1 - insurance -
6.4.5.1 Set ID - insurance (SI) 00426
6.4.5.2 Insurance plan ID (ST) 00427
6.4.5.3 Insurance company ID (ST) 00428
6.4.5.4 Insurance company name (ST) 00429
6.4.5.5 Insurance company address (AD) 00430
6.4.5.6 Insurance co contact pers (PN) 00431
6.4.5.7 Insurance co phone number (TN) 00432
6.4.5.8 Group number (ST) 00433
6.4.5.9 Group name (ST) 00434
6.4.5.10 Insured's group emp. ID (ST) 00435
6.4.5.11 Insured's group emp name (ST) 00436
6.4.5.12 Plan effective date (DT) 00437
6.4.5.13 Plan expiration date (DT) 00438
6.4.5.14 Authorization information (CM) 00439
6.4.5.15 Plan type (ID) 00440
6.4.5.16 Name of insured (PN) 00441
6.4.5.17 Insured's relationship to patient (ID) 00442
6.4.5.18 Insured's date of birth (DT) 00443
6.4.5.19 Insured's address (AD) 00444
6.4.5.20 Assignment of benefits (ID) 00445
6.4.5.21 Coordination of benefits (ID) 00446
6.4.5.22 Coord of ben priority (ST) 00447
6.4.5.23 Notice of admission code (ID) 00448
6.4.5.24 Notice of admission date (DT) 00449
6.4.5.25 Rpt of eligibility code (ID) 00450
6.4.5.26 Rpt of eligibility date (DT) 00451
6.4.5.27 Release information code (ID) 00452
6.4.5.28 Pre-admit cert. (PAC) (ST) 00453
6.4.5.29 Verification date/time (TS) 00454
6.4.5.30 Verification by (CN) 00455
6.4.5.31 Type of agreement code (ID) 00456
6.4.5.32 Billing status (ID) 00457
6.4.5.33 Lifetime reserve days (NM) 00458
6.4.5.34 Delay before LR Day (NM) 00459
6.4.5.35 Company plan code (ID) 00460
6.4.5.36 Policy number (ST) 00461
6.4.5.37 Policy deductible (NM) 00462
6.4.5.38 Policy limit - amount (NM) 00463
6.4.5.39 Policy limit - days (NM) 00464
6.4.5.40 Room rate - semi-private (NM) 00465
6.4.5.41 Room rate - private (NM) 00466
6.4.5.42 Insured's employment status (CE) 00467
6.4.5.43 Insured's sex (ID) 00468
6.4.5.44 Insured's employer address (AD) 00469
6.4.5.45 Verification status (ST) 00470
6.4.5.46 Prior insurance plan ID (ID) 00471
6.4.6 IN2 - insurance additional info -
6.4.6.1 Insured's employee ID (ST) 00472
6.4.6.2 Insured's social security number (NM) 00473
6.4.6.3 Insured's employer name (CN) 00474
6.4.6.4 Employer information data (ID) 00475
6.4.6.5 Mail claim party (ID) 00476
6.4.6.6 Medicare health ins card number (NM) 00477
6.4.6.7 Medicaid case name (PN) 00478
6.4.6.8 Medicaid case number (NM) 00479
6.4.6.9 Champus sponsor name (PN) 00480
6.4.6.10 Champus ID number (NM) 00481
6.4.6.11 Dependent of champus recipient (ID) 00482
6.4.6.12 Champus organization (ST) 00483
6.4.6.13 Champus station (ST) 00484
6.4.6.14 Champus service (ID) 00485
6.4.6.15 Champus rank/grade (ID) 00486
6.4.6.16 Champus status (ID) 00487
6.4.6.17 Champus retire date (DT) 00488
6.4.6.18 Champus non-avail cert on file (ID) 00489
6.4.6.19 Baby coverage (ID) 00490
6.4.6.20 Combine baby bill (ID) 00491
6.4.6.21 Blood deductible (NM) 00492
6.4.6.22 Special coverage approval name (PN) 00493
6.4.6.23 Special coverage approval title (ST) 00494
6.4.6.24 Non-covered insurance code (ID) 00495
6.4.6.25 Payor ID (ST) 00496
6.4.6.26 Payor subscriber ID (ST) 00497
6.4.6.27 Eligibility source (ID) 00498
6.4.6.28 Room coverage type/amount (CM) 00499
6.4.6.29 Policy type/amount (CM) 00500
6.4.6.30 Daily deductible (CM) 00501
6.4.7 IN3 - insurance additional info - certification -
6.4.7.1 Set ID - insurance certification (SI) 00502
6.4.7.2 Certification number (ST) 00503
6.4.7.3 Certified by (CN) 00504
6.4.7.4 Certification required (ID) 00505
6.4.7.5 Penalty (CM) 00506
6.4.7.6 Certification date/time (TS) 00507
6.4.7.7 Certification modify date/time (TS) 00508
6.4.7.8 Operator (CN) 00509
6.4.7.9 Certification begin date (DT) 00510
6.4.7.10 Certification end date (DT) 00511
6.4.7.11 Days (CM) 00512
6.4.7.12 Non-concur code/desc (CE) 00513
6.4.7.13 Non-concur eff date/time (TS) 00514
6.4.7.14 Physician reviewer (CN) 00515
6.4.7.15 Certification contact (ST) 00516
6.4.7.16 Certification contact phone number (TN) 00517
6.4.7.17 Appeal reason (CE) 00518
6.4.7.18 Certification agency (CE) 00519
6.4.7.19 Certification agency phone number (TN) 00520
6.4.7.20 Pre-certification req/window (CM) 00521
6.4.7.21 Case manager (ST) 00522
6.4.7.22 Second opinion date (DT) 00523
6.4.7.23 Second opinion status (ID) 00524
6.4.7.24 Second opinion documentation received (ID) 00525
6.4.7.25 Second opinion practitioner (CN) 00526
6.4.8 ACC - accident -
6.4.8.1 Accident date/time (TS) 00527
6.4.8.2 Accident code (ID) 00528
6.4.8.3 Accident location (ST) 00529
6.4.9 UB1 - UB82 data -
6.4.9.1 Set ID - UB82 (SI) 00530
6.4.9.2 Blood deductible (NM) 00531
6.4.9.3 Blood furn-pints of (40) (NM) 00532
6.4.9.4 Blood replaced-pints (41) (NM) 00533
6.4.9.5 Blood not rplcd-pints(42) (NM) 00534
6.4.9.6 Co-insurance days (25) (NM) 00535
6.4.9.7 Condition code (ID) 00536
6.4.9.8 Covered days - (23) (NM) 00537
6.4.9.9 Non covered days - (24) (NM) 00538
6.4.9.10 Value amount & code (CM) 00539
6.4.9.11 Number of grace days (90) (NM) 00540
6.4.9.12 Spec program indicator (44) (ID) 00541
6.4.9.13 PSRO/UR approval indicator (87) (ID) 00542
6.4.9.14 PSRO/UR aprvd stay-fm (88) (DT) 00543
6.4.9.15 PSRO/UR aprvd stay-to (89) (DT) 00544
6.4.9.16 Occurrence (28-32) (CM) 00545
6.4.9.17 Occurrence span (33) (ID) 00546
6.4.9.18 Occur span start date (33) (DT) 00547
6.4.9.19 Occur. Span end date (33) (DT) 00548
6.4.9.20 UB-82 locator 2 (ST) 00549
6.4.9.21 UB-82 locator 9 (ST) 00550
6.4.9.22 UB-82 locator 27 (ST) 00551
6.4.9.23 UB-82 locator 45 (ST) 00552
6.4.10 UB2 - UB92 data -
6.4.10.1 Set ID - UB92 (SI) 00553
6.4.10.2 Co-insurance days (ST) 00554
6.4.10.3 Condition code (ID) 00555
6.4.10.4 Covered days (ST) 00556
6.4.10.5 Non-covered days (ST) 00557
6.4.10.6 Value amount & code (CM) 00558
6.4.10.7 Occurrence code & date (CM) 00559
6.4.10.8 Occurrence span code and dates (CM) 00560
6.4.10.9 UB92 data element 2, designated for state use (ST) 00561
6.4.10.10 UB92 data element 11, designated for state use (ST) 00562
6.4.10.11 UB92 data element 31, designated for national use (ST) 00563
6.4.10.12 Document control number (ST) 00564
6.4.10.13 UB92 data element 49, designated for national use (ST) 00565
6.4.10.14 UB92 data element 56, designated for state use (ST) 00566
6.4.10.15 UB92 data element 57, designated for national use (ST) 00567
6.4.10.16 UB92 data element 78, designated for state use (ST) 00568
6.5 EXAMPLE TRANSACTIONS
6.5.1 Create a patient billing/accounts receivable record
6.5.2 UB82 information updated from utilization review department
6.5.3 Diagnosis and DRG assignment
6.6 IMPLEMENTATION CONSIDERATIONS
6.7 OUTSTANDING ISSUES
7
7
7.1 INTRODUCTION AND OVERVIEW
7.1.1 Glossary
7.1.2 Narrative reports as batteries with many OBX results
7.1.3 Suffixes for defining observation IDs for common components of narrative reports
7.1.3.1 Diagnostic impressions (IMP)
7.1.3.2 Recommendations (REC)
7.1.3.3 Confirming procedure (CNP)
7.1.3.4 Procedure medication (MED)
7.1.3.5 Anatomic site (ANT)
7.1.3.6 Devices (DEV)
7.1.3.7 Gross or general description (GDT)
7.1.3.8 Secondary or microscopic description (MDT)
7.1.3.9 Technician comment (TCM)
7.1.3.10 Addendum note (ADT)
7.1.3.11 Diagnosis (problem) onset date-time (ITM).
7.1.3.12 Diagnosis (problem) resolution date-time (RTM).
7.1.3.13 Comparison study (CMS)
7.1.3.14 Comparison date-time (CMT)
7.1.3.15 Comparison results (CMR)
7.1.3.16 Comparison change (CMC)
7.1.3.17 Predicted (PRD)
7.1.3.18 Percent of predicted (PPR)
7.1.3.19 After drug observed (AFD)
7.1.3.20 Predicted value after drug (ADP)
7.1.3.21 Percent predicted after drug (APP)
7.1.3.22 Expanded AS4 codes
7.1.4 Identifying reporting units
7.1.4.1 Background
7.1.4.2 ISO and ANSI customary units abbreviations
7.1.4.3 Local unit codes
7.2 MESSAGE DEFINITIONS
7.2.1 ORU - unsolicited transmission of an observation
7.2.2 Query for results of observation
7.2.2.1 Query usage notes
7.3 SEGMENTS
7.3.1 OBR - Observation request -
7.3.2 OBX - Observation/Result segment -
7.3.2.1 Set ID - observation simple (SI) 00569
7.3.2.2 Value type (ID) 00570
7.3.2.3 Observation Identifier (CE) 00571
7.3.2.4 Observation Sub-ID (ST) 00572
7.3.2.5 Observation value (*) 00573
7.3.2.6 Units (CE) 00574
7.3.2.7 References range (ST) 00575
7.3.2.8 Abnormal flags (ID) 00576
7.3.2.9 Probability (NM) 00577
7.3.2.10 Nature of abnormal test (ID) 00578
7.3.2.11 Observ result status (ID) 00579
7.3.2.12 Effective date last obs normal value (TS) 00580
7.3.2.13 User defined access checks (ST) 00581
7.3.2.14 Date-time of the observation (TS) 00582
7.3.2.15 Producer's ID (CE) 00583
7.3.2.16 Responsible Observer (CN) 00584
7.4 EXAMPLE TRANSACTIONS
7.4.1 Query/response
7.4.2 Unsolicited
7.4.3 Example message (from ASTM 1238-91)
7.4.4 Example of narrative report messages (from ASTM 1238-91)
7.4.5 Reporting cultures and sensitivities
7.4.5.1 Culture battery/report representation
7.4.5.2 Sensitivity battery/report representation
7.4.5.3 Identification of the organism for a sensitivity battery
7.4.6 Results reporting
7.4.7 Patient-specific clinical data with an order -
7.5 OUTSTANDING ISSUES
7.6 (Informative) Universal (AS4) Identifiers for Common Test Battery
7.6.1 Components That Do Not Have Uniquely Defined CPT-4 Codes -
7.6.2 General Approach
7.6.3 Message Structure
7.6.4 OM1 - General Segment (Fields That Apply to Most Observations)
7.6.4.1 Segment Type ID (ST) 00585
7.6.4.2 Sequence Number (NM) 00586
7.6.4.3 Producer's Test/Observation ID (CE) 00587
7.6.4.4 Permitted Data Types (ID) 00588
7.6.4.5 Specimen Required (ID) 00589
7.6.4.6 Producer ID (CE) 00590
7.6.4.7 Observation Description (TX) 00591
7.6.4.8 Other Test/Observation IDs for the Observation (CE) 00592
7.6.4.9 Other Names (Recognized by the Producer for the Observation) (ST) 00593
7.6.4.10 Preferred Report Name for the Observation (ST) 00594
7.6.4.11 Preferred Short Name or Mnemonic for the Observation (ST) 00595
7.6.4.12 Preferred Long Name for the Observation (ST) 00596
7.6.4.13 Orderability (ID) 00597
7.6.4.14 Identity of Instrument Used to Perform This Study (CE) 00598
7.6.4.15 Coded Representation of Method (CE) 00599
7.6.4.16 Portable (ID) 00600
7.6.4.17 Observation Producing Department/Section (ID) 00601
7.6.4.18 Telephone Number of Section (TN) 00602
7.6.4.19 Nature of Test/Observation (ID) 00603
7.6.4.20 Report Subheader (CE) 00604
7.6.4.21 Report Display Order (ST) 00605
7.6.4.22 Date/Time Stamp for Any Change in Definition for the Observation (TS) 00606
7.6.4.23 Effective Date/Time of Change in Test Procedure That Make Results Non-Comparable (TS) 00607
7.6.4.24 Typical Turn-around Time from Receipt of Specimen/Subject to Result Produced (NM) 00608
7.6.4.25 Processing Time (NM) 00609
7.6.4.26 Processing Priority (ID) 00610
7.6.4.27 Reporting Priority (ID) 00611
7.6.4.28 Outside Site(s) Where Observation May Be Performed (CE) 00612
7.6.4.29 Address of Outside Site(s) (AD) 00613
7.6.4.30 Phone number of outside site (TN) 00614
7.6.4.31 Confidentiality Code (ID) 00615
7.6.4.32 Observations Required to Interpret This Observation (CE) 00616
7.6.4.33 Interpretation of Observations (TX) 00617
7.6.4.34 Contraindications to Observations (CE) 00618
7.6.4.35 Reflex Tests/Observations (CE) 00619
7.6.4.36 Rules That Trigger Reflex Testing (TX) 00620
7.6.4.37 Fixed Canned Message (CE) 00621
7.6.4.38 Patient Preparation (TX) 00622
7.6.4.39 Procedure Medication (CE) 00623
7.6.4.40 Factors That May Effect the Observation (TX) 00624
7.6.4.41 Test/Observation Performance Schedule (ST) 00625
7.6.4.42 Description of Test Methods (May Include Bibliographic Citations) (TX) 00626
7.6.5 OM2 - Numeric Observation Segment
7.6.5.1 Segment Type ID (ST) 00585
7.6.5.2 Sequence Number (NM) 00586
7.6.5.3 Units of Measure (CE) 00627
7.6.5.4 Range and Decimal Precision (NM) 00628
7.6.5.5 Corresponding SI Units of Measure (CE) 00629
7.6.5.6 SI Conversion Factor (TX) 00630
7.6.5.7 Reference (Normal) Range for Ordinal and Continuous Observations (CM) 00631
7.6.5.7.1 The Reference (Normal) Range
7.6.5.7.2 Sex
7.6.5.7.3 Age Range
7.6.5.7.4 Gestational Age Range
7.6.5.7.5 Species
7.6.5.7.6 Race/Subspecies
7.6.5.7.7 Conditions
7.6.5.7.8 Examples
7.6.5.8 Critical Range for Ordinal and Continuous Observations (CM) 00632
7.6.5.9 Absolute Range for Ordinal and Continuous Observations (CM) 00633
7.6.5.10 Delta Check Criteria (CM) 00634
7.6.5.11 Minimum Meaningful Increments (NM) 00635
7.6.6 OM3 - Categorical Test/Observation Segment
7.6.6.1 Segment Type ID (ST) 00585
7.6.6.2 Sequence Number (NM) 00586
7.6.6.3 Preferred Coding System (ID) 00636
7.6.6.4 Valid Coded "Answers" (CE) 00637
7.6.6.5 Normal Text/Codes for Categorical Observations (CE) 00638
7.6.6.6 Abnormal Text/Codes for Categorical Observations (CE) 00639
7.6.6.7 Critical Abnormal Text/Codes for Categorical Observations (CE) 00640
7.6.6.8 Data Type (ID) 00641
7.6.7 OM4 - Observations That Require Specimens
7.6.7.1 Segment Type ID (ST) 00585
7.6.7.2 Sequence Number (NM) 00586
7.6.7.3 Derived Specimen (ID) 00642
7.6.7.4 Container Description (TX) 00643
7.6.7.5 Container Volume (NM) 00644
7.6.7.6 Container Units (CE) 00645
7.6.7.7 Specimen (CE) 00646
7.6.7.8 Additive (CE) 00647
7.6.7.9 Preparation (TX) 00648
7.6.7.10 Special Handling Requirements (TX) 00649
7.6.7.11 Normal Collection Volume (CQ) 00650
7.6.7.12 Minimum Collection Volume (CQ) 00651
7.6.7.13 Specimen Requirements (TX) 00652
7.6.7.14 Specimen Priorities (ID) 00653
7.6.7.15 Specimen Retention Time (CQ) 00654
7.6.8 OM5 - Observation Batteries (Sets)
7.6.8.1 Segment Type ID (ST) 00585
7.6.8.2 Sequence Number (NM) 00586
7.6.8.3 Tests/Observations Included Within an Ordered Test Battery (CE) 00655
7.6.8.4 Observation ID Suffixes (ST) 00656
7.6.9 OM6 - Observations That Are Calculated from Other Observations
7.6.9.1 Segment Type ID (ST) 00585
7.6.9.2 Sequence Number (NM) 00586
7.6.9.3 Derivation Rule (TX) 00657
8
8
Master Files
8.1 PURPOSE
8.2 TRIGGER EVENTS
8.3 MESSAGES
8.3.1 MFN - master files notification
8.3.2 MFD - master files delayed application acknowledgement
8.3.3 MFQ - master files query
8.3.3.1 MFQ use notes
8.4 SEGMENT DEFINITIONS
8.4.1 MFI - master file identification segment
8.4.1.1 Master file identifier (CE) 00658
8.4.1.2 Master files application identifier (ID) 00659
8.4.1.3 File-level event code (ID) 00660
8.4.1.4 Entered date/time (TS) 00661
8.4.1.5 Effective date/time (TS) 00662
8.4.1.6 Response level code (ID) 00663
8.4.2 MFE - master file entry segment
8.4.2.1 Record-level event code (ID) 00664
8.4.2.2 MFN control ID (ST) 00665
8.4.2.3 Effective date/time (TS) 00662
8.4.2.4 Primary key value (CE) 00667
8.4.3 MFA - master file acknowledgement segment
8.4.3.1 Record-level event code (ID) 00664
8.4.3.2 MFN control ID (ST) 00665
8.4.3.3 Completion date/time (TS) 00668
8.4.3.4 Error return code and/or text (CE) 00669
8.4.3.5 Primary key value (CE) 00670
8.5 EXAMPLES
8.5.1 ZL7 segment (proposed example only)
8.5.1.1 HL7 table entry for table xxxx (CE) xxxxx
8.5.1.2 Display-sort-key (NM) xxxxx
8.5.2 MFN message with original acknowledgement mode
8.5.3 Enhanced mode application level acknowledgement to the MFN message
8.5.3.1 Initial message with accept acknowledgement
8.5.3.2 Enhanced mode application acknowledgement message
8.5.4 Delayed application level acknowledgement
8.5.4.1 Initial message with accept acknowledgement
8.5.4.2 Deferred application acknowledgement message
8.6 OUTSTANDING ISSUES
9 .APPENDIX A:
9.1 Staff and practitioner master file segments
9.1.1 STF - staff identification segment
9.1.1.1 STF - primary key value (CE) 00671
9.1.1.2 Staff ID code (CE) 00672
9.1.1.3 Staff name (PN) 00673
9.1.1.4 Staff type (ID) 00674
9.1.1.5 Sex (ID) 00111
9.1.1.6 Date of birth (TS) 00110
9.1.1.7 Active/inactive (ID) 00675
9.1.1.8 Department (CE) 00676
9.1.1.9 Service (CE) 00677
9.1.1.10 Phone (TN) 00678
9.1.1.11 Office/home address (AD) 00679
9.1.1.12 Activation date (CM) 00680
9.1.1.13 Inactivation date (CM) 00681
9.1.1.14 Backup person ID (CE) 00682
9.1.1.15 E-mail address (ST) 00683
9.1.1.16 Preferred method of contact (ID) 00684
9.1.2 PRA - practitioner detail segment
9.1.2.1 PRA - primary key value (ST) 00685
9.1.2.2 Practitioner group (CE) 00686
9.1.2.3 Practitioner category (ID) 00687
9.1.2.4 Provider billing (ID) 00688
9.1.2.5 Specialty (CM) 00689
9.1.2.6 Practitioner ID numbers (CM) 00690
9.1.2.7 Privileges (CM) 00691
9.1.3 Example: Doctor Master File MFN message