HL7 V2.4 Contents

HL7 V2.4 Chapter 1

• 1. Introduction
  • 1.1 CHAPTER 1 CONTENTS
  • 1.2 PURPOSE
  • 1.3 BACKGROUND
  • 1.4 NEED FOR A STANDARD
  • 1.5 GOALS OF THE STANDARD
  • 1.6 HISTORY OF HL7 DEVELOPMENT
  • 1.7 OVERVIEW
    • 1.7.1 HL7 encoding rules
    • 1.7.2 Local variations
    • 1.7.3 Evolutionary changes to the standards
    • 1.7.4 Applicability to file transfers (batch processing)
    • 1.7.5 Relationship to other protocols
      • 1.7.5.1 Lower layer protocols
      • 1.7.5.2 Other application protocols
  • 1.8 THE SCOPE OF HL7
    • 1.8.1 A complete solution
    • 1.8.2 Protection of healthcare information
    • 1.8.3 Department of Defense (DOD) requirements for systems security and robustness
    • 1.8.4 Enforcement of organizational security and access control policies
    • 1.8.5 Security classifications (markings) and users authentication and identification
    • 1.8.6 Roles and relationships
    • 1.8.7 Accountability, audit trails and assigned responsibility
    • 1.8.8 Central, unified hardware, software controls for security and trusted continuous protection
    • 1.8.9 Uniform data definition and data architecture
    • 1.8.10 Controlled disclosure, notification of disclosed information as protected and tracking exceptions of protected health information
    • 1.8.11 Tracking of corrections, amendments or refusals to correct or amend protected health information
    • 1.8.12 Disclosure of disidentified health information
    • 1.8.13 Ensuring and tracking data source authentication and non-alterability
    • 1.8.14 Tracking input validation
    • 1.8.15 The longitudinal health record
    • 1.8.16 Integration of the health record
    • 1.8.17 Data, clock synchrony
    • 1.8.18 Intersystem database record locking and transaction processing
    • 1.8.19 Operations, process and other "local" support
    • 1.8.20 Interface engines
    • 1.8.21 Rules engines
    • 1.8.22 Infrastructure based applications
    • 1.8.23 Support for secondary clinical records
  • 1.9 REFERENCE DOCUMENTS
    • 1.9.1 ANSI standards
    • 1.9.2 ISO standards
    • 1.9.3 Codes and terminology sources
    • 1.9.4 Other applicable documents
  • 1.10 TECHNICAL EDITORS
  • 1.11 SUGGESTIONS AND COMMENTS

HL7 V2.4 Chapter 2

• 2 .Control
  • 2.1 CHAPTER 2 CONTENTS
  • 2.2 INTRODUCTION
  • 2.3 CONCEPTUAL APPROACH
    • 2.3.1 Trigger events
    • 2.3.2 Acknowledgments: original mode
    • 2.3.3 Acknowledgments: enhanced mode
    • 2.3.4 Queries
  • 2.4 COMMUNICATIONS ENVIRONMENT
  • 2.5 HL7 MESSAGES
  • 2.6 SEGMENTS
  • 2.7 FIELDS
    • 2.7.1 Position (sequence within the segment)
    • 2.7.2 Maximum length
    • 2.7.3 Data type
    • 2.7.4 Optionality
    • 2.7.5 Repetition
    • 2.7.6 Table
    • 2.7.7 ID number
    • 2.7.8 Name
  • 2.8 MESSAGE DELIMITERS
  • 2.9 DATA TYPES
    • 2.9.1 AD - address
      • 2.9.1.1 Street address (ST)
      • 2.9.1.2 Other designation (ST)
      • 2.9.1.3 City (ST)
      • 2.9.1.4 State or province (ST)
      • 2.9.1.5 Zip or postal code (ST)
      • 2.9.1.6 Country (ID)
      • 2.9.1.7 Address type (ID)
      • 2.9.1.8 Other geographic designation (ST)
    • 2.9.2 CD - channel definition
    • 2.9.3 CE - coded element
      • 2.9.3.1 Identifier (ST)
      • 2.9.3.2 Text (ST)
      • 2.9.3.3 Name of coding system (IS)
      • 2.9.3.4 Alternate identifier (ST)
      • 2.9.3.5 Alternate text (ST)
      • 2.9.3.6 Name of alternate coding system (IS)
    • 2.9.4 CF - coded element with formatted values
    • 2.9.5 CK - composite ID with check digit
      • 2.9.5.1 ID number (NM)
      • 2.9.5.2 Check digit (NM)
      • 2.9.5.3 Code identifying the check digit scheme employed (ID)
      • 2.9.5.4 Assigning authority (HD)
    • 2.9.6 CM - composite
    • 2.9.7 CN - composite ID number and name
      • 2.9.7.1 ID number (ST)
      • 2.9.7.2 Family name (FN)
      • 2.9.7.3 Given name (ST)
      • 2.9.7.4 second and further given names or initials thereof (ST)
      • 2.9.7.5 Suffix (ST)
      • 2.9.7.6 Prefix (ST)
      • 2.9.7.7 Degree (IS)
      • 2.9.7.8 Source table (IS)
      • 2.9.7.9 Assigning authority (HD)
    • 2.9.8 CNE - coded with no exceptions
      • 2.9.8.1 Identifier (ST)
      • 2.9.8.2 Text (ST)
      • 2.9.8.3 Name of coding system (IS)
      • 2.9.8.4 Alternate identifier (ST)
      • 2.9.8.5 Alternate text (ST)
      • 2.9.8.6 Name of alternate coding system (IS)
      • 2.9.8.7 Coding system version ID (ST)
      • 2.9.8.8 Alternate coding system version ID (ST)
      • 2.9.8.9 Original text (ST)
      • 2.9.8.10 Usage notes:
    • 2.9.9 CP - composite price
      • 2.9.9.1 Price (MO)
      • 2.9.9.2 Price type (ID)
      • 2.9.9.3 From value (NM)
      • 2.9.9.4 To value (NM)
      • 2.9.9.5 Range units (CE)
      • 2.9.9.6 Range type (ID)
    • 2.9.10 CQ - composite quantity with units
      • 2.9.10.1 Quantity (NM)
      • 2.9.10.2 Units (CE)
    • 2.9.11 CWE - coded with exceptions
      • 2.9.11.1 Identifier (ST)
      • 2.9.11.2 Text (ST)
      • 2.9.11.3 Name of coding system (IS)
      • 2.9.11.4 Alternate identifier (ST)
      • 2.9.11.5 Alternate text (ST)
      • 2.9.11.6 Name of alternate coding system (IS)
      • 2.9.11.7 Coding system version ID (ST)
      • 2.9.11.8 Alternate coding system version ID (ST)
      • 2.9.11.9 Original text (ST)
      • 2.9.11.10 Usage notes:
    • 2.9.12 CX - extended composite ID with check digit
      • 2.9.12.1 ID (ST)
      • 2.9.12.2 Check digit (ST)
      • 2.9.12.3 Code identifying the check digit scheme employed (ID)
      • 2.9.12.4 Assigning authority (HD)
      • 2.9.12.5 Identifier type code (ID)
      • 2.9.12.6 Assigning facility (HD)
      • 2.9.12.7 Effective date (DT)
      • 2.9.12.8 Expiration date (DT)
    • 2.9.13 DLN - driver's license number
      • 2.9.13.1 Driver's license number (as ST data type)
      • 2.9.13.2 Issuing state, province, country (IS)
      • 2.9.13.3 Expiration date (DT)
    • 2.9.14 DR - date/time range
      • 2.9.14.1 Range start date/time (TS)
      • 2.9.14.2 Range end date/time (TS)
    • 2.9.15 DT - date
    • 2.9.16 ED - encapsulated data
      • 2.9.16.1 Source application (HD)
      • 2.9.16.2 Type of data (ID)
      • 2.9.16.3 Data subtype (ID)
      • 2.9.16.4 Encoding (ID)
      • 2.9.16.5 Data (ST)
    • 2.9.17 EI - entity identifier
      • 2.9.17.1 Entity identifier (ST)
      • 2.9.17.2 Namespace ID (IS)
      • 2.9.17.3 Universal ID (ST)
      • 2.9.17.4 Universal ID type (ID)
    • 2.9.18 FC - financial class
      • 2.9.18.1 Financial class (IS)
      • 2.9.18.2 Effective date (TS)
    • 2.9.19 FN - family name
      • 2.9.19.1 Surname (ST)
      • 2.9.19.2 Own surname prefix (ST)
      • 2.9.19.3 Own surname (ST)
      • 2.9.19.4 Surname prefix from partner/spouse (ST)
      • 2.9.19.5 Surname from partner/spouse (ST)
    • 2.9.20 FT - formatted text data
    • 2.9.21 HD - hierarchic designator
      • 2.9.21.1 Namespace ID (IS)
      • 2.9.21.2 Universal ID (ST)
      • 2.9.21.3 Universal ID type (ID)
    • 2.9.22 ID - coded value for HL7 defined tables
    • 2.9.23 IS - coded value for user-defined tables
    • 2.9.24 JCC - job code/class
      • 2.9.24.1 Job code (IS)
      • 2.9.24.2 Job class (IS)
    • 2.9.25 MA - multiplexed array
    • 2.9.26 MO - money
      • 2.9.26.1 Quantity (NM)
      • 2.9.26.2 Denomination (ID)
    • 2.9.27 NA - numeric array
    • 2.9.28 NM - numeric
    • 2.9.29 PL - person location
      • 2.9.29.1 Point of care (IS)
      • 2.9.29.2 Room (IS)
      • 2.9.29.3 Bed (IS)
      • 2.9.29.4 Facility (HD)
      • 2.9.29.5 Location status (IS)
      • 2.9.29.6 Person location type (IS)
      • 2.9.29.7 Building (IS)
      • 2.9.29.8 Floor (IS)
      • 2.9.29.9 Location description (ST)
    • 2.9.30 PN - person name
      • 2.9.30.1 Family name (FN)
      • 2.9.30.2 Given name (ST)
      • 2.9.30.3 Second and further given names or initials thereof (ST)
      • 2.9.30.4 Suffix (ST)
      • 2.9.30.5 Prefix (ST)
      • 2.9.30.6 Degree (IS)
        • 2.9.30.6.1 Internationalization note
      • 2.9.30.7 References for internationalization of name
    • 2.9.31 PPN - performing person time stamp
      • 2.9.31.1 ID number (ST)
      • 2.9.31.2 Family name (FN)
      • 2.9.31.3 Given name (ST)
      • 2.9.31.4 Second and further given names or initials thereof (ST)
      • 2.9.31.5 Suffix (ST)
      • 2.9.31.6 Prefix (ST)
      • 2.9.31.7 Degree (IS)
      • 2.9.31.8 Source table (IS)
      • 2.9.31.9 Assigning authority (HD)
      • 2.9.31.10 Name type code (ID)
      • 2.9.31.11 Identifier check digit (ST)
      • 2.9.31.12 Code identifying the check digit scheme employed (ID)
      • 2.9.31.13 Identifier type code (IS)
      • 2.9.31.14 Assigning facility (HD)
      • 2.9.31.15 Date/time action performed (TS)
      • 2.9.31.16 Name representation code (ID)
      • 2.9.31.17 Name context (CE)
      • 2.9.31.18 Name validity range (DR)
      • 2.9.31.19 Name assembly order (ID)
    • 2.9.32 PT - processing type
      • 2.9.32.1 Processing ID (ID)
      • 2.9.32.2 Processing mode (ID)
    • 2.9.33 QIP - query input parameter list
      • 2.9.33.1 Segment field name (ST)
      • 2.9.33.2 Value1 & value2 & value3 (ST)
    • 2.9.34 QSC - query selection criteria
      • 2.9.34.1 Segment field name (ST)
      • 2.9.34.2 Relational operator (ID)
      • 2.9.34.3 Value (ST)
      • 2.9.34.4 Relational conjunction (ID)
    • 2.9.35 RCD - row column definition
      • 2.9.35.1 Segment field name (ST)
      • 2.9.35.2 HL7 data type (ID)
      • 2.9.35.3 Maximum column width (NM)
    • 2.9.36 RI - repeat interval
      • 2.9.36.1 Repeat pattern (IS)
      • 2.9.36.2 Explicit time interval (ST)
    • 2.9.37 RP - reference pointer
      • 2.9.37.1 Pointer (ST)
      • 2.9.37.2 Application ID (HD)
      • 2.9.37.3 Type of data (ID)
      • 2.9.37.4 Subtype (ID)
      • 2.9.37.5 Type-subtype combinations
        • 2.9.37.5.1 Image subtypes
        • 2.9.37.5.2 Audio subtypes
        • 2.9.37.5.3 Application subtypes
    • 2.9.38 SAD - street address
      • 2.9.38.1 Street or mailing address (ST)
      • 2.9.38.2 Street name (ST)
      • 2.9.38.3 Dwelling number (ST)
    • 2.9.39 SCV - scheduling class value pair
      • 2.9.39.1 Parameter class (IS)
      • 2.9.39.2 Parameter value (ST)
    • 2.9.40 SI - sequence ID
    • 2.9.41 SN - structured numeric
      • 2.9.41.1 Comparator (ST)
      • 2.9.41.2 Num1 (NM)
      • 2.9.41.3 Separator/suffix (ST)
      • 2.9.41.4 Num2 (NM)
    • 2.9.42 SRT - sort order
      • 2.9.42.1 Sort-by field (ST)
      • 2.9.42.2 Sequencing (ID)
    • 2.9.43 ST - string data
    • 2.9.44 TM - time
    • 2.9.45 TN - telephone number
    • 2.9.46 TQ - timing quantity
    • 2.9.47 TS - time stamp
    • 2.9.48 TX - text data
    • 2.9.49 VH - visiting hours
      • 2.9.49.1 Start day range (ID)
      • 2.9.49.2 End day range (ID)
      • 2.9.49.3 Start hour range (TM)
      • 2.9.49.4 End hour range (TM)
    • 2.9.50 VID - version identifier
      • 2.9.50.1 Version ID (ID)
      • 2.9.50.2 Internationalization code (CE)
      • 2.9.50.3 International version ID (CE)
    • 2.9.51 XAD - extended address
      • 2.9.51.1 Street address (SAD)
      • 2.9.51.2 Other designation (ST)
      • 2.9.51.3 City (ST)
      • 2.9.51.4 State or province (ST)
      • 2.9.51.5 Zip or postal code (ST)
      • 2.9.51.6 Country (ID)
      • 2.9.51.7 Address type (ID)
      • 2.9.51.8 Other geographic designation (ST)
      • 2.9.51.9 County/parish code (IS)
      • 2.9.51.10 Census tract (IS)
      • 2.9.51.11 Address representation code (ID)
      • 2.9.51.12 Address validity range (DR)
        • 2.9.51.12.1 Date range start date/time (TS)
        • 2.9.51.12.2 Date range end date/time (TS)
    • 2.9.52 XCN - extended composite ID number and name for persons
      • 2.9.52.1 ID number (ST)
      • 2.9.52.2 Family name (FN)
      • 2.9.52.3 Given name (ST)
      • 2.9.52.4 Second and further given names or initials thereof (ST)
      • 2.9.52.5 Suffix (ST)
      • 2.9.52.6 Prefix (ST)
      • 2.9.52.7 Degree (IS)
      • 2.9.52.8 Source table (IS)
      • 2.9.52.9 Assigning authority (HD)
      • 2.9.52.10 Name type code (ID)
      • 2.9.52.11 Identifier check digit (ST)
      • 2.9.52.12 Code identifying the check digit scheme employed (ID)
      • 2.9.52.13 Identifier type code (IS)
      • 2.9.52.14 Assigning facility (HD)
      • 2.9.52.15 Name representation code (ID)
      • 2.9.52.16 Name context (CE)
      • 2.9.52.17 Name validity range (DR)
      • 2.9.52.18 Name assembly order (ID)
    • 2.9.53 XON - extended composite name and identification number for organizations
      • 2.9.53.1 Organization name (ST)
      • 2.9.53.2 Organization name type code (IS)
      • 2.9.53.3 ID number (NM)
      • 2.9.53.4 Check digit (NM)
      • 2.9.53.5 Code identifying the check digit scheme employed (ID)
      • 2.9.53.6 Assigning authority (HD)
      • 2.9.53.7 Identifier type code (IS)
      • 2.9.53.8 Assigning facility ID (HD)
      • 2.9.53.9 Name representation code (ID)
    • 2.9.54 XPN - extended person name
      • 2.9.54.1 Family name (FN )
      • 2.9.54.2 Given name (ST)
      • 2.9.54.3 Second and further given names or initials thereof (ST)
      • 2.9.54.4 Suffix (ST)
      • 2.9.54.5 Prefix (ST)
      • 2.9.54.6 Degree (IS)
      • 2.9.54.7 Name type code (ID)
      • 2.9.54.8 Name representation code (ID)
      • 2.9.54.9 Name context (CE)
      • 2.9.54.10 Name validity range (DR)
      • 2.9.54.11 Name assembly order (ID)
    • 2.9.55 XTN - extended telecommunication number
      • 2.9.55.1 [(999)] 999-9999 [X99999] [C any text]
      • 2.9.55.2 Telecommunication use code (ID)
      • 2.9.55.3 Telecommunication equipment type (ID)
      • 2.9.55.4 Email address (ST)
      • 2.9.55.5 Country code (NM)
      • 2.9.55.6 Area/city code (NM)
      • 2.9.55.7 Phone number (NM)
      • 2.9.55.8 Extension (NM)
      • 2.9.55.9 Any text (ST)
  • 2.10 USE OF ESCAPE SEQUENCES IN TEXT FIELDS
    • 2.10.1 Formatting codes
    • 2.10.2 Escape sequences supporting multiple character sets for, FT, ST, and TX data types
    • 2.10.3 Highlighting
    • 2.10.4 Special character
    • 2.10.5 Hexadecimal
    • 2.10.6 Formatted text
    • 2.10.7 Local
  • 2.11 MESSAGE CONSTRUCTION RULES
    • 2.11.1 Encoding rules notes
    • 2.11.2 Version compatibility definition
  • 2.12 CHAPTER FORMATS FOR DEFINING HL7 MESSAGES
    • 2.12.1 HL7 abstract message syntax example
  • 2.13 APPLICATION (LEVEL 7) PROCESSING RULES
    • 2.13.1 Original and enhanced processing rules
      • 2.13.1.1 Initiation
      • 2.13.1.2 Response
        • 2.13.1.2.1 When the original acknowledgment rules apply
        • 2.13.1.2.2 When enhanced acknowledgment rules apply
    • 2.13.2 Application (level 7) processing rules, deferred processing two phase reply (original acknowledgment mode only)
      • 2.13.2.1 Initiation
      • 2.13.2.2 Response
  • 2.14 ACKNOWLEDGMENT MESSAGES
    • 2.14.1 ACK - general acknowledgment
    • 2.14.2 MCF - delayed acknowledgment
  • 2.15 SPECIAL HL7 PROTOCOLS
    • 2.15.1 Sequence number protocol
    • 2.15.2 Continuation messages and segments
      • 2.15.2.1 Segment fragmentation/continuation using the ADD segment
      • 2.15.2.2 Segment fragmentation/continuation using the DSC segment
      • 2.15.2.3 Segment fragmentation across messages
    • 2.15.3 HL7 batch protocol
      • 2.15.3.1 HL7 batch file structure
      • 2.15.3.2 Related segments and data usage
      • 2.15.3.3 Acknowledging batches
      • 2.15.3.4 Batch message as a query response
    • 2.15.4 Modes for updating via repeating segments
      • 2.15.4.1 Snapshot mode update definition
      • 2.15.4.2 Action code/unique identifier mode update definition
  • 2.16 MESSAGE CONTROL SEGMENTS
    • 2.16.1 ADD - addendum segment
      • 2.16.1.0 ADD field definition
      • 2.16.1.1 ADD-1 Addendum continuation pointer (ST) 00066
    • 2.16.2 BHS - batch header segment
      • 2.16.2.0 BHS field definitions
      • 2.16.2.1 BHS-1 Batch field separator (ST) 00081
      • 2.16.2.2 BHS-2 Batch encoding characters (ST) 00082
      • 2.16.2.3 BHS-3 Batch sending application (ST) 00083
      • 2.16.2.4 BHS-4 Batch sending facility (ST) 00084
      • 2.16.2.5 BHS-5 Batch receiving application (ST) 00085
      • 2.16.2.6 BHS-6 Batch receiving facility (ST) 00086
      • 2.16.2.7 BHS-7 Batch creation date/time (TS) 00087
      • 2.16.2.8 BHS-8 Batch security (ST) 00088
      • 2.16.2.9 BHS-9 Batch name/ID/type (ST) 00089
      • 2.16.2.10 BHS-10 Batch comment (ST) 00090
      • 2.16.2.11 BHS-11 Batch control ID (ST) 00091
      • 2.16.2.12 BHS-12 Reference batch control ID (ST) 00092
    • 2.16.3 BTS - batch trailer segment
      • 2.16.3.0 BTS field definitions
      • 2.16.3.1 BTS-1 Batch message count (ST) 00093
      • 2.16.3.2 BTS-2 Batch comment (ST) 00090
      • 2.16.3.3 BTS-3 Batch totals (NM) 00095
    • 2.16.4 DSC - continuation pointer segment
      • 2.16.4.0 DSC field definitions
      • 2.16.4.1 DSC-1 Continuation pointer (ST) 00014
      • 2.16.4.2 DSC-2 Continuation style (ID) 01354
    • 2.16.5 ERR - error segment
      • 2.16.5.0 ERR field definition
      • 2.16.5.1 ERR-1 Error code and location (CM) 00024
    • 2.16.6 FHS - file header segment
      • 2.16.6.0 FHS field definitions
      • 2.16.6.1 FHS-1 File field separator (ST) 00067
      • 2.16.6.2 FHS-2 File encoding characters (ST) 00068
      • 2.16.6.3 FHS-3 File sending application (ST) 00069
      • 2.16.6.4 FHS-4 File sending facility (ST) 00070
      • 2.16.6.5 FHS-5 File receiving application (ST) 00071
      • 2.16.6.6 FHS-6 File receiving facility (ST) 00072
      • 2.16.6.7 FHS-7 File creation date/time (TS) 00073
      • 2.16.6.8 FHS-8 File security (ST) 00074
      • 2.16.6.9 FHS-9 File name/ID (ST) 00075
      • 2.16.6.10 FHS-10 File header comment (ST) 00076
      • 2.16.6.11 FHS-11 File control ID (ST) 00077
      • 2.16.6.12 FHS-12 Reference file control ID (ST) 00078
    • 2.16.7 FTS - file trailer segment
      • 2.16.7.0 FTS field definitions
      • 2.16.7.1 FTS-1 File batch count (NM) 00079
      • 2.16.7.2 FTS-2 File trailer comment (ST) 00080
    • 2.16.8 MSA - message acknowledgment segment
      • 2.16.8.0 MSA field definitions
      • 2.16.8.1 MSA-1 Acknowledgment code (ID) 00018
      • 2.16.8.2 MSA-2 Message control ID (ST) 00010
      • 2.16.8.3 MSA-3 Text message (ST) 00020
      • 2.16.8.4 MSA-4 Expected sequence number (NM) 00021
      • 2.16.8.5 MSA-5 Delayed acknowledgment type (ID) 00022
      • 2.16.8.6 MSA-6 Error condition (CE) 00023
    • 2.16.9 MSH - message header segment
      • 2.16.9.0 MSH field definitions
      • 2.16.9.1 MSH-1 Field separator (ST) 00001
      • 2.16.9.2 MSH-2 Encoding characters (ST) 00002
      • 2.16.9.3 MSH-3 Sending application (HD) 00003
      • 2.16.9.4 MSH-4 Sending facility (HD) 00004
      • 2.16.9.5 MSH-5 Receiving application (HD) 00005
      • 2.16.9.6 MSH-6 Receiving facility (HD) 00006
      • 2.16.9.7 MSH-7 Date/time of message (TS) 00007
      • 2.16.9.8 MSH-8 Security (ST) 00008
      • 2.16.9.9 MSH-9 Message type (CM) 00009
      • 2.16.9.10 MSH-10 Message control ID (ST) 00010
      • 2.16.9.11 MSH-11 Processing ID (PT) 00011
      • 2.16.9.12 MSH-12 Version ID (VID) 00012
      • 2.16.9.13 MSH-13 Sequence number (NM) 00013
      • 2.16.9.14 MSH-14 Continuation pointer (ST) 00014
      • 2.16.9.15 MSH-15 Accept acknowledgment type (ID) 00015
      • 2.16.9.16 MSH-16 Application acknowledgment type (ID) 00016
      • 2.16.9.17 MSH-17 Country code (ID) 00017
      • 2.16.9.18 MSH-18 Character set (ID) 00692
      • 2.16.9.19 MSH-19 Principal language of message (CE) 00693
      • 2.16.9.20 MSH-20 Alternate character set handling scheme (ID) 01317
      • 2.16.9.21 MSH-21 Conformance statement ID (ID) 01598
    • 2.16.10 NTE - notes and comments segment
      • 2.16.10.0 NTE field definitions
      • 2.16.10.1 NTE-1 Set ID - NTE- (SI) 00096
      • 2.16.10.2 NTE-2 Source of comment (ID) 00097
      • 2.16.10.3 NTE-3 Comment (FT) 00098
      • 2.16.10.4 NTE-4 Comment type (CE) 01318
  • 2.17 MISCELLANEOUS HL7 TABLES USED ACROSS ALL CHAPTERS
    • 2.17.1 Message type table
    • 2.17.2 Event type table
    • 2.17.3 Message structure table
    • 2.17.4 Data types table
    • 2.17.5 Coding system table
    • 2.17.6 Yes/no indicator table
  • 2.18 SAMPLE CONTROL MESSAGES
    • 2.18.1 General acknowledgment
    • 2.18.2 Error return
    • 2.18.3 Sequence number: initial message
    • 2.18.4 Example of message fragmentation
    • 2.18.5 Master file update examples: with original and enhanced acknowledgment protocol
      • 2.18.5.1 Original mode example:
      • 2.18.5.2 Enhanced mode example
        • 2.18.5.2.1 Initial message with accept acknowledgment
        • 2.18.5.2.2 Application acknowledgment message
      • 2.18.5.3 Delayed application acknowledgment
        • 2.18.5.3.1 Initial message with accept acknowledgment
        • 2.18.5.3.2 Delayed application acknowledgment
  • 2.19 OUTSTANDING ISSUES

HL7 V2.4 Chapter 3

• 3 .Patient Administration
  • 3.1 CHAPTER 3 CONTENTS
  • 3.2 PURPOSE
  • 3.3 TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 3.3.1 ADT/ACK - admit/visit notification (event A01)
    • 3.3.2 ADT/ACK - transfer a patient (event A02)
    • 3.3.3 ADT/ACK - discharge/end visit (event A03)
    • 3.3.4 ADT/ACK - register a patient (event A04)
    • 3.3.5 ADT/ACK - pre-admit a patient (event A05)
    • 3.3.6 ADT/ACK - change an outpatient to an inpatient (event A06)
    • 3.3.7 ADT/ACK - change an inpatient to an outpatient (event A07)
    • 3.3.8 ADT/ACK - update patient information (event A08)
    • 3.3.9 ADT/ACK - patient departing - tracking (event A09)
    • 3.3.10 ADT/ACK - patient arriving - tracking (event A10)
    • 3.3.11 ADT/ACK - cancel admit / visit notification (event A11)
    • 3.3.12 ADT/ACK - cancel transfer (event A12)
    • 3.3.13 ADT/ACK - cancel discharge / end visit (event A13)
    • 3.3.14 ADT/ACK - pending admit (event A14)
    • 3.3.15 ADT/ACK - pending transfer (event A15)
    • 3.3.16 ADT/ACK - pending discharge (event A16)
    • 3.3.17 ADT/ACK - swap patients (event A17)
    • 3.3.18 ADT/ACK - merge patient information (event A18)
    • 3.3.19 QRY/ADR - patient query (event A19)
      • 3.3.19.1 A19 usage notes
    • 3.3.20 ADT/ACK - bed status update (event A20)
    • 3.3.21 ADT/ACK - patient goes on a leave of absence (event A21)
    • 3.3.22 ADT/ACK - patient returns from a leave of absence (event A22)
    • 3.3.23 ADT/ACK - delete a patient record (event A23)
    • 3.3.24 ADT/ACK - link patient information (event A24)
    • 3.3.25 ADT/ACK - cancel pending discharge (event A25)
    • 3.3.26 ADT/ACK - cancel pending transfer (event A26)
    • 3.3.27 ADT/ACK - cancel pending admit (event A27)
    • 3.3.28 ADT/ACK - add person or patient information (event A28)
    • 3.3.29 ADT/ACK - delete person information (event A29)
    • 3.3.30 ADT/ACK - merge person information (event A30)
    • 3.3.31 ADT/ACK - update person information (event A31)
    • 3.3.32 ADT/ACK - cancel patient arriving - tracking (event A32)
    • 3.3.33 ADT/ACK - cancel patient departing - tracking (event A33)
    • 3.3.34 ACK/ADT - merge patient information - patient ID only (event A34)
    • 3.3.35 ADT/ACK - merge patient information - account number only (event A35)
    • 3.3.36 ADT/ACK - merge patient information - patient ID & account number (event A36)
    • 3.3.37 ADT/ACK - unlink patient information (event A37)
    • 3.3.38 ADT/ACK - cancel pre-admit (event A38)
    • 3.3.39 ADT/ACK - merge person - patient ID (event A39)
    • 3.3.40 ADT/ACK - merge patient - patient identifier list (event A40)
    • 3.3.41 ADT/ACK - merge account - patient account number (event A41)
    • 3.3.42 ADT/ACK - merge visit - visit number (event A42)
    • 3.3.43 ADT/ACK - move patient information - patient identifier list (event A43)
    • 3.3.44 ADT/ACK - move account information - patient account number (event A44)
    • 3.3.45 ADT/ACK - move visit information - visit number (event A45)
    • 3.3.46 ADT/ACK - change patient ID (event A46)
    • 3.3.47 ADT/ACK - change patient identifier list (event A47)
    • 3.3.48 ADT/ACK - change alternate patient ID (event A48)
    • 3.3.49 ADT/ACK - change patient account number (event A49)
    • 3.3.50 ADT/ACK - change visit number (event A50)
    • 3.3.51 ADT/ACK - change alternate visit ID (event A51)
    • 3.3.52 ADT/ACK- cancel leave of absence for a patient (event A52)
    • 3.3.53 ADT/ACK - cancel patient returns from a leave of absence (event A53)
    • 3.3.54 ADT/ACK - change attending doctor (event A54)
    • 3.3.55 ADT/ACK - cancel change attending doctor (event A55)
    • 3.3.56 Get person demographics (QBP) and response (RSP) (events Q21 and K21)
    • 3.3.57 Find candidates (QBP) and response (RSP) (events Q22 and K22)
    • 3.3.58 Get corresponding identifiers (QBP) and response (RSP) (events Q23 and K23)
    • 3.3.59 Allocate identifiers (QBP) and response (RSP) (events Q24 and K24)
    • 3.3.60 ADT/ACK - update adverse reaction information (event A60)
    • 3.3.61 ADT/ACK - change consulting doctor (event A61)
    • 3.3.62 ADT/ACK - cancel change consulting doctor (event A62)
  • 3.4 MESSAGE SEGMENTS
    • 3.4.1 EVN - event type segment
      • 3.4.1.0 EVN field definitions
      • 3.4.1.1 EVN-1 Event type code (ID) 00099
      • 3.4.1.2 EVN-2 Recorded date/time (TS) 00100
      • 3.4.1.3 EVN-3 Date/time planned event (TS) 00101
      • 3.4.1.4 EVN-4 Event reason code (IS) 00102
      • 3.4.1.5 EVN-5 Operator ID (XCN) 00103
      • 3.4.1.6 EVN-6 Event occurred (TS) 01278
      • 3.4.1.7 EVN-7 Event facility (HD) 01534
    • 3.4.2 PID - patient identification segment
      • 3.4.2.0 PID field definitions
      • 3.4.2.1 PID-1 Set ID - PID- (SI) 00104
      • 3.4.2.2 PID-2 Patient ID (CX) 00105
      • 3.4.2.3 PID-3 Patient identifier list (CX) 00106
      • 3.4.2.4 PID-4 Alternate patient ID - PID (CX) 00107
      • 3.4.2.5 PID-5 Patient name (XPN) 00108
      • 3.4.2.6 PID-6 Mother's maiden name (XPN) 00109
      • 3.4.2.7 PID-7 Date/time of birth (TS) 00110
      • 3.4.2.8 PID-8 Administrative sex (IS) 00111
      • 3.4.2.9 PID-9 Patient alias (XPN) 00112
      • 3.4.2.10 PID-10 Race (CE) 00113
      • 3.4.2.11 PID-11 Patient address (XAD) 00114
      • 3.4.2.12 PID-12 County code (IS) 00115
      • 3.4.2.13 PID-13 Phone number - home - (XTN) 00116
      • 3.4.2.14 PID-14 Phone number - business- (XTN) 00117
      • 3.4.2.15 PID-15 Primary language (CE) 00118
      • 3.4.2.16 PID-16 Marital status (CE) 00119
      • 3.4.2.17 PID-17 Religion (CE) 00120
      • 3.4.2.18 PID-18 Patient account number (CX) 00121
      • 3.4.2.19 PID-19 SSN number - patient- (ST) 00122
      • 3.4.2.20 PID-20 Driver's license number - Patient - (DLN) 00123
      • 3.4.2.21 PID-21 Mother's identifier (CX) 00124
      • 3.4.2.22 PID-22 Ethnic group (CE) 00125
      • 3.4.2.23 PID-23 Birth place (ST) 00126
      • 3.4.2.24 PID-24 Multiple birth indicator (ID) 00127
      • 3.4.2.25 PID-25 Birth order (NM) 00128
      • 3.4.2.26 PID-26 Citizenship (CE) 00129
      • 3.4.2.27 PID-27 Veterans military status (CE) 00130
      • 3.4.2.28 PID-28 Nationality (CE) 00739
      • 3.4.2.29 PID-29 Patient death date and time (TS) 00740
      • 3.4.2.30 PID-30 Patient death indicator (ID) 00741
      • 3.4.2.31 PID-31 Identity unknown indicator (ID) 01535
      • 3.4.2.32 PID-32 Identity reliability code (IS) 01536
      • 3.4.2.33 PID-33 Last update date/time (TS) 01537
      • 3.4.2.34 PID-34 Last update facility (HD) 01538
      • 3.4.2.35 PID-35 Species code (CE) 01539
      • 3.4.2.36 PID-36 Breed code (CE) 01540
      • 3.4.2.37 PID-37 Strain (ST) 01541
      • 3.4.2.38 PID-38 Production class code (CE) 01542
    • 3.4.3 PV1 - patient visit segment
      • 3.4.3.0 PV1 field definitions
      • 3.4.3.1 PV1-1 Set ID - PV1- (SI) 00131
      • 3.4.3.2 PV1-2 Patient class (IS) 00132
      • 3.4.3.3 PV1-3 Assigned patient location (PL) 00133
      • 3.4.3.4 PV1-4 Admission type (IS) 00134
      • 3.4.3.5 PV1-5 Preadmit number (CX) 00135
      • 3.4.3.6 PV1-6 Prior patient location (PL) 00136
      • 3.4.3.7 PV1-7 Attending doctor (XCN) 00137
      • 3.4.3.8 PV1-8 Referring doctor (XCN) 00138
      • 3.4.3.9 PV1-9 Consulting doctor (XCN) 00139
      • 3.4.3.10 PV1-10 Hospital service (IS) 00140
      • 3.4.3.11 PV1-11 Temporary location (PL) 00141
      • 3.4.3.12 PV1-12 Preadmit test indicator (IS) 00142
      • 3.4.3.13 PV1-13 Re-admission indicator - (IS) 00143
      • 3.4.3.14 PV1-14 Admit source (IS) 00144
      • 3.4.3.15 PV1-15 Ambulatory status (IS) 00145
      • 3.4.3.16 PV1-16 VIP indicator (IS) 00146
      • 3.4.3.17 PV1-17 Admitting doctor (XCN) 00147
      • 3.4.3.18 PV1-18 Patient type (IS) 00148
      • 3.4.3.19 PV1-19 Visit number (CX) 00149
      • 3.4.3.20 PV1-20 Financial class (FC) 00150
      • 3.4.3.21 PV1-21 Charge price indicator (IS) 00151
      • 3.4.3.22 PV1-22 Courtesy code (IS) 00152
      • 3.4.3.23 PV1-23 Credit rating (IS) 00153
      • 3.4.3.24 PV1-24 Contract code (IS) 00154
      • 3.4.3.25 PV1-25 Contract effective date (DT) 00155
      • 3.4.3.26 PV1-26 Contract amount (NM) 00156
      • 3.4.3.27 PV1-27 Contract period (NM) 00157
      • 3.4.3.28 PV1-28 Interest code (IS) 00158
      • 3.4.3.29 PV1-29 Transfer to bad debt code (IS) 00159
      • 3.4.3.30 PV1-30 Transfer to bad debt date (DT) 00160
      • 3.4.3.31 PV1-31 Bad debt agency code (IS) 00161
      • 3.4.3.32 PV1-32 Bad debt transfer amount (NM) 00162
      • 3.4.3.33 PV1-33 Bad debt recovery amount (NM) 00163
      • 3.4.3.34 PV1-34 Delete account indicator (IS) 00164
      • 3.4.3.35 PV1-35 Delete account date (DT) 00165
      • 3.4.3.36 PV1-36 Discharge disposition (IS) 00166
      • 3.4.3.37 PV1-37 Discharged to location (CM) 00167
      • 3.4.3.38 PV1-38 Diet type (CE) 00168
      • 3.4.3.39 PV1-39 Servicing facility (IS) 00169
      • 3.4.3.40 PV1-40 Bed status (IS) 00170
      • 3.4.3.41 PV1-41 Account status (IS) 00171
      • 3.4.3.42 PV1-42 Pending location (PL) 00172
      • 3.4.3.43 PV1-43 Prior temporary location (PL) 00173
      • 3.4.3.44 PV1-44 Admit date/time (TS) 00174
      • 3.4.3.45 PV1-45 Discharge date/time (TS) 00175
      • 3.4.3.46 PV1-46 Current patient balance (NM) 00176
      • 3.4.3.47 PV1-47 Total charges (NM) 00177
      • 3.4.3.48 PV1-48 Total adjustments (NM) 00178
      • 3.4.3.49 PV1-49 Total payments (NM) 00179
      • 3.4.3.50 PV1-50 Alternate visit ID (CX) 00180
      • 3.4.3.51 PV1-51 Visit indicator (IS) 01226
      • 3.4.3.52 PV1-52 Other healthcare provider (XCN) 01274
    • 3.4.4 PV2 - patient visit - additional information segment
      • 3.4.4.0 PV2 field definitions
      • 3.4.4.1 PV2-1 Prior pending location (PL) 00181
      • 3.4.4.2 PV2-2 Accommodation code (CE) 00182
      • 3.4.4.3 PV2-3 Admit reason (CE) 00183
      • 3.4.4.4 PV2-4 Transfer reason (CE) 00184
      • 3.4.4.5 PV2-5 Patient valuables (ST) 00185
      • 3.4.4.6 PV2-6 Patient valuables location (ST) 00186
      • 3.4.4.7 PV2-7 Visit user code (IS) 00187
      • 3.4.4.8 PV2-8 Expected admit date/time (TS) 00188
      • 3.4.4.9 PV2-9 Expected discharge date/time (TS) 00189
      • 3.4.4.10 PV2-10 Estimated length of inpatient stay (NM) 00711
      • 3.4.4.11 PV2-11 Actual length of inpatient stay (NM) 00712
      • 3.4.4.12 PV2-12 Visit description (ST) 00713
      • 3.4.4.13 PV2-13 Referral source code (XCN) 00714
      • 3.4.4.14 PV2-14 Previous service date (DT) 00715
      • 3.4.4.15 PV2-15 Employment illness related indicator (ID) 00716
      • 3.4.4.16 PV2-16 Purge status code (IS) 00717
      • 3.4.4.17 PV2-17 Purge status date (DT) 00718
      • 3.4.4.18 PV2-18 Special program code (IS) 00719
      • 3.4.4.19 PV2-19 Retention indicator (ID) 00720
      • 3.4.4.20 PV2-20 Expected number of insurance plans (NM) 00721
      • 3.4.4.21 PV2-21 Visit publicity code (IS) 00722
      • 3.4.4.22 PV2-22 Visit protection indicator (ID) 00723
      • 3.4.4.23 PV2-23 Clinic organization name (XON) 00724
      • 3.4.4.24 PV2-24 Patient status code (IS) 00725
      • 3.4.4.25 PV2-25 Visit priority code (IS) 00726
      • 3.4.4.26 PV2-26 Previous treatment date (DT) 00727
      • 3.4.4.27 PV2-27 Expected discharge disposition (IS) 00728
      • 3.4.4.28 PV2-28 Signature on file date (DT) 00729
      • 3.4.4.29 PV2-29 First similar illness date (DT) 00730
      • 3.4.4.30 PV2-30 Patient charge adjustment code (CE) 00731
      • 3.4.4.31 PV2-31 Recurring service code (IS) 00732
      • 3.4.4.32 PV2-32 Billing media code (ID) 00733
      • 3.4.4.33 PV2-33 Expected surgery date and time (TS) 00734
      • 3.4.4.34 PV2-34 Military partnership code (ID) 00735
      • 3.4.4.35 PV2-35 Military non-availability code (ID) 00736
      • 3.4.4.36 PV2-36 Newborn baby indicator (ID) 00737
      • 3.4.4.37 PV2-37 Baby detained indicator (ID) 00738
      • 3.4.4.38 PV2-38 Mode of arrival code (CE) 01543
      • 3.4.4.39 PV2-39 Recreational drug use code (CE) 01544
      • 3.4.4.40 PV2-40 Admission level of care code (CE) 01545
      • 3.4.4.41 PV2-41 Precaution code (CE) 01546
      • 3.4.4.42 PV2-42 Patient condition code (CE) 01547
      • 3.4.4.43 PV2-43 Living will code (IS) 00759
      • 3.4.4.44 PV2-44 Organ donor code (IS) 00760
      • 3.4.4.45 PV2-45 Advance directive code (CE) 01548
      • 3.4.4.46 PV2-46 Patient status effective date (DT) 01549
      • 3.4.4.47 PV2-47 Expected LOA return date/time (TS) 01550
    • 3.4.5 NK1 - next of kin / associated parties segment
      • 3.4.5.0 NK1 field definitions
      • 3.4.5.1 NK1-1 Set ID - NK1- (SI) 00190
      • 3.4.5.2 NK1-2 Name (XPN) 00191
      • 3.4.5.3 NK1-3 Relationship (CE) 00192
      • 3.4.5.4 NK1-4 Address (XAD) 00193
      • 3.4.5.5 NK1-5 Phone number (XTN) 00194
      • 3.4.5.6 NK1-6 Business phone number (XTN) 00195
      • 3.4.5.7 NK1-7 Contact role (CE) 00196
      • 3.4.5.8 NK1-8 Start date (DT) 00197
      • 3.4.5.9 NK1-9 End date (DT) 00198
      • 3.4.5.10 NK1-10 Next of kin / associated parties job title (ST) 00199
      • 3.4.5.11 NK1-11 Next of kin / associated parties job code/class (JCC) 00200
      • 3.4.5.12 NK1-12 Next of kin / associated parties employee number (CX) 00201
      • 3.4.5.13 NK1-13 Organization name - NK1 (XON) 00202
      • 3.4.5.14 NK1-14 Marital status (CE) 00119
      • 3.4.5.15 NK1-15 Administrative sex (IS) 00111
      • 3.4.5.16 NK1-16 Date/time of birth (TS) 00110
      • 3.4.5.17 NK1-17 Living dependency (IS) 00755
      • 3.4.5.18 NK1-18 Ambulatory status (IS) 00145
      • 3.4.5.19 NK1-19 Citizenship (CE) 00129
      • 3.4.5.20 NK1-20 Primary language (CE) 00118
      • 3.4.5.21 NK1-21 Living arrangement (IS) 00742
      • 3.4.5.22 NK1-22 Publicity code (CE) 00743
      • 3.4.5.23 NK1-23 Protection indicator (ID) 00744
      • 3.4.5.24 NK1-24 Student indicator (IS) 00745
      • 3.4.5.25 NK1-25 Religion (CE) 00120
      • 3.4.5.26 NK1-26 Mother's maiden name' (XPN) 00109
      • 3.4.5.27 NK1-27 Nationality (CE) 00739
      • 3.4.5.28 NK1-28 Ethnic group (CE) 00125
      • 3.4.5.29 NK1-29 Contact reason (CE) 00747
      • 3.4.5.30 NK1-30 Contact person's name' (XPN) 00748
      • 3.4.5.31 NK1-31 Contact person's telephone number' (XTN) 00749
      • 3.4.5.32 NK1-32 Contact person's address (XAD) 00750
      • 3.4.5.33 NK1-33 Next of kin/associated party's identifiers (CX) 00751
      • 3.4.5.34 NK1-34 Job status (IS) 00752
      • 3.4.5.35 NK1-35 Race (CE) 00113
      • 3.4.5.36 NK1-36 Handicap (IS) 00753
      • 3.4.5.37 NK1-37 Contact person social security number (ST) 00754
    • 3.4.6 AL1 - patient allergy information segment
      • 3.4.6.0 AL1 field definitions
      • 3.4.6.1 AL1-1 Set ID - AL1 (CE) 00203
      • 3.4.6.2 AL1-2 Allergen type code (CE) 00204
      • 3.4.6.3 AL1-3 Allergen code/mnemonic/description (CE) 00205
      • 3.4.6.4 AL1-4 Allergy severity code (CE) 00206
      • 3.4.6.5 AL1-5 Allergy reaction code (ST) 00207
      • 3.4.6.6 AL1-6 Identification date (DT) 00208
    • 3.4.7 IAM - patient adverse reaction information segment - unique identifier
      • 3.4.7.0 IAM field definitions
      • 3.4.7.1 IAM-1 Set ID - IAM (SI) 01612
      • 3.4.7.2 IAM-2 Allergen type code (CE) 00204
      • 3.4.7.3 IAM-3 Allergen code/mnemonic/description (CE) 00205
      • 3.4.7.4 IAM-4 Allergy severity code (CE) 00206
      • 3.4.7.5 IAM-5 Allergy reaction code (ST) 00207
      • 3.4.7.6 IAM-6 Allergy action code (CNE) 01551
      • 3.4.7.7 IAM-7 Allergy unique identifier (EI) 01552
      • 3.4.7.8 IAM-8 Action reason (ST) 01553
      • 3.4.7.9 IAM-9 Sensitivity to Causative Agent code (CE) 01554
      • 3.4.7.10 IAM-10 Allergen group code/mnemonic/description (CE) 01555
      • 3.4.7.11 IAM-11 Onset date (DT) 01556
      • 3.4.7.12 IAM-12 Onset date text (ST) 01557
      • 3.4.7.13 IAM-13 Reported date/time (TS) 01558
      • 3.4.7.14 IAM-14 Reported by (XPN) 01559
      • 3.4.7.15 IAM-15 Relationship to patient code (CE) 01560
      • 3.4.7.16 IAM-16 Alert device code (CE) 01561
      • 3.4.7.17 IAM-17 Allergy clinical status code (CE) 01562
      • 3.4.7.18 IAM-18 Statused by person (XCN) 01563
      • 3.4.7.19 IAM-19 Statused by organization (XON) 01564
      • 3.4.7.20 IAM-20 Statused at date/time (TS) 01565
    • 3.4.8 NPU - bed status update segment
      • 3.4.8.0 NPU field definitions
      • 3.4.8.1 NPU-1 Bed location (PL) 00209
      • 3.4.8.2 NPU-2 Bed status (IS) 00170
    • 3.4.9 MRG - merge patient information segment
      • 3.4.9.0 MRG field definitions
      • 3.4.9.1 MRG-1 Prior patient identifier list (CX) 00211
      • 3.4.9.2 MRG-2 Prior alternate patient ID (CX) 00212
      • 3.4.9.3 MRG-3 Prior patient account number (CX) 00213
      • 3.4.9.4 MRG-4 Prior patient ID (CX) 00214
      • 3.4.9.5 MRG-5 Prior visit number (CX) 01279
      • 3.4.9.6 MRG-6 Prior alternate visit ID (CX) 01280
      • 3.4.9.7 MRG-7 Prior patient name (XPN) 01281
    • 3.4.10 PD1 - patient additional demographic segment
      • 3.4.10.0 PD1 field definitions
      • 3.4.10.1 PD1-1 Living dependency (IS) 00755
      • 3.4.10.2 PD1-2 Living arrangement (IS) 00742
      • 3.4.10.3 PD1-3 Patient primary facility (XON) 00756
      • 3.4.10.4 PD1-4 Patient primary care provider name & ID No. (XCN) 00757
      • 3.4.10.5 PD1-5 Student indicator (IS) 00745
      • 3.4.10.6 PD1-6 Handicap (IS) 00753
      • 3.4.10.7 PD1-7 Living will code (IS) 00759
      • 3.4.10.8 PD1-8 Organ donor code (IS) 00760
      • 3.4.10.9 PD1-9 Separate bill (ID) 00761
      • 3.4.10.10 PD1-10 Duplicate patient (CX) 00762
      • 3.4.10.11 PD1-11 Publicity code (CE) 00743
      • 3.4.10.12 PD1-12 Protection indicator (ID) 00744
      • 3.4.10.13 PD1-13 Protection indicator effective date (DT) 01566
      • 3.4.10.14 PD1-14 Place of worship (XON) 01567
      • 3.4.10.15 PD1-15 Advance directive code (CE) 01548
      • 3.4.10.16 PD1-16 Immunization registry status (IS) 01569
      • 3.4.10.17 PD1-17 Immunization registry status effective date (DT) 01570
      • 3.4.10.18 PD1-18 Publicity code effective date (DT) 01571
      • 3.4.10.19 PD1-19 Military branch (IS) 01572
      • 3.4.10.20 PD1-20 Military rank/grade (IS) 00486
      • 3.4.10.21 PD1-21 Military status (IS) 00487
    • 3.4.11 DB1 - disability segment
      • 3.4.11.0 DB1 field definitions
      • 3.4.11.1 DB1-1 Set ID - DB1 (SI) 01283
      • 3.4.11.2 DB1-2 Disabled person code (IS) 01284
      • 3.4.11.3 DB1-3 Disabled person identifier (CX) 01285
      • 3.4.11.4 DB1-4 Disability indicator (ID) 01286
      • 3.4.11.5 DB1-5 Disability start date (DT) 01287
      • 3.4.11.6 DB1-6 Disability end date (DT) 01288
      • 3.4.11.7 DB1-7 Disability return to work date (DT) 01289
      • 3.4.11.8 DB1-8 Disability unable to work date (DT) 01290
    • 3.4.12 PDA - patient death and autopsy segment
      • 3.4.12.0 PDA field definitions
      • 3.4.12.1 PDA-1 Death cause code (CE) 01574
      • 3.4.12.2 PDA-2 Death location (PL) 01575
      • 3.4.12.3 PDA-3 Death certified indicator (ID) 01576
      • 3.4.12.4 PDA-4 Death certificate signed date/time (TS) 01577
      • 3.4.12.5 PDA-5 Death certified by (XCN) 01578
      • 3.4.12.6 PDA-6 Autopsy indicator (ID) 01579
      • 3.4.12.7 PDA-7 Autopsy start and end date/time (DR) 01580
      • 3.4.12.8 PDA-8 Autopsy performed by (XCN) 01581
      • 3.4.12.9 PDA-9 Coroner Indicator (ID) 01582
  • 3.5 EXAMPLE TRANSACTIONS
    • 3.5.1 Admit/visit notification - event A01 (admitted patient)-
    • 3.5.2 Pre-admit notification - event A05 (nonadmitted patient)
    • 3.5.3 Register a patient - event A04 (nonadmitted patient)
    • 3.5.4 Change an outpatient to an inpatient - event A06
    • 3.5.5 Transfer patient - event A02 (first example)
    • 3.5.6 Cancel transfer - event A12
    • 3.5.7 Transfer patient - event A02 (second example)
    • 3.5.8 Discharge patient - event A03
    • 3.5.9 Update adverse reaction info - unique identifier is provided - event A60 (where unique identifier is provided)
    • 3.5.10 Update adverse reaction info - allergen code provides unique identifier - event A60 (where the allergen code provides unique identifier)
  • 3.6 IMPLEMENTATION NOTES
    • 3.6.1 Swapping a patient
    • 3.6.2 Merging patient/person information
      • 3.6.2.1 Definitions: Merge, move, and change identifier events
        • 3.6.2.1.1 Hierarchy of identifiers
        • 3.6.2.1.2 Merge
        • 3.6.2.1.3 Move
        • 3.6.2.1.4 Change identifier
        • 3.6.2.1.5 Source and target identifiers
        • 3.6.2.1.6 Tightly coupled relationship
        • 3.6.2.1.7 Ordered pairwise relationship
        • 3.6.2.1.8 Identifier type / assigning authority relationship
        • 3.6.2.1.9 Global merge and move message construct versus repeating segment message constructs
        • 3.6.2.1.10 Identifier renumbering
        • 3.6.2.1.11 Superior identifier reporting
      • 3.6.2.2 Trigger events
        • 3.6.2.2.1 A40 - merge patient - patient identifier list
        • 3.6.2.2.2 A40 - merge patient - patient identifier list (repeating segment)
        • 3.6.2.2.3 A41 - merge account - patient account number (global)
        • 3.6.2.2.4 A41 - merge account - patient account number (repeating segment)
        • 3.6.2.2.5 A42 - Merge visit - visit number
        • 3.6.2.2.6 A43 - move patient information - patient identifier list
        • 3.6.2.2.7 A44 - move account information - patient account number
        • 3.6.2.2.8 A45 - move visit information - visit number (repeating segment)
        • 3.6.2.2.9 A45 - move visit information - visit number (repeating segment)
        • 3.6.2.2.10 A47 - change patient identifier list
        • 3.6.2.2.11 A49 - change patient account number
        • 3.6.2.2.12 A50 - change visit number
        • 3.6.2.2.13 A51 - change alternate visit ID
        • 3.6.2.2.14 Example using multiple messages
        • 3.6.2.2.15 Example using multiple messages
    • 3.6.3 Patient record links
    • 3.6.4 MPI Integration - an introduction
      • 3.6.4.1 Definitions - what is an MPI?
      • 3.6.4.2 HL7 and CORBAmed PIDS
      • 3.6.4.3 MPI QUERY for person lookup and identification
      • 3.6.4.4 Client system assigns identifier, person exists on MPI only
      • 3.6.4.5 Client system assigns identifier, person exists on both systems
      • 3.6.4.6 Client system assigns identifier, person exists on neither system
      • 3.6.4.7 MPI assigns identifier, person exists on MPI
      • 3.6.4.8 MPI assigns identifier, person exists on both systems
      • 3.6.4.9 MPI assigns identifier, person exists on neither system
    • 3.6.5 Usage notes: Non-human PID patient identification
  • 3.7 REFERENCED DOCUMENTS
  • 3.8 OUTSTANDING ISSUES

HL7 v2.4 Chapter 4

• 4 .Order Entry
  • 4.1 CHAPTER 4 CONTENTS
  • 4.2 PURPOSE
    • 4.2.1 Preface (organization of this chapter)
    • 4.2.2 Glossary
      • 4.2.2.1 Filler:
      • 4.2.2.2 Observation segment:
      • 4.2.2.3 Order:
      • 4.2.2.4 Order detail segment:
      • 4.2.2.5 Placer:
      • 4.2.2.6 Placer order group:
  • 4.3 QUANTITY/TIMING (TQ) DATA TYPE DEFINITION
    • 4.3.1 Quantity component (CQ)
    • 4.3.2 Interval component (CM)
      • 4.3.2.1 Repeat pattern
      • 4.3.2.2 Explicit time interval
    • 4.3.3 Duration component (ST)
    • 4.3.4 Start date/time component (TS)
    • 4.3.5 End date/time component (TS)
    • 4.3.6 Priority component (ST)
    • 4.3.7 Condition component (ST)
    • 4.3.8 Text component (TX)
    • 4.3.9 Conjunction component (ID)
    • 4.3.10 Order sequencing component (CM)
      • 4.3.10.1 Subcomponents of sequences
      • 4.3.10.2 Cyclic placer order groups
      • 4.3.10.3 Inheritance of order status
    • 4.3.11 Occurrence duration component (CE) )
    • 4.3.12 Total occurrences component (NM) )
    • 4.3.13 Examples of quantity/timing usage
  • 4.4 GENERAL TRIGGER EVENTS & MESSAGE DEFINITIONS
    • 4.4.1 ORM - general order message (event O01)
      • 4.4.1.1 ORM use notes
    • 4.4.2 ORR - general order response message response to any ORM (event O02)
      • 4.4.2.1 Note: ORRs for supply, pharmacy, and dietary orders all have slightly different message syntax; refer to the appropriate sections as detailed in Section 4.4.1.1, ORM use notes, for exact details.
    • 4.4.3 OSQ/OSR- query response for order status (event Q06)
      • 4.4.3.1 Query usage notes
    • 4.4.4 OMG - general clinical order message (event O19)
    • 4.4.5 ORG - general clinical order acknowledgement message (event O20)
    • 4.4.6 OML - laboratory order message (event O21)
    • 4.4.7 ORL - general laboratory order response message to any OML (event O22)
  • 4.5 GENERAL SEGMENTS
    • 4.5.1 ORC - common order segment
      • 4.5.1.0 ORC field definitions
      • 4.5.1.1 ORC-1 Order control (ID) 00215
        • 4.5.1.1.1 Table notes for order control codes of ORC
      • 4.5.1.2 ORC-2 Placer order number (EI) 00216
      • 4.5.1.3 ORC-3 Filler order number (EI) 00217
      • 4.5.1.4 ORC-4 Placer group number (EI) 00218
      • 4.5.1.5 ORC-5 Order status (ID) 00219
      • 4.5.1.6 ORC-6 Response flag (ID) 00220
      • 4.5.1.7 ORC-7 Quantity/timing (TQ) 00221
      • 4.5.1.8 ORC-8 Parent (CM) 00222
      • 4.5.1.9 ORC-9 Date/time of transaction (TS) 00223
      • 4.5.1.10 ORC-10 Entered by (XCN) 00224
      • 4.5.1.11 ORC-11 Verified by (XCN) 00225
      • 4.5.1.12 ORC-12 Ordering provider (XCN) 00226
      • 4.5.1.13 ORC-13 'Enterer's location (PL) 00227
      • 4.5.1.14 ORC-14 Call back phone number (XTN) 00228
      • 4.5.1.15 ORC-15 Order effective date/time (TS) 00229
      • 4.5.1.16 ORC-16 Order control code reason (CE) 00230
      • 4.5.1.17 ORC-17 Entering organization (CE) 00231
      • 4.5.1.18 ORC-18 Entering device (CE) 00232
      • 4.5.1.19 ORC-19 Action by (XCN) 00233
      • 4.5.1.20 ORC-20 Advanced beneficiary notice code (CE) 01310
      • 4.5.1.21 ORC-21 Ordering facility name (XON) 01311
      • 4.5.1.22 ORC-22 Ordering facility address (XAD) 01312
      • 4.5.1.23 ORC-23 Ordering facility phone number (XTN) 01313
      • 4.5.1.24 ORC-24 Ordering provider address (XAD) 01314
      • 4.5.1.25 ORC-25 Order status modifier (CWE) 01473
    • 4.5.2 BLG - billing segment
      • 4.5.2.0 BLG field definitions
      • 4.5.2.1 BLG-1 When to charge (CM) 00234
      • 4.5.2.2 BLG-2 Charge type (ID) 00235
      • 4.5.2.3 BLG-3 Account ID (CX) 00236
    • 4.5.3 OBR - observation request segment
      • 4.5.3.0 OBR field definitions
      • 4.5.3.1 OBR-1 Set ID - OBR (SI) 00237
      • 4.5.3.2 OBR-2 Placer order number (EI) 00216
      • 4.5.3.3 OBR-3 Filler order number (EI) 00217
      • 4.5.3.4 OBR-4 Universal service identifier (CE) 00238
      • 4.5.3.5 OBR-5 Priority - OBR (ID) 00239
      • 4.5.3.6 OBR-6 Requested date/time (TS) 00240
      • 4.5.3.7 OBR-7 Observation date/time (TS) 00241
      • 4.5.3.8 OBR-8 Observation end date/time (TS) 00242
      • 4.5.3.9 OBR-9 Collection volume (CQ) 00243
      • 4.5.3.10 OBR-10 Collector identifier (XCN) 00244
      • 4.5.3.11 OBR-11 Specimen action code (ID) 00245
      • 4.5.3.12 OBR-12 Danger code (CE) 00246
      • 4.5.3.13 OBR-13 Relevant clinical information (ST) 00247
      • 4.5.3.14 OBR-14 Specimen received date/time (TS) 00248
      • 4.5.3.15 OBR-15 Specimen source (CM) 00249
      • 4.5.3.16 OBR-16 Ordering provider (XCN) 00226
      • 4.5.3.17 OBR-17 Order callback phone number (XTN) 00250
      • 4.5.3.18 OBR-18 Placer field 1 (ST) 00251
      • 4.5.3.19 OBR-19 Placer field 2 (ST) 00252
      • 4.5.3.20 OBR-20 Filler field 1 (ST) 00253
      • 4.5.3.21 OBR-21 Filler field 2 (ST) 00254
      • 4.5.3.22 OBR-22 Results rpt/status chng - date/time (TS) 00255
      • 4.5.3.23 OBR-23 Charge to practice (CM) 00256
      • 4.5.3.24 OBR-24 Diagnostic serv sect ID (ID) 00257
      • 4.5.3.25 OBR-25 Result status (ID) 00258
      • 4.5.3.26 OBR-26 Parent result (CM) 00259
      • 4.5.3.27 OBR-27 Quantity/timing (TQ) 00221
      • 4.5.3.28 OBR-28 Result copies to (XCN) 00260
      • 4.5.3.29 OBR-29 Parent (CM) 00222
      • 4.5.3.30 OBR-30 Transportation mode (ID) 00262
      • 4.5.3.31 OBR-31 Reason for study (CE) 00263
      • 4.5.3.32 OBR-32 Principal result interpreter (CM) 00264
      • 4.5.3.33 OBR-33 Assistant result interpreter (CM) 00265
      • 4.5.3.34 OBR-34 Technician (CM) 00266
      • 4.5.3.35 OBR-35 Transcriptionist (CM) 00267
      • 4.5.3.36 OBR-36 Scheduled date/time (TS) 00268
      • 4.5.3.37 OBR-37 Number of sample containers (NM) 01028
      • 4.5.3.38 OBR-38 Transport logistics of collected sample (CE) 01029
      • 4.5.3.39 OBR-39 Collector's comment (CE) 01030'
      • 4.5.3.40 OBR-40 Transport arrangement responsibility (CE) 01031
      • 4.5.3.41 OBR-41 Transport arranged (ID) 01032
      • 4.5.3.42 OBR-42 Escort required (ID) 01033
      • 4.5.3.43 OBR-43 Planned patient transport comment (CE) 01034
      • 4.5.3.44 OBR-44 Procedure code (CE) 00393
      • 4.5.3.45 OBR-45 Procedure code modifier (CE) 01316
      • 4.5.3.46 OBR-46 Placer supplemental service information (CE) 01474
      • 4.5.3.47 OBR-47 Filler supplemental service information (CE) 01475
  • 4.6 GENERAL MESSAGE EXAMPLES
    • 4.6.1 An order replaced by three orders
    • 4.6.2 Ordering non-medical services
      • 4.6.2.1 Examples
  • 4.7 DIET TRIGGER EVENTS & MESSAGE DEFINITIONS
    • 4.7.1 OMD - dietary order (event O03)
    • 4.7.2 ORD - dietary order acknowledgment (event O04)
  • 4.8 DIET SEGMENTS
    • 4.8.1 ODS - dietary orders, supplements, and preferences segment
      • 4.8.1.0 ODS field definitions
      • 4.8.1.1 ODS-1 Type (ID) 00269
      • 4.8.1.2 ODS-2 Service period (CE) 00270
      • 4.8.1.3 ODS-3 Diet, supplement, or preference code (CE) 00271
      • 4.8.1.4 ODS-4 Text instruction (ST) 00272
    • 4.8.2 ODT - diet tray instructions segment
      • 4.8.2.0 ODT field definitions
      • 4.8.2.1 ODT-1 Tray type (CE) 00273
      • 4.8.2.2 ODT-2 Service period (CE) 00270
      • 4.8.2.3 ODT-3 Text instruction (ST) 00272
  • 4.9 DIET MESSAGE EXAMPLES
    • 4.9.1 Typical progression of orders for a surgery patient
    • 4.9.2 Complex order
    • 4.9.3 Tube feeding
    • 4.9.4 Patient preference
  • 4.10 SUPPLY TRIGGER EVENTS & MESSAGES
    • 4.10.1 OMS - stock requisition order message (event O05)
    • 4.10.2 ORS - stock requisition order acknowledgment message (event O06)
    • 4.10.3 OMN - non-stock requisition order message (event O07)
    • 4.10.4 ORN - non-stock requisition order acknowledgment message (event O08)
  • 4.11 SUPPLY SEGMENTS
    • 4.11.1 RQD - requisition detail segment
      • 4.11.1.0 RQD field definitions
      • 4.11.1.1 RQD-1 Requisition line number (SI) 00275
      • 4.11.1.2 RQD-2 Item code - internal (CE) 00276
      • 4.11.1.3 RQD-3 Item code - external (CE) 00277
      • 4.11.1.4 RQD-4 Hospital item code (CE) 00278
      • 4.11.1.5 RQD-5 Requisition quantity (NM) 00279
      • 4.11.1.6 RQD-6 Requisition unit of measure (CE) 00280
      • 4.11.1.7 RQD-7 Dept. cost center (IS) 00281
      • 4.11.1.8 RQD-8 Item natural account code (IS) 00282
      • 4.11.1.9 RQD-9 Deliver to ID (CE) 00283
      • 4.11.1.10 RQD-10 Date needed (DT) 00284
    • 4.11.2 RQ1 - requisition detail-1 segment
      • 4.11.2.0 RQ1 field definitions
      • 4.11.2.1 RQ1-1 Anticipated price (ST) 00285
      • 4.11.2.2 RQ1-2 Manufacturer identifier (CE) 00286
      • 4.11.2.3 RQ1-3 Manufacturer's catalog (ST) 00287'
      • 4.11.2.4 RQ1-4 Vendor ID (CE) 00288
      • 4.11.2.5 RQ1-5 Vendor catalog (ST) 00289
      • 4.11.2.6 RQ1-6 Taxable (ID) 00290
      • 4.11.2.7 RQ1-7 Substitute allowed (ID) 00291
  • 4.12 SUPPLY MESSAGE EXAMPLES
    • 4.12.1 Patient order
    • 4.12.2 Replenish Supply Closet
  • 4.13 PHARMACY/TREATMENT TRIGGER EVENTS & MESSAGES
    • 4.13.1 Usage notes for pharmacy/treatment messages
    • 4.13.2 IV solution groups
    • 4.13.3 OMP - pharmacy/treatment order message (event O09)
    • 4.13.4 ORP - pharmacy/treatment order acknowledgment (event O10)
    • 4.13.5 RDE - pharmacy/treatment encoded order message (event O11)
    • 4.13.6 RRE - pharmacy/treatment encoded order acknowledgment (event O12)
    • 4.13.7 RDS - pharmacy/treatment dispense message (event O13)
    • 4.13.8 RRD - pharmacy/treatment dispense acknowledgement message (event O14)
    • 4.13.9 RGV - pharmacy/treatment give message (event O15)
    • 4.13.10 RRG - pharmacy/treatment give acknowledgment message (event O16)
    • 4.13.11 RAS - pharmacy/treatment administration message (event O17)
    • 4.13.12 RRA - pharmacy/treatment administration acknowledgment message (event O18)
    • 4.13.13 ROR - pharmacy/treatment order response (event Q26)
    • 4.13.14 RAR - pharmacy/treatment administration information (event Q27)
    • 4.13.15 RDR - pharmacy/treatment dispense information (event Q28)
    • 4.13.16 RER - pharmacy/treatment encoded order information (event Q29)
    • 4.13.17 RGR - pharmacy/treatment dose information (event Q30)
  • 4.14 PHARMACY/TREATMENT SEGMENTS
    • 4.14.1 RXO - pharmacy/treatment order segment
      • 4.14.1.0 RXO field definitions
      • 4.14.1.1 RXO-1 Requested give code (CE) 00292
      • 4.14.1.2 RXO-2 Requested give amount - minimum (NM) 00293
      • 4.14.1.3 RXO-3 Requested give amount - maximum (NM) 00294
      • 4.14.1.4 RXO-4 Requested give units (CE) 00295
      • 4.14.1.5 RXO-5 Requested dosage form (CE) 00296
      • 4.14.1.6 RXO-6 Provider's pharmacy/treatment instructions (CE) 00297'
      • 4.14.1.7 RXO-7 Provider's administration instructions (CE) 00298'
      • 4.14.1.8 RXO-8 Deliver-to location (CM) 00299
      • 4.14.1.9 RXO-9 Allow substitutions (ID) 00300
      • 4.14.1.10 RXO-10 Requested dispense code (CE) 00301
      • 4.14.1.11 RXO-11 Requested dispense amount (NM) 00302
      • 4.14.1.12 RXO-12 Requested dispense units (CE) 00303
      • 4.14.1.13 RXO-13 Number of refills (NM) 00304
      • 4.14.1.14 RXO-14 Ordering provider's DEA number (XCN) 00305'
      • 4.14.1.15 RXO-15 Pharmacist/treatment supplier's verifier ID (XCN) 00306
      • 4.14.1.16 RXO-16 Needs human review (ID) 00307
      • 4.14.1.17 RXO-17 Requested give per (time unit) (ST) 00308
      • 4.14.1.18 RXO-18 Requested give strength (NM) 01121
      • 4.14.1.19 RXO-19 Requested give strength units (CE) 01122
      • 4.14.1.20 RXO-20 Indication (CE) 01123
      • 4.14.1.21 RXO-21 Requested give rate amount (ST) 01218
      • 4.14.1.22 RXO-22 Requested give rate units (CE) 01219
      • 4.14.1.23 RXO-23 Total daily dose (CQ) 00329
      • 4.14.1.24 RXO-24 Supplementary code (CE) 01476
    • 4.14.2 RXR - pharmacy/treatment route segment
      • 4.14.2.0 RXR field definitions
      • 4.14.2.1 RXR-1 Route (CE) 00309
      • 4.14.2.2 RXR-2 Administration site (CE) 00310
      • 4.14.2.3 RXR-3 Administration device (CE) 00311
      • 4.14.2.4 RXR-4 Administration method (CE) 00312
      • 4.14.2.5 RXR-5 Routing instruction (CE) 01315
    • 4.14.3 RXC - pharmacy/treatment component order segment
      • 4.14.3.0 RXC field definitions
      • 4.14.3.1 RXC-1 RX component type (ID) 00313
      • 4.14.3.2 RXC-2 Component code (CE) 00314
      • 4.14.3.3 RXC-3 Component amount (NM) 00315
      • 4.14.3.4 RXC-4 Component units (CE) 00316
      • 4.14.3.5 RXC-5 Component strength (NM) 01124
      • 4.14.3.6 RXC-6 Component strength units (CE) 01125
      • 4.14.3.7 RXC-7 Supplementary code (CE) 01476
    • 4.14.4 RXE - pharmacy/treatment encoded order segment
      • 4.14.4.0 RXE field definitions
      • 4.14.4.1 RXE-1 Quantity/timing (TQ) 00221
      • 4.14.4.2 RXE-2 Give code (CE) 00317
      • 4.14.4.3 RXE-3 Give amount - minimum (NM) 00318
      • 4.14.4.4 RXE-4 Give amount - maximum (NM) 00319
      • 4.14.4.5 RXE-5 Give units (CE) 00320
      • 4.14.4.6 RXE-6 Give dosage form (CE) 00321
      • 4.14.4.7 RXE-7 Provider's administration instructions (CE) 00298'
      • 4.14.4.8 RXE-8 Deliver-to location (CM) 00299
      • 4.14.4.9 RXE-9 Substitution status (ID) 00322
      • 4.14.4.10 RXE-10 Dispense amount (NM) 00323
      • 4.14.4.11 RXE-11 Dispense units (CE) 00324
      • 4.14.4.12 RXE-12 Number of refills (NM) 00304
      • 4.14.4.13 RXE-13 Ordering provider's DEA number (XCN) 00305'
      • 4.14.4.14 RXE-14 Pharmacist/treatment supplier's verifier ID (XCN) 00306'
      • 4.14.4.15 RXE-15 Prescription number (ST) 00325
      • 4.14.4.16 RXE-16 Number of refills remaining (NM) 00326
      • 4.14.4.17 RXE-17 Number of refills/doses dispensed (NM) 00327
      • 4.14.4.18 RXE-18 D/T of most recent refill or dose dispensed (TS) 00328
      • 4.14.4.19 RXE-19 Total daily dose (CQ) 00329
      • 4.14.4.20 RXE-20 Needs human review (ID) 00307
      • 4.14.4.21 RXE-21 Pharmacy/treatment supplier's special dispensing instructions (CE) 00330
      • 4.14.4.22 RXE-22 Give per (time unit) (ST) 00331
      • 4.14.4.23 RXE-23 Give rate amount (ST) 00332
      • 4.14.4.24 RXE-24 Give rate units (CE) 00333
      • 4.14.4.25 RXE-25 Give strength (NM) 01126
      • 4.14.4.26 RXE-26 Give strength units (CE) 01127
      • 4.14.4.27 RXE-27 Give indication (CE) 01128
      • 4.14.4.28 RXE-28 Dispense package size (NM) 01220
      • 4.14.4.29 RXE-29 Dispense package size unit (CE) 01221
      • 4.14.4.30 RXE-30 Dispense package method (ID) 01222
      • 4.14.4.31 RXE-31 Supplementary code (CE) 01476
    • 4.14.5 RXD - pharmacy/treatment dispense segment
      • 4.14.5.0 RXD field definitions
      • 4.14.5.1 RXD-1 Dispense sub-ID counter (NM) 00334
      • 4.14.5.2 RXD-2 Dispense/give code (CE) 00335
      • 4.14.5.3 RXD-3 Date/time dispensed (TS) 00336
      • 4.14.5.4 RXD-4 Actual dispense amount (NM) 00337
      • 4.14.5.5 RXD-5 Actual dispense units (CE) 00338
      • 4.14.5.6 RXD-6 Actual dosage form (CE) 00339
      • 4.14.5.7 RXD-7 Prescription number (ST) 00325
      • 4.14.5.8 RXD-8 Number of refills remaining (NM) 00326
      • 4.14.5.9 RXD-9 Dispense notes (ST) 00340
      • 4.14.5.10 RXD-10 Dispensing provider (XCN) 00341
      • 4.14.5.11 RXD-11 Substitution status (ID) 00322
      • 4.14.5.12 RXD-12 Total daily dose (CQ) 00329
      • 4.14.5.13 RXD-13 Dispense-to location (CM) 01303
      • 4.14.5.14 RXD-14 Needs human review (ID) 00307
      • 4.14.5.15 RXD-15 Pharmacy/treatment supplier's special dispensing instructions (CE) 00330
      • 4.14.5.16 RXD-16 Actual strength (NM) 01132
      • 4.14.5.17 RXD-17 Actual strength unit (CE) 01133
      • 4.14.5.18 RXD-18 Substance lot number (ST) 01129
      • 4.14.5.19 RXD-19 Substance expiration date (TS) 01130
      • 4.14.5.20 RXD-20 Substance manufacturer name (CE) 01131
      • 4.14.5.21 RXD-21 Indication (CE) 01123
      • 4.14.5.22 RXD-22 Dispense package size (NM) 01220
      • 4.14.5.23 RXD-23 Dispense package size unit (CE) 01221
      • 4.14.5.24 RXD-24 Dispense package method (ID) 01222
      • 4.14.5.25 RXD-25 Supplementary code (CE) 01476
      • 4.14.5.26 RXD-26 Initiating location (CE) 01477
      • 4.14.5.27 RXD-27 Packaging/assembly location (CE) 01478
    • 4.14.6 RXG - pharmacy/treatment give segment
      • 4.14.6.0 RXG fields definitions
      • 4.14.6.1 RXG-1 Give sub-ID counter (NM) 00342
      • 4.14.6.2 RXG-2 Dispense sub-ID counter (NM) 00334
      • 4.14.6.3 RXG-3 Quantity/timing (TQ) 00221
      • 4.14.6.4 RXG-4 Give code (CE) 00317
      • 4.14.6.5 RXG-5 Give amount - minimum (NM) 00318
      • 4.14.6.6 RXG-6 Give amount - maximum (NM) 00319
      • 4.14.6.7 RXG-7 Give units (CE) 00320
      • 4.14.6.8 RXG-8 Give dosage form (CE) 00321
      • 4.14.6.9 RXG-9 Administration notes (CE) 00351
      • 4.14.6.10 RXG-10 Substitution status (ID) 00322
      • 4.14.6.11 RXG-11 Dispense-to location (CM) 01303
      • 4.14.6.12 RXG-12 Needs human review (ID) 00307
      • 4.14.6.13 RXG-13 Pharmacy/treatment supplier's special administration instructions (CE) 00343
      • 4.14.6.14 RXG-14 Give per (time unit) (ST) 00331
      • 4.14.6.15 RXG-15 Give rate amount (ST) 00332
      • 4.14.6.16 RXG-16 Give rate units (CE) 00333
      • 4.14.6.17 RXG-17 Give strength (NM) 01126
      • 4.14.6.18 RXG-18 Give strength units (CE) 01127
      • 4.14.6.19 RXG-19 Substance lot number (ST) 01129
      • 4.14.6.20 RXG-20 Substance expiration date (TS) 01130
      • 4.14.6.21 RXG-21 Substance manufacturer name (CE) 01131
      • 4.14.6.22 RXG-22 Indication (CE) 01123
    • 4.14.7 RXA - pharmacy/treatment administration segment
      • 4.14.7.0 RXA field definitions
      • 4.14.7.1 RXA-1 Give sub-ID counter (NM) 00342
      • 4.14.7.2 RXA-2 Administration sub-ID counter (NM) 00344
      • 4.14.7.3 RXA-3 Date/time start of administration (TS) 00345
      • 4.14.7.4 RXA-4 Date/time end of administration (if applies) (TS) 00346
      • 4.14.7.5 RXA-5 Administered code (CE) 00347
      • 4.14.7.6 RXA-6 Administered amount (NM) 00348
      • 4.14.7.7 RXA-7 Administered units (CE) 00349
      • 4.14.7.8 RXA-8 Administered dosage form (CE) 00350
      • 4.14.7.9 RXA-9 Administration notes (CE) 00351
      • 4.14.7.10 RXA-10 Administering provider (XCN) 00352
      • 4.14.7.11 RXA-11 Administered-at location (CM) 00353
      • 4.14.7.12 RXA-12 Administered per (time unit) (ST) 00354
      • 4.14.7.13 RXA-13 Administered strength (NM) 01134
      • 4.14.7.14 RXA-14 Administered strength units (CE) 01135
      • 4.14.7.15 RXA-15 Substance lot number (ST) 01129
      • 4.14.7.16 RXA-16 Substance expiration date (TS) 01130
      • 4.14.7.17 RXA-17 Substance manufacturer name (CE) 01131
      • 4.14.7.18 RXA-18 Substance/treatment refusal reason (CE) 01136
      • 4.14.7.19 RXA-19 Indication (CE) 01123
      • 4.14.7.20 RXA-20 Completion status (ID) 01223
      • 4.14.7.21 RXA-21 Action code - RXA (ID) 01224 -
      • 4.14.7.22 RXA-22 System entry date/time (TS) 01225
  • 4.15 PHARMACY/TREATMENT MESSAGE EXAMPLES
    • 4.15.1 Example of various levels of coding in an order
    • 4.15.2 RXO segment field examples
    • 4.15.3 RXD segment field examples
    • 4.15.4 RDS with FT1 segments example
    • 4.15.5 Alternating IV order messages
    • 4.15.6 Query examples
  • 4.16 PHARMACY/TREATMENT TRANSACTION FLOW DIAGRAM
    • 4.16.1 ORM/RXO:
    • 4.16.2 RDE/RXE:
    • 4.16.3 RDS/RXD:
    • 4.16.4 RGV/RXG:
    • 4.16.5 RAS/RXA:
  • 4.17 VACCINE TRIGGER EVENTS & MESSAGE DEFINITIONS
    • 4.17.1 Vaccine administration data
    • 4.17.2 Queries for immunization records (QRF Segments)
    • 4.17.3 VXQ -query for vaccination record (event V01)
    • 4.17.4 VXX - response to vaccination query returning multiple PID matches (event V02)
    • 4.17.5 VXR - vaccination record response (event V03)
    • 4.17.6 VXU - unsolicited vaccination record update (event V04)
  • 4.18 VACCINE SEGMENTS
    • 4.18.1 RXA - segment usage In vaccine messages
      • 4.18.1.0 RXA field definitions
      • 4.18.1.1 Using RXA-5 in vaccine messages
      • 4.18.1.2 Using RXA-17 in vaccine messages
  • 4.19 VACCINATION MESSAGE EXAMPLES
    • 4.19.1 VXQ - query for vaccination record
    • 4.19.2 VXX - response to vaccination query with multiple PID matches
    • 4.19.3 VXR - vaccination record response
    • 4.19.4 VXU - unsolicited vaccination record update
    • 4.19.5 Query acknowledgment with no records found
  • 4.20 TABLES LISTINGS
    • 4.20.1 HL7 Table 0119 - Order control codes -
    • 4.20.2 HL7 Table 0070 - Specimen source codes -
  • 4.21 OUTSTANDING ISSUES

HL7 V2.4 Chapter 5

• 5 .Query
  • 5.1 CHAPTER 5 CONTENTS
  • 5.2 INTRODUCTION
    • 5.2.1 Query/response model
    • 5.2.2 Evolution of the query standard
    • 5.2.3 Query development methodology
    • 5.2.4 Response format
      • 5.2.4.1 Segment pattern response
      • 5.2.4.2 Tabular response
      • 5.2.4.3 Display response
      • 5.2.4.4 Choosing among available response formats
    • 5.2.5 Query specification formats
      • 5.2.5.1 Expressing the same data using the variants
        • 5.2.5.1.1 Expression as simple parameters
        • 5.2.5.1.2 Expression as query by example
        • 5.2.5.1.3 Expression as a complex expression
    • 5.2.6 Summary chart of query/response pairs
  • 5.3 QUERY/RESPONSE CONFORMANCE STATEMENT
    • 5.3.1 Using the Conformance Statement
      • 5.3.1.1 Query with tabular response example
      • 5.3.1.2 Example of Conformance Statement with tabular response
    • 5.3.2 Formal specification of the conformance statement
      • 5.3.2.1 Steps for developing a conformance statement
      • 5.3.2.2 Conformance Statement introduction
      • 5.3.2.3 Query grammar
      • 5.3.2.4 Response grammar
      • 5.3.2.5 Response grammar for display response
      • 5.3.2.6 QPD input parameter specification
      • 5.3.2.7 QPD input parameter field description and commentary
      • 5.3.2.8 QBE input parameter specification
      • 5.3.2.9 QBE input parameter field description and commentary
      • 5.3.2.10 RCP input parameter field description and commentary
      • 5.3.2.11 Input specification: virtual table
      • 5.3.2.12 Virtual table field description and commentary
      • 5.3.2.13 Output specification for tabular response
    • 5.3.3 Conformance statement templates
      • 5.3.3.1 Conformance statement template for query with tabular response
      • 5.3.3.2 Conformance statement template for query with segment pattern response
      • 5.3.3.3 Conformance statement for query with display response
      • 5.3.3.4 Conformance statement table summaries
  • 5.4 QUERY/RESPONSE MESSAGE PAIRS
    • 5.4.1 QBP/RSP - query by parameter/segment pattern response (events vary )
    • 5.4.2 QBP/RTB - query by parameter/tabular response (events vary)
    • 5.4.3 QBP/RDY - query by parameter/display response (events vary)
    • 5.4.4 QSB - Create subscription (event Q16)
    • 5.4.5 QVR - query for previous events (event Q17)
    • 5.4.6 QCN/ACK - cancel query/acknowledge message (event J01)
    • 5.4.7 QSX /ACK - cancel subscription/acknowledge message (event J02)
  • 5.5 QUERY/RESPONSE MESSAGE SEGMENTS
    • 5.5.1 DSP - display data segment
      • 5.5.1.0 DSP field definitions
      • 5.5.1.1 DSP-1 Set ID - DSP (SI) 00061
      • 5.5.1.2 DSP-2 Display level (SI) 00062
      • 5.5.1.3 DSP-3 Data line (TX) 00063
      • 5.5.1.4 DSP-4 Logical break point (ST) 00064
      • 5.5.1.5 DSP-5 Result ID (TX) 00065
    • 5.5.2 QAK- query acknowledgment segment
      • 5.5.2.0 QAK field definitions
      • 5.5.2.1 QAK-1 Query tag (ST) 00696
      • 5.5.2.2 QAK-2 Query response status (ID) 00708
      • 5.5.2.3 QAK-3 Message query name (CE) 01375
      • 5.5.2.4 QAK-4 Hit count total (NM) 01434
      • 5.5.2.5 QAK-5 This payload (NM) 01622
      • 5.5.2.6 QAK-6 Hits remaining (NM) 01623
    • 5.5.3 QID- query identification segment
      • 5.5.3.0 QID field definitions
      • 5.5.3.1 QID-1 Query tag (ST) 00696
      • 5.5.3.2 QID-2 Message query name (CE) 01375
      • 5.5.3.0 QPD field definitions
      • 5.5.3.1 QPD-1 Message query name (CE) 01375
      • 5.5.3.2 QPD-2 Query tag (ST) 00696
      • 5.5.3.3 QPD-3 User parameters (Varies) 01435
        • 5.5.3.3.1 Note on QPD usage for query by example variant.
    • 5.5.4 QRI - query response instance segment
      • 5.5.4.0 QRI field definitions
      • 5.5.4.1 QRI-1 Candidate confidence (NM) 01436
      • 5.5.4.2 QRI-2 Match reason code (IS) 01437
      • 5.5.4.3 QRI-3 Algorithm descriptor (CE) 01438
    • 5.5.5 RCP - response control parameter segment
      • 5.5.5.0 RCP field definitions
      • 5.5.5.1 RCP-1 Query priority (ID) 00027
      • 5.5.5.2 RCP-2 Quantity limited request (CQ) 00031
      • 5.5.5.3 RCP-3 Response modality (CE) 01440
      • 5.5.5.4 RCP-4 Execution and delivery time (TS) 01441
      • 5.5.5.5 RCP-5 Modify indicator (ID) 01443
      • 5.5.5.6 RCP-6 Sort-by field (SRT) 01624
      • 5.5.5.7 RCP-7 Segment group inclusion (ID) 01594
    • 5.5.6 RDF - table row definition segment
      • 5.5.6.0 RDF field definitions
      • 5.5.6.1 RDF-1 Number of columns per row (NM) 00701
      • 5.5.6.2 RDF-2 Column description (RCD) 00702
    • 5.5.7 RDT - table row data segment
      • 5.5.7.0 RDT field definitions
      • 5.5.7.1 RDT-1 Column value (Variable) 00703
  • 5.6 AUXILIARY QUERY PROTOCOLS
    • 5.6.1 Immediate vs. deferred response
      • 5.6.1.1 Immediate response
      • 5.6.1.2 Deferred response example
    • 5.6.2 Query cancellation
    • 5.6.3 Interactive continuation of response messages
      • 5.6.3.1 Interactive continuation algorithm and rules
      • 5.6.3.2 Use case
      • 5.6.3.3 Example of interactive continuation protocol
      • 5.6.3.4 Message fragmentation example
    • 5.6.4 Batch message as a query response
    • 5.6.5 Query error response
  • 5.7 PUBLISH AND SUBSCRIBE
    • 5.7.1 Introduction
    • 5.7.2 Details
    • 5.7.3 Examples
      • 5.7.3.1 Example of a publish and subscribe Conformance Statement
    • 5.7.4 Establishing a subscription
    • 5.7.5 Canceling a subscription
  • 5.8 QUERY IMPLEMENTATION CONSIDERATIONS
  • 5.9 QUERY/RESPONSE MESSAGE EXAMPLES
    • 5.9.1 Query by parameter (QBP) / segment pattern response (RSP)
      • 5.9.1.1 Proposed dispense history example and Conformance Statement
        • 5.9.1.1.1 Associated dispense history Conformance Statement
      • 5.9.1.2 Comprehensive pharmacy information examples and Conformance Statement
        • 5.9.1.2.1 Comprehensive pharmacy information Conformance Statement
    • 5.9.2 Query using QSC variant / segment pattern response examples
      • 5.9.2.1 Dispense information example and Conformance Statement
        • 5.9.2.1.1 Associated dispense information Conformance Statement
      • 5.9.2.2 Dispense information query showing different instantiation
      • 5.9.2.3 Lab results history example
        • 5.9.2.3.1 Lab results history Conformance Statement
      • 5.9.2.4 Lab example different instantiation
    • 5.9.3 Query by parameter (QBP) / tabular response (RTB)
      • 5.9.3.1 MPI example
        • 5.9.3.1.1 MPI Conformance Statement
      • 5.9.3.2 Pharmacy example:
        • 5.9.3.2.1 QBP/RTB dispense history Conformance Statement
    • 5.9.4 Query using QSC variant / tabular response (RTB)
      • 5.9.4.1 Pharmacy example
        • 5.9.4.1.1 QBP/RTB dispense history Conformance Statement using QSC variant
    • 5.9.5 Query by parameter (QBP) / display response (RDY)
      • 5.9.5.1 Dispense history display Conformance Statement
    • 5.9.6 Query using QSC variant (QBP) / display response (RDY)
      • 5.9.6.1 Dispense history display Conformance Statement using QSC variant
    • 5.9.7 Query by example (QBP) / tabular response (RTB)
      • 5.9.7.1 MPI Conformance Statement using QBE variant
      • 5.9.7.2 MPI Conformance Statement - Non query by example version
  • 5.10 SUPERCEDED QUERY/RESPONSE TRIGGER EVENTS AND MESSAGE PAIRS
    • 5.10.1 Display message
      • 5.10.1.1 Display vs. record-oriented messages
      • 5.10.1.2 UDM/ACK - unsolicited display update message (event Q05)
      • 5.10.1.3 Continuation of unsolicited display update message
    • 5.10.2 Original mode queries
      • 5.10.2.1 QRY/DSR - original mode display query - immediate response (event Q01)
        • 5.10.2.1.1 Original mode display query variants
    • 5.10.3 Original mode deferred access
      • 5.10.3.1 QRY/QCK - deferred query (event Q02)
      • 5.10.3.2 DSR/ACK - deferred response to a query (event Q03)
    • 5.10.4 Enhanced mode queries
      • 5.10.4.1 EQQ - embedded query language query (event Q04)
      • 5.10.4.2 RQQ - event replay query (event Q09)
      • 5.10.4.3 SPQ - stored procedure request (event Q08)
      • 5.10.4.4 VQQ - Virtual Table query (event Q07)
    • 5.10.5 Other query/response message segments
      • 5.10.5.1 EQL - embedded query language segment
        • 5.10.5.1.0 EQL field definitions
        • 5.10.5.1.1 EQL-1 Query tag (ST) 00696
        • 5.10.5.1.2 EQL-2 Query/response format code (ID) 00697
        • 5.10.5.1.3 EQL-3 EQL query name (CE) 00709
        • 5.10.5.1.4 EQL-4 EQL query statement (ST) 00710
      • 5.10.5.2 ERQ - event replay query segment
        • 5.10.5.2.0 ERQ field definitions
        • 5.10.5.2.1 ERQ-1 Query tag (ST) 00696
        • 5.10.5.2.2 ERQ-2 Event identifier (CE) 00706
        • 5.10.5.2.3 ERQ-3 Input parameter list (QIP) 00705
      • 5.10.5.3 QRD - original-style query definition segment
        • 5.10.5.3.0 QRD field definitions
        • 5.10.5.3.1 QRD-1 Query date/time (TS) 00025
        • 5.10.5.3.2 QRD-2 Query format code (ID) 00026
        • 5.10.5.3.3 QRD-3 Query priority (ID) 00027
        • 5.10.5.3.4 QRD-4 Query ID (ST) 00028
        • 5.10.5.3.5 QRD-5 Deferred response type (ID) 00029
        • 5.10.5.3.6 QRD-6 Deferred response date/time (TS) 00030
        • 5.10.5.3.7 QRD-7 Quantity limited request (CQ) 00031
        • 5.10.5.3.8 QRD-8 Who subject filter (XCN) 00032
        • 5.10.5.3.9 QRD-9 What subject filter (CE) 00033
        • 5.10.5.3.10 QRD-10 What department data code (CE) 00034
        • 5.10.5.3.11 QRD-11 What data code value qual (CM) 00035
        • 5.10.5.3.12 QRD-12 Query results level (ID) 00036
      • 5.10.5.4 QRF - original style query filter segment
        • 5.10.5.4.0 QRF field definitions
        • 5.10.5.4.1 QRF-1 Where subject filter (ST) 00037
        • 5.10.5.4.2 QRF-2 When data start date/time (TS) 00038
        • 5.10.5.4.3 QRF-3 When data end date/time (TS) 00039
        • 5.10.5.4.4 QRF-4 What user qualifier (ST) 00040
        • 5.10.5.4.5 QRF-5 Other QRY subject filter (ST) 00041
        • 5.10.5.4.6 QRF-6 Which date/time qualifier (ID) 00042
        • 5.10.5.4.7 QRF-7 Which date/time status qualifier (ID) 00043
        • 5.10.5.4.8 QRF-8 Date/time selection qualifier (ID) 00044
        • 5.10.5.4.9 QRF-9 When quantity/timing qualifier (TQ) 00694
        • 5.10.5.4.10 QRF-10 Search confidence threshold (NM) 01442
      • 5.10.5.5 SPR - stored procedure request definition segment
        • 5.10.5.5.0 SPR field definitions
        • 5.10.5.5.1 SPR-1 Query tag (ST) 00696
        • 5.10.5.5.2 SPR-2 Query/response format code (ID) 00697
        • 5.10.5.5.3 SPR-3 Stored procedure name (CE) 00704
        • 5.10.5.5.4 SPR-4 Input parameter list (QIP) 00705
      • 5.10.5.6 URD - results/update definition segment
        • 5.10.5.6.0 URD field definitions
        • 5.10.5.6.1 URD-1 R/U date/time (TS) 00045
        • 5.10.5.6.2 URD-2 Report priority (ID) 00046
        • 5.10.5.6.3 URD-3 R/U who subject definition (XCN) 00047
        • 5.10.5.6.4 URD-4 R/U what subject definition (CE) 00048
        • 5.10.5.6.5 URD-5 R/U what department code (CE) 00049
        • 5.10.5.6.6 URD-6 R/U display/print locations (ST) 00050
        • 5.10.5.6.7 URD-7 R/U results level (ID) 00051
      • 5.10.5.7 URS - unsolicited selection segment
        • 5.10.5.7.0 URS field definitions
        • 5.10.5.7.1 URS-1 R/U where subject definition (ST) 00052
        • 5.10.5.7.2 URS-2 R/U when data start date/time (TS) 00053
        • 5.10.5.7.3 URS-3 R/U when data end date/time (TS) 00054
        • 5.10.5.7.4 URS-4 R/U what user qualifier (ST) 00055
        • 5.10.5.7.5 URS-5 R/U other results subject definition (ST) 00056
        • 5.10.5.7.6 URS-6 R/U which date/time qualifier (ID) 00057
        • 5.10.5.7.7 URS-7 R/U which date/time status qualifier (ID) 00058
        • 5.10.5.7.8 URS-8 R/U date/time selection qualifier (ID) 00059
        • 5.10.5.7.9 URS-9 R/U quantity/timing qualifier (TQ) 00695
      • 5.10.5.8 VTQ - Virtual table query request segment
        • 5.10.5.8.0 VTQ field definitions
        • 5.10.5.8.1 VTQ-1 Query tag (ST) 00696
        • 5.10.5.8.2 VTQ-2 Query/response format code (ID) 00697
        • 5.10.5.8.3 VTQ-3 VT query name (CE) 00698
        • 5.10.5.8.4 VTQ-4 Virtual table name (CE) 00699
        • 5.10.5.8.5 VTQ-5 Selection criteria (QSC) 00700
    • 5.10.6 Other Query examples
      • 5.10.6.1 Original mode query with display-oriented response
      • 5.10.6.2 Enhanced mode query examples
        • 5.10.6.2.1 Embedded query language query
        • 5.10.6.2.2 Virtual Table query
        • 5.10.6.2.3 Stored procedure request
        • 5.10.6.2.4 The response to the above queries might look like the following:
        • 5.10.6.2.5 Embedded query language continuation query
        • 5.10.6.2.6 Virtual Table query continuation query
        • 5.10.6.2.7 Stored procedure request query continuation query
        • 5.10.6.2.8 Tabular response showing no further data
        • 5.10.6.2.9 Event replay query example
        • 5.10.6.2.10 Event replay response example
        • 5.10.6.2.11 Embedded query language (EQL) , Virtual Table, and stored procedure error response
        • 5.10.6.2.12 Event replay error response
  • 5.11 OUTSTANDING ISSUES

HL7 V2.4 Chapter 6

• 6. Financial Management
  • 6.1 CHAPTER 6 CONTENTS
  • 6.2 PURPOSE
  • 6.3 PATIENT ACCOUNTING MESSAGE SET
  • 6.4 TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 6.4.1 BAR/ACK - add patient account (event P01)
    • 6.4.2 BAR/ACK - purge patient accounts (event P02)
    • 6.4.3 DFT/ACK - post detail financial transactions (event P03)
    • 6.4.4 QRY/DSR - generate bills and accounts receivable statements (event P04)
    • 6.4.5 BAR/ACK - update account (event P05)
    • 6.4.6 BAR/ACK - end account (event P06)
    • 6.4.7 BAR/ACK - transmit ambulatory payment classification (APC) groups (event P10)
  • 6.5 MESSAGE SEGMENTS
    • 6.5.1 FT1 - financial transaction segment
      • 6.5.1.0 FT1 field definitions
      • 6.5.1.1 FT1-1 Set ID - FT1- (SI) 00355
      • 6.5.1.2 FT1-2 Transaction ID (ST) 00356
      • 6.5.1.3 FT1-3 Transaction batch ID (ST) 00357
      • 6.5.1.4 FT1-4 Transaction date (TS) 00358
      • 6.5.1.5 FT1-5 Transaction posting date (TS) 00359
      • 6.5.1.6 FT1-6 Transaction type (IS) 00360
      • 6.5.1.7 FT1-7 Transaction code (CE) 00361
      • 6.5.1.8 FT1-8 Transaction description (ST) 00362
      • 6.5.1.9 FT1-9 Transaction description - Alt- (ST) 00363
      • 6.5.1.10 FT1-10 Transaction quantity (NM) 00364
      • 6.5.1.11 FT1-11 Transaction amount - extended- (CP) 00365
      • 6.5.1.12 FT1-12 Transaction amount - unit- (CP) 00366
      • 6.5.1.13 FT1-13 Department code (CE) 00367
      • 6.5.1.14 FT1-14 Insurance plan ID (CE) 00368
      • 6.5.1.15 FT1-15 Insurance amount (CP) 00369
      • 6.5.1.16 FT1-16 Assigned patient location (PL) 00133
      • 6.5.1.17 FT1-17 Fee schedule (IS) 00370
      • 6.5.1.18 FT1-18 Patient type (IS) 00148
      • 6.5.1.19 FT1-19 Diagnosis code - FT1 (CE) 00371
      • 6.5.1.20 FT1-20 Performed by code (XCN) 00372
      • 6.5.1.21 FT1-21 Ordered by code (XCN) 00373
      • 6.5.1.22 FT1-22 Unit cost (CP) 00374
      • 6.5.1.23 FT1-23 Filler order number (EI) 00217
      • 6.5.1.24 FT1-24 Entered by code (XCN) 00765
      • 6.5.1.25 FT1-25 Procedure code (CE) 00393
      • 6.5.1.26 FT1-26 Procedure code modifier (CE) 01316
    • 6.5.2 DG1 - diagnosis segment
      • 6.5.2.0 DG1 field definitions
      • 6.5.2.1 DG1-1 Set ID - DG1 (SI) 00375
      • 6.5.2.2 DG1-2 Diagnosis coding method (ID) 00376
      • 6.5.2.3 DG1-3 Diagnosis code - DG1 (CE) 00377
      • 6.5.2.4 DG1-4 Diagnosis description (ST) 00378
      • 6.5.2.5 DG1-5 Diagnosis date/time (TS) 00379
      • 6.5.2.6 DG1-6 Diagnosis type (IS) 00380
      • 6.5.2.7 DG1-7 Major diagnostic category (CE) 00381
      • 6.5.2.8 DG1-8 Diagnostic related group (CE) 00382
      • 6.5.2.9 DG1-9 DRG approval indicator (ID) 00383
      • 6.5.2.10 DG1-10 DRG grouper review code (IS) 00384
      • 6.5.2.11 DG1-11 Outlier type (CE) 00385
      • 6.5.2.12 DG1-12 Outlier days (NM) 00386
      • 6.5.2.13 DG1-13 Outlier cost (CP) 00387
      • 6.5.2.14 DG1-14 Grouper version and type (ST) 00388
      • 6.5.2.15 DG1-15 Diagnosis priority (ID) 00389
      • 6.5.2.16 DG1-16 Diagnosing clinician (XCN) 00390
      • 6.5.2.17 DG1-17 Diagnosis classification (IS) 00766
      • 6.5.2.18 DG1-18 Confidential indicator (ID) 00767
      • 6.5.2.19 DG1-19 Attestation date/time (TS) 00768
    • 6.5.3 DRG - diagnosis related group segment
      • 6.5.3.0 DRG field definitions
      • 6.5.3.1 DRG-1 Diagnostic related group (CE) 00382
      • 6.5.3.2 DRG-2 DRG assigned date/time (TS) 00769
      • 6.5.3.3 DRG-3 DRG approval indicator (ID) 00383
      • 6.5.3.4 DRG-4 DRG grouper review code (IS) 00384
      • 6.5.3.5 DRG-5 Outlier type (CE) 00385
      • 6.5.3.6 DRG-6 Outlier days (NM) 00386
      • 6.5.3.7 DRG-7 Outlier cost (CP) 00387
      • 6.5.3.8 DRG-8 DRG payor (IS) 00770
      • 6.5.3.9 DRG-9 Outlier reimbursement (CP) 00771
      • 6.5.3.10 DRG-10 Confidential indicator (ID) 00767
      • 6.5.3.11 DRG-11 DRG transfer type (IS) 01500
    • 6.5.4 PR1 - procedures segment
      • 6.5.4.0 PR1 field definitions
      • 6.5.4.1 PR1-1 Set ID - PR1- (SI) 00391
      • 6.5.4.2 PR1-2 Procedure coding method (IS) 00392
      • 6.5.4.3 PR1-3 Procedure code (CE) 00393
      • 6.5.4.4 PR1-4 Procedure description (ST) 00394
      • 6.5.4.5 PR1-5 Procedure date/time (TS) 00395
      • 6.5.4.6 PR1-6 Procedure functional type (IS) 00396
      • 6.5.4.7 PR1-7 Procedure minutes (NM) 00397
      • 6.5.4.8 PR1-8 Anesthesiologist (XCN) 00398
      • 6.5.4.9 PR1-9 Anesthesia code (IS) 00399
      • 6.5.4.10 PR1-10 Anesthesia minutes (NM) 00400
      • 6.5.4.11 PR1-11 Surgeon (XCN) 00401
      • 6.5.4.12 PR1-12 Procedure practitioner (XCN) 00402
      • 6.5.4.13 PR1-13 Consent code (CE) 00403
      • 6.5.4.14 PR1-14 Procedure priority (ID) 00404
      • 6.5.4.15 PR1-15 Associated diagnosis code (CE) 00772
      • 6.5.4.16 PR1-16 Procedure code modifier (CE) 01316
      • 6.5.4.17 PR1-17 Procedure DRG type (IS) 01501
      • 6.5.4.18 PR1-18 Tissue type code (CE) 01502
    • 6.5.5 GT1 - guarantor segment
      • 6.5.5.0 GT1 field definitions
      • 6.5.5.1 GT1-1 Set ID - GT1- (SI) 00405
      • 6.5.5.2 GT1-2 Guarantor number (CX) 00406
      • 6.5.5.3 GT1-3 Guarantor name (XPN) 00407
      • 6.5.5.4 GT1-4 Guarantor spouse name (XPN) 00408
      • 6.5.5.5 GT1-5 Guarantor address (XAD) 00409
      • 6.5.5.6 GT1-6 Guarantor ph num - home (XTN) 00410
      • 6.5.5.7 GT1-7 Guarantor ph num - business- (XTN) 00411
      • 6.5.5.8 GT1-8 Guarantor date/time of birth (TS) 00412
      • 6.5.5.9 GT1-9 Guarantor administrative sex (IS) 00413
      • 6.5.5.10 GT1-10 Guarantor type (IS) 00414
      • 6.5.5.11 GT1-11 Guarantor relationship (CE) 00415
      • 6.5.5.12 GT1-12 Guarantor SSN (ST) 00416
      • 6.5.5.13 GT1-13 Guarantor date - begin- (DT) 00417
      • 6.5.5.14 GT1-14 Guarantor date - end- (DT) 00418
      • 6.5.5.15 GT1-15 Guarantor priority (NM) 00419
      • 6.5.5.16 GT1-16 Guarantor employer name (XPN) 00420
      • 6.5.5.17 GT1-17 Guarantor employer address (XAD) 00421
      • 6.5.5.18 GT1-18 Guarantor employer phone number (XTN) 00422
      • 6.5.5.19 GT1-19 Guarantor employee ID number (CX) 00423
      • 6.5.5.20 GT1-20 Guarantor employment status (IS) 00424
      • 6.5.5.21 GT1-21 Guarantor organization name (XON) 00425
      • 6.5.5.22 GT1-22 Guarantor billing hold flag (ID) 00773
      • 6.5.5.23 GT1-23 Guarantor credit rating code (CE) 00774
      • 6.5.5.24 GT1-24 Guarantor death date and time (TS) 00775
      • 6.5.5.25 GT1-25 Guarantor death flag (ID) 00776
      • 6.5.5.26 GT1-26 Guarantor charge adjustment code (CE) 00777
      • 6.5.5.27 GT1-27 Guarantor household annual income (CP) 00778
      • 6.5.5.28 GT1-28 Guarantor household size (NM) 00779
      • 6.5.5.29 GT1-29 Guarantor employer ID number (CX) 00780
      • 6.5.5.30 GT1-30 Guarantor marital status code (CE) 00781
      • 6.5.5.31 GT1-31 Guarantor hire effective date (DT) 00782
      • 6.5.5.32 GT1-32 Employment stop date (DT) 00783
      • 6.5.5.33 GT1-33 Living dependency (IS) 00755
      • 6.5.5.34 GT1-34 Ambulatory status (IS) 00145
      • 6.5.5.35 GT1-35 Citizenship (CE) 00129
      • 6.5.5.36 GT1-36 Primary language (CE) 00118
      • 6.5.5.37 GT1-37 Living arrangement (IS) 00742
      • 6.5.5.38 GT1-38 Publicity code (CE) 00743
      • 6.5.5.39 GT1-39 Protection indicator (ID) 00744
      • 6.5.5.40 GT1-40 Student indicator (IS) 00745
      • 6.5.5.41 GT1-41 Religion (CE) 00120
      • 6.5.5.42 GT1-42 Mother's maiden name' (XPN) 00109
      • 6.5.5.43 GT1-43 Nationality (CE) 00739
      • 6.5.5.44 GT1-44 Ethnic group (CE) 00125
      • 6.5.5.45 GT1-45 Contact person's name' (XPN) 00748
      • 6.5.5.46 GT1-46 Contact person's telephone number' (XTN) 00749
      • 6.5.5.47 GT1-47 Contact reason (CE) 00747
      • 6.5.5.48 GT1-48 Contact relationship (IS) 00784
      • 6.5.5.49 GT1-49 Job title (ST) 00785
      • 6.5.5.50 GT1-50 Job code/class (JCC) 00786
      • 6.5.5.51 GT1-51 Guarantor employer's organization name' (XON) 01299
      • 6.5.5.52 GT1-52 Handicap (IS) 00753
      • 6.5.5.53 GT1-53 Job status (IS) 00752
      • 6.5.5.54 GT1-54 Guarantor financial class (FC) 01231
      • 6.5.5.55 GT1-55 Guarantor race (CE) 01291
    • 6.5.6 IN1 - insurance segment
      • 6.5.6.0 IN1 field definitions
      • 6.5.6.1 IN1-1 Set ID - IN1- (SI) 00426
      • 6.5.6.2 IN1-2 Insurance plan ID (CE) 00368
      • 6.5.6.3 IN1-3 Insurance company ID (CX) 00428
      • 6.5.6.4 IN1-4 Insurance company name (XON) 00429
      • 6.5.6.5 IN1-5 Insurance company address (XAD) 00430
      • 6.5.6.6 IN1-6 Insurance co contact person (XPN) 00431
      • 6.5.6.7 IN1-7 Insurance co phone number (XTN) 00432
      • 6.5.6.8 IN1-8 Group number (ST) 00433
      • 6.5.6.9 IN1-9 Group name (XON) 00434
      • 6.5.6.10 IN1-10 Insured's group emp. ID' (CX) 00435
      • 6.5.6.11 IN1-11 Insured's group emp name (XON) 00436
      • 6.5.6.12 IN1-12 Plan effective date (DT) 00437
      • 6.5.6.13 IN1-13 Plan expiration date (DT) 00438
      • 6.5.6.14 IN1-14 Authorization information (CM) 00439
      • 6.5.6.15 IN1-15 Plan type (IS) 00440
      • 6.5.6.16 IN1-16 Name of insured (XPN) 00441
      • 6.5.6.17 IN1-17 Insured's relationship to patient' (CE) 00442
      • 6.5.6.18 IN1-18 Insured's date of birth (TS) 00443
      • 6.5.6.19 IN1-19 Insured's address (XAD) 00444
      • 6.5.6.20 IN1-20 Assignment of benefits (IS) 00445
      • 6.5.6.21 IN1-21 Coordination of benefits (IS) 00446
      • 6.5.6.22 IN1-22 Coord of ben. priority (ST) 00447
      • 6.5.6.23 IN1-23 Notice of admission flag (ID) 00448
      • 6.5.6.24 IN1-24 Notice of admission date (DT) 00449
      • 6.5.6.25 IN1-25 Report of eligibility flag (ID) 00450
      • 6.5.6.26 IN1-26 Report of eligibility date (DT) 00451
      • 6.5.6.27 IN1-27 Release information code (IS) 00452
      • 6.5.6.28 IN1-28 Pre-admit cert (PAC)- (ST) 00453
      • 6.5.6.29 IN1-29 Verification date/time (TS) 00454
      • 6.5.6.30 IN1-30 Verification by (XCN) 00455
      • 6.5.6.31 IN1-31 Type of agreement code (IS) 00456
      • 6.5.6.32 IN1-32 Billing status (IS) 00457
      • 6.5.6.33 IN1-33 Lifetime reserve days (NM) 00458
      • 6.5.6.34 IN1-34 Delay before L.R. day (NM) 00459
      • 6.5.6.35 IN1-35 Company plan code (IS) 00460
      • 6.5.6.36 IN1-36 Policy number (ST) 00461
      • 6.5.6.37 IN1-37 Policy deductible (CP) 00462
      • 6.5.6.38 IN1-38 Policy limit - amount- (CP) 00463
      • 6.5.6.39 IN1-39 Policy limit - days- (NM) 00464
      • 6.5.6.40 IN1-40 Room rate - semi-private-- (CP) 00465
      • 6.5.6.41 IN1-41 Room rate - private- (CP) 00466
      • 6.5.6.42 IN1-42 Insured's employment status' (CE) 00467
      • 6.5.6.43 IN1-43 Insured's administrative sex' (IS) 00468
      • 6.5.6.44 IN1-44 Insured's employer's address' (XAD) 00469
      • 6.5.6.45 IN1-45 Verification status (ST) 00470
      • 6.5.6.46 IN1-46 Prior insurance plan ID (IS) 00471
      • 6.5.6.47 IN1-47 Coverage type (IS) 01227
      • 6.5.6.48 IN1-48 Handicap (IS) 00753
      • 6.5.6.49 IN1-49 Insured's ID number' (CX) 01230
    • 6.5.7 IN2 - insurance additional information segment
      • 6.5.7.0 IN2 field definitions
      • 6.5.7.1 IN2-1 Insured's employee ID (CX) 00472
      • 6.5.7.2 IN2-2 Insured's social security number' (ST) 00473
      • 6.5.7.3 IN2-3 Insured's employer's name and ID' (XCN) 00474
      • 6.5.7.4 IN2-4 Employer information data (IS) 00475
      • 6.5.7.5 IN2-5 Mail claim party (IS) 00476
      • 6.5.7.6 IN2-6 Medicare health ins card number (ST) 00477
      • 6.5.7.7 IN2-7 Medicaid case name (XPN) 00478
      • 6.5.7.8 IN2-8 Medicaid case number (ST) 00479
      • 6.5.7.9 IN2-9 Military sponsor name (XPN) 00480
      • 6.5.7.10 IN2-10 Military ID number (ST) 00481
      • 6.5.7.11 IN2-11 Dependent of military recipient (CE) 00482
      • 6.5.7.12 IN2-12 Military organization (ST) 00483
      • 6.5.7.13 IN2-13 Military station (ST) 00484
      • 6.5.7.14 IN2-14 Military service (IS) 00485
      • 6.5.7.15 IN2-15 Military rank/grade (IS) 00486
      • 6.5.7.16 IN2-16 Military status (IS) 00487
      • 6.5.7.17 IN2-17 Military retire date (DT) 00488
      • 6.5.7.18 IN2-18 Military non-avail cert on file (ID) 00489
      • 6.5.7.19 IN2-19 Baby coverage (ID) 00490
      • 6.5.7.20 IN2-20 Combine baby bill (ID) 00491
      • 6.5.7.21 IN2-21 Blood deductible (ST) 00492
      • 6.5.7.22 IN2-22 Special coverage approval name (XPN) 00493
      • 6.5.7.23 IN2-23 Special coverage approval title (ST) 00494
      • 6.5.7.24 IN2-24 Non-covered insurance code (IS) 00495
      • 6.5.7.25 IN2-25 Payor ID (CX) 00496
      • 6.5.7.26 IN2-26 Payor subscriber ID (CX) 00497
      • 6.5.7.27 IN2-27 Eligibility source (IS) 00498
      • 6.5.7.28 IN2-28 Room coverage type/amount (CM) 00499
      • 6.5.7.29 IN2-29 Policy type/amount (CM) 00500
      • 6.5.7.30 IN2-30 Daily deductible (CM) 00501
      • 6.5.7.31 IN2-31 Living dependency (IS) 00755
      • 6.5.7.32 IN2-32 Ambulatory status (IS) 00145
      • 6.5.7.33 IN2-33 Citizenship (CE) 00129
      • 6.5.7.34 IN2-34 Primary language (CE) 00118
      • 6.5.7.35 IN2-35 Living arrangement (IS) 00742
      • 6.5.7.36 IN2-36 Publicity code (CE) 00743
      • 6.5.7.37 IN2-37 Protection indicator (ID) 00744
      • 6.5.7.38 IN2-38 Student indicator (IS) 00745
      • 6.5.7.39 IN2-39 Religion (CE) 00120
      • 6.5.7.40 IN2-40 Mother's maiden name' (XPN) 00109
      • 6.5.7.41 IN2-41 Nationality (CE) 00739
      • 6.5.7.42 IN2-42 Ethnic group (CE) 00125
      • 6.5.7.43 IN2-43 Marital status (CE) 00119
      • 6.5.7.44 IN2-44 Insured's employment start date' (DT) 00787
      • 6.5.7.45 IN2-45 Employment stop date (DT) 00783
      • 6.5.7.46 IN2-46 Job title (ST) 00785
      • 6.5.7.47 IN2-47 Job code/class (JCC) 00786
      • 6.5.7.48 IN2-48 Job status (IS) 00752
      • 6.5.7.49 IN2-49 Employer contact person name (XPN) 00789
      • 6.5.7.50 IN2-50 Employer contact person phone number (XTN) 00790
      • 6.5.7.51 IN2-51 Employer contact reason (IS) 00791
      • 6.5.7.52 IN2-52 Insured's contact person's name'' (XPN) 00792
      • 6.5.7.53 IN2-53 Insured's contact person phone number' (XTN) 00793
      • 6.5.7.54 IN2-54 Insured's contact person reason' (IS) 00794
      • 6.5.7.55 IN2-55 Relationship to the patient start date (DT) 00795
      • 6.5.7.56 IN2-56 Relationship to the patient stop date (DT) 00796
      • 6.5.7.57 IN2-57 Insurance co contact reason (IS) 00797
      • 6.5.7.58 IN2-58 Insurance co contact phone number (XTN) 00798
      • 6.5.7.59 IN2-59 Policy scope (IS) 00799
      • 6.5.7.60 IN2-60 Policy source (IS) 00800
      • 6.5.7.61 IN2-61 Patient member number (CX) 00801
      • 6.5.7.62 IN2-62 Guarantor's relationship to insured' (CE) 00802
      • 6.5.7.63 IN2-63 Insured's phone number - Home' (XTN) 00803
      • 6.5.7.64 IN2-64 Insured's employer phone number' (XTN) 00804
      • 6.5.7.65 IN2-65 Military handicapped program (CE) 00805
      • 6.5.7.66 IN2-66 Suspend flag (ID) 00806
      • 6.5.7.67 IN2-67 Copay limit flag (ID) 00807
      • 6.5.7.68 IN2-68 Stoploss limit flag (ID) 00808
      • 6.5.7.69 IN2-69 Insured organization name and ID (XON) 00809
      • 6.5.7.70 IN2-70 Insured employer organization name and ID (XON) 00810
      • 6.5.7.71 IN2-71 Race (CE) 00113
      • 6.5.7.72 IN2-72 HCFA patient's relationship to insured' (CE) 00811
    • 6.5.8 IN3 - insurance additional information, certification segment
      • 6.5.8.0 IN3 field definitions
      • 6.5.8.1 IN3-1 Set ID - IN3 (SI) 00502
      • 6.5.8.2 IN3-2 Certification number (CX) 00503
      • 6.5.8.3 IN3-3 Certified by (XCN) 00504
      • 6.5.8.4 IN3-4 Certification required (ID) 00505
      • 6.5.8.5 IN3-5 Penalty (CM) 00506
      • 6.5.8.6 IN3-6 Certification date/time (TS) 00507
      • 6.5.8.7 IN3-7 Certification modify date/time (TS) 00508
      • 6.5.8.8 IN3-8 Operator (XCN) 00509
      • 6.5.8.9 IN3-9 Certification begin date (DT) 00510
      • 6.5.8.10 IN3-10 Certification end date (DT) 00511
      • 6.5.8.11 IN3-11 Days (CM) 00512
      • 6.5.8.12 IN3-12 Non-concur code/description (CE) 00513
      • 6.5.8.13 IN3-13 Non-concur effective date/time (TS) 00514
      • 6.5.8.14 IN3-14 Physician reviewer (XCN) 00515
      • 6.5.8.15 IN3-15 Certification contact (ST) 00516
      • 6.5.8.16 IN3-16 Certification contact phone number (XTN) 00517
      • 6.5.8.17 IN3-17 Appeal reason (CE) 00518
      • 6.5.8.18 IN3-18 Certification agency (CE) 00519
      • 6.5.8.19 IN3-19 Certification agency phone number (XTN) 00520
      • 6.5.8.20 IN3-20 Pre-certification req/window (CM) 00521
      • 6.5.8.21 IN3-21 Case manager (ST) 00522
      • 6.5.8.22 IN3-22 Second opinion date (DT) 00523
      • 6.5.8.23 IN3-23 Second opinion status (IS) 00524
      • 6.5.8.24 IN3-24 Second opinion documentation received (IS) 00525
      • 6.5.8.25 IN3-25 Second opinion physician (XCN) 00526
    • 6.5.9 ACC - accident segment
      • 6.5.9.0 ACC field definitions
      • 6.5.9.1 ACC-1 Accident date/time (TS) 00527
      • 6.5.9.2 ACC-2 Accident code (CE) 00528
      • 6.5.9.3 ACC-3 Accident location (ST) 00529
      • 6.5.9.4 ACC-4 Auto accident state (CE) 00812
      • 6.5.9.5 ACC-5 Accident job related indicator (ID) 00813
      • 6.5.9.6 ACC-6 Accident death indicator (ID) 00814
      • 6.5.9.7 ACC-7 Entered by (XCN) 00224
      • 6.5.9.8 ACC-8 Accident description (ST) 01503
      • 6.5.9.9 ACC-9 Brought in by (ST) 01504
      • 6.5.9.10 ACC-10 Police notified indicator (ID) 01505
    • 6.5.10 UB1 - UB82 data segment
      • 6.5.10.0 UB1 field definitions
      • 6.5.10.1 UB1-1 Set ID - UB1- (SI) 00530
      • 6.5.10.2 UB1-2 Blood deductible (43) (NM) 00531
      • 6.5.10.3 UB1-3 Blood furnished-pints of (40) (NM) 00532
      • 6.5.10.4 UB1-4 Blood replaced-pints (41)- (NM) 00533
      • 6.5.10.5 UB1-5 Blood not replaced- pints (42)- (NM) 00534
      • 6.5.10.6 UB1-6 Co-insurance days (25)- (NM) 00535
      • 6.5.10.7 UB1-7 Condition code (35-39) (IS) 00536
      • 6.5.10.8 UB1-8 Covered days - (23)- (NM) 00537
      • 6.5.10.9 UB1-9 Non-covered days - (24)- (NM) 00538
      • 6.5.10.10 UB1-10 Value amount & code (46-49) (CM) 00539
      • 6.5.10.11 UB1-11 Number of grace days (90) (NM) 00540
      • 6.5.10.12 UB1-12 Special program indicator (44) (CE) 00541
      • 6.5.10.13 UB1-13 PSRO/UR approval indicator (87) (CE) 00542
      • 6.5.10.14 UB1-14 PSRO/UR approved stay-fm (88)- (DT) 00543
      • 6.5.10.15 UB1-15 PSRO/UR approved stay-to (89)- (DT) 00544
      • 6.5.10.16 UB1-16 Occurrence (28-32)- (CM) 00545
      • 6.5.10.17 UB1-17 Occurrence span (33) (CE) 00546
      • 6.5.10.18 UB1-18 Occur span start date (33) (DT) 00547
      • 6.5.10.19 UB1-19 Occur span end date (33) (DT) 00548
      • 6.5.10.20 UB1-20 UB-82 locator 2 (ST)- 00549
      • 6.5.10.21 UB1-21 UB-82 locator 9- (ST) 00550
      • 6.5.10.22 UB1-22 UB-82 locator 27- (ST) 00551
      • 6.5.10.23 UB1-23 UB-82 locator 45- (ST) 00552
    • 6.5.11 UB2 - UB92 data segment
      • 6.5.11.0 UB2 field definitions
      • 6.5.11.1 UB2-1 Set ID - UB2- (SI) 00553
      • 6.5.11.2 UB2-2 Co-insurance days (9) (ST) 00554
      • 6.5.11.3 UB2-3 Condition code (24-30) (IS) 00555
      • 6.5.11.4 UB2-4 Covered days (7) (ST) 00556
      • 6.5.11.5 UB2-5 Non-covered days (8) (ST) 00557
      • 6.5.11.6 UB2-6 Value amount & code (39-41) (CM) 00558
      • 6.5.11.7 UB2-7 Occurrence code & date (32-35) (CM) 00559
      • 6.5.11.8 UB2-8 Occurrence span code/dates (36) (CM) 00560
      • 6.5.11.9 UB2-9 UB92 locator 2 (state) (ST) 00561
      • 6.5.11.10 UB2-10 UB92 locator 11 (state) (ST) 00562
      • 6.5.11.11 UB2-11 UB92 locator 31 (national) (ST) 00563
      • 6.5.11.12 UB2-12 Document control number (ST) 00564
      • 6.5.11.13 UB2-13 UB92 locator 49 (national) (ST) 00565
      • 6.5.11.14 UB2-14 UB92 locator 56 (state) (ST) 00566
      • 6.5.11.15 UB2-15 UB92 locator 57 (national) (ST) 00567
      • 6.5.11.16 UB2-16 UB92 locator 78 (state) (ST) 00568
      • 6.5.11.17 UB2-17 Special visit count (NM) 00815
    • 6.5.12 ABS - abstract segment
      • 6.5.12.0 ABS field definitions
      • 6.5.12.1 ABS-1 Discharge care provider (XCN) 01514
      • 6.5.12.2 ABS-2 Transfer medical service code (CE) 01515
      • 6.5.12.3 ABS-3 Severity of illness code (CE) 01516
      • 6.5.12.4 ABS-4 Date/time of attestation (TS) 01517
      • 6.5.12.5 ABS-5 Attested by (XCN) 01518
      • 6.5.12.6 ABS-6 Triage code (CE) 01519
      • 6.5.12.7 ABS-7 Abstract completion date/time (TS) 01520
      • 6.5.12.8 ABS-8 Abstracted by (XCN) 01521
      • 6.5.12.9 ABS-9 Case category code (CE) 01522
      • 6.5.12.10 ABS-10 Caesarian section indicator (ID) 01523
      • 6.5.12.11 ABS-11 Gestation category code (CE) 01524
      • 6.5.12.12 ABS-12 Gestation period - weeks (NM) 01525
      • 6.5.12.13 ABS-13 Newborn code (CE) 01526
      • 6.5.12.14 ABS-14 Stillborn indicator (ID) 01527
    • 6.5.13 BLC - blood code segment
      • 6.5.13.0 BLC field definitions
      • 6.5.13.1 BLC-1 Blood product code (CE) 01528
      • 6.5.13.2 BLC-2 Blood amount (CQ) 01529
    • 6.5.14 RMI - risk management incident segment
      • 6.5.14.0 RMI field definitions
      • 6.5.14.1 RMI-1 Risk management incident code (CE) 01530
      • 6.5.14.2 RMI-2 Date/time incident (TS) 01531
      • 6.5.14.3 RMI-3 Incident type code (CE) 01533
    • 6.5.15 GP1 - grouping/reimbursement - visit segment
      • 6.5.15.0 GP1 field definitions
      • 6.5.15.1 GP1-1 Type of bill code (IS) 01599
      • 6.5.15.2 GP1-2 Revenue code (IS) 01600
      • 6.5.15.3 GP1-3 Overall claim disposition code (IS) 01601
      • 6.5.15.4 GP1-4 OCE edits per visit code (IS) 01602
      • 6.5.15.5 GP1-5 Outlier cost (CP) 00387
    • 6.5.16 GP2 - grouping/reimbursement - procedure line item segment
      • 6.5.16.0 GP2 field definitions
      • 6.5.16.1 GP2-1 Revenue code (IS) 01600
      • 6.5.16.2 GP2-2 Number of service units (NM) 01604
      • 6.5.16.3 GP2-3 Charge (CP) 01605
      • 6.5.16.4 GP2-4 Reimbursement action code (IS) 01606
      • 6.5.16.5 GP2-5 Denial or rejection code (IS) 01607
      • 6.5.16.6 GP2-6 OCE edit code (IS) 01608
      • 6.5.16.7 GP2-7 Ambulatory payment classification code (CE) 01609
      • 6.5.16.8 GP2-8 Modifier edit code (IS) 01610
      • 6.5.16.9 GP2-9 Payment adjustment code (IS) 01611
      • 6.5.16.10 GP2-10 Packaging status code (IS) 01617
      • 6.5.16.11 GP2-11 Expected HCFA payment amount (CP) 01618
      • 6.5.16.12 GP2-12 Reimbursement type code (IS) 01619
      • 6.5.16.13 GP2-13 Co-pay amount (CP) 01620
      • 6.5.16.14 GP2-14 Pay rate per service unit (NM) 01621
  • 6.6 EXAMPLE TRANSACTIONS
    • 6.6.1 Create a patient billing/accounts receivable record
    • 6.6.2 Post a charge to a patient's account
    • 6.6.3 Update patient accounts - update UB82 information
    • 6.6.4 Update patient accounts - update diagnosis and DRG information
  • 6.7 IMPLEMENTATION CONSIDERATIONS
  • 6.8 OUTSTANDING ISSUES

HL7 V2.4 Chapter 7

• 7 .Observation Reporting
  • 7.1 CHAPTER 7 CONTENTS
  • 7.2 PURPOSE
    • 7.2.1 Preface (organization of this chapter)
    • 7.2.2 Glossary
      • 7.2.2.1 Placer:
      • 7.2.2.2 Filler:
      • 7.2.2.3 Battery:
      • 7.2.2.4 Observation:
      • 7.2.2.5 Segment (record):
      • 7.2.2.6 Field:
      • 7.2.2.7 Repeated value:
      • 7.2.2.8 Field components:
    • 7.2.3 Narrative reports as batteries with many OBX
    • 7.2.4 Suffixes for defining observation IDs for common components of narrative reports
      • 7.2.4.1 Diagnostic impression (IMP)
      • 7.2.4.2 Recommendation (REC)
      • 7.2.4.3 Confirming procedures (CNP)
      • 7.2.4.4 Procedure medication (MED)
      • 7.2.4.5 Anatomic site (ANT)
      • 7.2.4.6 Device/Instrument (DEV)
      • 7.2.4.7 Serial # device/instrument (SER)
      • 7.2.4.8 Gross or general description (GDT)
      • 7.2.4.9 Microscopic or Secondary description (MDT)
      • 7.2.4.10 Technician's comment (TCM)
      • 7.2.4.11 Addendum note (ADT)
      • 7.2.4.12 Diagnosis (problem) onset date/time (ITM)
      • 7.2.4.13 Diagnosis (problem) resolution date/time (RTM)
      • 7.2.4.14 Comparison study (CMS)
      • 7.2.4.15 Comparison date/time (CMT)
      • 7.2.4.16 Comparison results (CMR)
      • 7.2.4.17 Comparison change (CMC)
      • 7.2.4.18 Predicted value (PRD)
      • 7.2.4.19 Percent predicted (PPR)
      • 7.2.4.20 After drug observed (AFD)
      • 7.2.4.21 Predicted value after drug (ADP)
      • 7.2.4.22 Percent predicted after drug (APP)
      • 7.2.4.23 Timing information (TIM)
      • 7.2.4.24 Channel definition data (CHN)
      • 7.2.4.25 Waveform digital data (WAS)
      • 7.2.4.26 Waveform annotation (ANO)
      • 7.2.4.27 Clinical observation codes
    • 7.2.5 Coding schemes
  • 7.3 TRIGGER EVENTS & MESSAGE DEFINITIONS
    • 7.3.1 ORU - unsolicited observation message (event R01)
    • 7.3.2 OUL - unsolicited laboratory observation message (R21)
    • 7.3.3 QRY/ORF - query for results of observation (events R02, R04)
  • 7.4 SEGMENTS
    • 7.4.1 OBR - observation request segment
      • 7.4.1.0 OBR field definitions
      • 7.4.1.1 OBR-1 Set ID - OBR (SI) 00237
      • 7.4.1.2 OBR-2 Placer order number (EI) 00216
      • 7.4.1.3 OBR-3 Filler order number (EI) 00217
      • 7.4.1.4 OBR-4 Universal service identifier (CE) 00238
      • 7.4.1.5 OBR-5 Priority - OBR (ID) 00239
      • 7.4.1.6 OBR-6 Requested date/time (TS) 00240
      • 7.4.1.7 OBR-7 Observation date/time (TS) 00241
      • 7.4.1.8 OBR-8 Observation end date/time (TS) 00242
      • 7.4.1.9 OBR-9 Collection volume (CQ) 00243
      • 7.4.1.10 OBR-10 Collector identifier (XCN) 00244
      • 7.4.1.11 OBR-11 Specimen action code (ID) 00245
      • 7.4.1.12 OBR-12 Danger code (CE) 00246
      • 7.4.1.13 OBR-13 Relevant clinical information (ST) 00247
      • 7.4.1.14 OBR-14 Specimen received date/time (TS) 00248
      • 7.4.1.15 OBR-15 Specimen source (CM) 00249
      • 7.4.1.16 OBR-16 Ordering provider (XCN) 00226
      • 7.4.1.17 OBR-17 Order callback phone number (XTN) 00250
      • 7.4.1.18 OBR-18 Placer field 1 (ST) 00251
      • 7.4.1.19 OBR-19 Placer field 2 (ST) 00252
      • 7.4.1.20 OBR-20 Filler field 1 (ST) 00253
      • 7.4.1.21 OBR-21 Filler field 2 (ST) 00254
      • 7.4.1.22 OBR-22 Results rpt/status chng - date/time (TS) 00255
      • 7.4.1.23 OBR-23 Charge to practice (CM) 00256
      • 7.4.1.24 OBR-24 Diagnostic serv sect ID (ID) 00257
      • 7.4.1.25 OBR-25 Result status (ID) 00258
      • 7.4.1.26 OBR-26 Parent result (CM) 00259
      • 7.4.1.27 OBR-27 Quantity/timing (TQ) 00221
      • 7.4.1.28 OBR-28 Result copies to (XCN) 00260
      • 7.4.1.29 OBR-29 Parent (CM) 00261
      • 7.4.1.30 OBR-30 Transportation mode (ID) 00262
      • 7.4.1.31 OBR-31 Reason for study (CE) 00263
      • 7.4.1.32 OBR-32 Principal result interpreter (CM) 00264
      • 7.4.1.33 OBR-33 Assistant result interpreter (CM) 00265
      • 7.4.1.34 OBR-34 Technician (CM) 00266
      • 7.4.1.35 OBR-35 Transcriptionist (CM) 00267
      • 7.4.1.36 OBR-36 Scheduled - date/time (TS) 00268
      • 7.4.1.37 OBR-37 Number of sample containers (NM) 01028
      • 7.4.1.38 OBR-38 Transport logistics of collected sample (CE) 01029
      • 7.4.1.39 OBR-39 Collector's comment (CE) 01030
      • 7.4.1.40 OBR-40 Transport arrangement responsibility (CE) 01031
      • 7.4.1.41 OBR-41 Transport arranged (ID) 01032
      • 7.4.1.42 OBR-42 Escort required (ID) 01033
      • 7.4.1.43 OBR-43 Planned patient transport comment (CE) 01034
      • 7.4.1.44 OBR-44 Procedure code (CE) 00393
      • 7.4.1.45 OBR-45 Procedure code modifier (CE) 01316
      • 7.4.1.46 OBR-46 Placer supplemental service information (CE) 01474
      • 7.4.1.47 OBR-47 Filler supplemental service information (CE) 01475
    • 7.4.2 OBX - observation/result segment
      • 7.4.2.0 OBX field definitions
      • 7.4.2.1 OBX-1 Set ID - OBX- (SI) 00569
      • 7.4.2.2 OBX-2 Value type (ID) 00570
      • 7.4.2.3 OBX-3 Observation identifier (CE) 00571
      • 7.4.2.4 OBX-4 Observation sub-ID- (ST) 00572
      • 7.4.2.5 OBX-5 Observation value (*) 00573
      • 7.4.2.6 OBX-6 Units (CE) 00574
        • 7.4.2.6.1 Identifying reporting units
        • 7.4.2.6.2 ISO and ANSI customary units abbreviations
        • 7.4.2.6.3 Local unit codes
      • 7.4.2.7 OBX-7 References range (ST) 00575
      • 7.4.2.8 OBX-8 Abnormal flags (IS) 00576
      • 7.4.2.9 OBX-9 Probability (NM) 00577
      • 7.4.2.10 OBX-10 Nature of abnormal test (ID) 00578
      • 7.4.2.11 OBX-11 Observation result status (ID) 00579
      • 7.4.2.12 OBX-12 Date last observation normal value (TS) 00580
      • 7.4.2.13 OBX-13 User defined access checks (ST) 00581
      • 7.4.2.14 OBX-14 Date/time of the observation (TS) 00582
      • 7.4.2.15 OBX-15 Producer's ID (CE) 00583
      • 7.4.2.16 OBX-16 Responsible observer (XCN) 00584
      • 7.4.2.17 OBX-17 Observation method (CE) 00936
      • 7.4.2.18 OBX-18 Equipment instance identifier (EI) 01479
      • 7.4.2.19 OBX-19 Date/time of the analysis (TS) 01480
  • 7.5 EXAMPLES OF USE
    • 7.5.1 Query/response
    • 7.5.2 Unsolicited
    • 7.5.3 Laboratory
    • 7.5.4 Narrative report messages
    • 7.5.5 Reporting cultures and susceptibilities
      • 7.5.5.1 Culture battery/report representation
      • 7.5.5.2 Susceptibility battery/report representation
      • 7.5.5.3 Identification of the organism for a susceptibility battery
    • 7.5.6 EKG results reporting
    • 7.5.7 Patient-specific clinical data with an order
  • 7.6 CLINICAL TRIALS
    • 7.6.1 Glossary
      • 7.6.1.1 Clinical trial:
      • 7.6.1.2 Phase of a clinical trial:
        • 7.6.1.2.1 Example 1
        • 7.6.1.2.2 Example 2
        • 7.6.1.2.3 Example 3
      • 7.6.1.3 Data schedule:
        • 7.6.1.3.1 Schedule for a randomized cancer prevention trial
        • 7.6.1.3.2 Schedule for a cancer chemotherapy trial
        • 7.6.1.3.3 Schedule for a randomized pain medication trial
  • 7.7 CLINICAL TRIALS - TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 7.7.1 CRM - clinical study registration message (events C01-C08)
    • 7.7.2 CSU - unsolicited study data message (events C09-C12)
  • 7.8 CLINICAL TRIALS - SEGMENT DEFINITIONS
    • 7.8.1 CSR - clinical study registration segment
      • 7.8.1.0 CSR field definitions
      • 7.8.1.1 CSR-1 Sponsor study ID (EI) 01011
      • 7.8.1.2 CSR-2 Alternate study ID (EI) 01036
      • 7.8.1.3 CSR-3 Institution registering the patient (CE) 01037
      • 7.8.1.4 CSR-4 Sponsor patient ID (CX) 01038
      • 7.8.1.5 CSR-5 Alternate patient ID - CSR (CX) 01039
      • 7.8.1.6 CSR-6 Date/time patient of patient study registration (TS) 01040
      • 7.8.1.7 CSR-7 Person performing study registration (XCN) 01041
      • 7.8.1.8 CSR-8 Study authorizing provider (XCN) 01042
      • 7.8.1.9 CSR-9 Date/time patient study consent signed (TS) 01043
      • 7.8.1.10 CSR-10 Patient study eligibility status (CE) 01044
      • 7.8.1.11 CSR-11 Study randomization date/time (TS) 01045
      • 7.8.1.12 CSR-12 Randomized study arm (CE) 01046
      • 7.8.1.13 CSR-13 Stratum for study randomization (CE) 01047
      • 7.8.1.14 CSR-14 Patient evaluability status (CE) 01048
      • 7.8.1.15 CSR-15 Date/time ended study (TS) 01049
      • 7.8.1.16 CSR-16 Reason ended study (CE) 01050
    • 7.8.2 CSP - clinical study phase segment
      • 7.8.2.0 CSP field definitions
      • 7.8.2.1 CSP-1 Study phase Identifier (CE) 01022
      • 7.8.2.2 CSP-2 Date/time study phase began (TS) 01052
      • 7.8.2.3 CSP-3 Date/time study phase ended (TS) 01053
      • 7.8.2.4 CSP-4 Study phase evaluability (CE) 01054
    • 7.8.3 CSS - clinical study data schedule segment
      • 7.8.3.0 CSS field definitions
      • 7.8.3.1 CSS-1 Study scheduled time point (CE) 01055
      • 7.8.3.2 CSS-2 Study scheduled patient time point (TS) 01056
      • 7.8.3.3 CSS-3 Study quality control codes (CE) 01057
    • 7.8.4 CTI - clinical trial identification segment
      • 7.8.4.0 CTI field definitions
      • 7.8.4.1 CTI-1 Sponsor study ID (EI) 01011
      • 7.8.4.2 CTI-2 Study phase identifier (CE) 01022
      • 7.8.4.3 CTI-3 Study scheduled time point (CE) 01055
    • 7.8.5 CM0 clinical study master segment
    • 7.8.6 CM1 clinical study phase master segment
    • 7.8.7 CM2 clinical study schedule master segment
  • 7.9 CLINICAL TRIALS - EXAMPLES OF USE
    • 7.9.1 CRM - message when patient registered on a clinical trial
    • 7.9.2 CRM - message when patient begins a phase of a clinical trial
    • 7.9.3 CSU - message reporting monthly patient data updates to the sponsor
  • 7.10 PRODUCT EXPERIENCE
    • 7.10.1 Glossary
      • 7.10.1.1 Drug:
      • 7.10.1.2 Medical device:
      • 7.10.1.3 Product:
      • 7.10.1.4 Non-proprietary (generic) name:
      • 7.10.1.5 Trade (brand) name:
      • 7.10.1.6 Adverse event/adverse experience:
      • 7.10.1.7 Adverse drug reaction:
      • 7.10.1.8 Causation:
      • 7.10.1.9 Causal relationship:
      • 7.10.1.10 Regulatory agency:
      • 7.10.1.11 Product manufacturer:
      • 7.10.1.12 Holder of marketing authorization:
      • 7.10.1.13 Serious adverse product reaction:
      • 7.10.1.14 Expected adverse product reaction:
    • 7.10.2 References
  • 7.11 PRODUCT EXPERIENCE - TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 7.11.1 PEX - product experience message (events P07, P08
    • 7.11.2 SUR - summary product experience report (event P09)
  • 7.12 PRODUCT EXPERIENCE - SEGMENT DEFINITIONS
    • 7.12.1 PES - product experience sender segment
      • 7.12.1.0 PES - field definitions
      • 7.12.1.1 PES-1 Sender organization name (XON) 01059
      • 7.12.1.2 PES-2 Sender individual name (XCN) 01060
      • 7.12.1.3 PES-3 Sender address (XAD) 01062
      • 7.12.1.4 PES-4 Sender telephone (XTN) 01063
      • 7.12.1.5 PES-5 Sender event identifier (EI) 01064
      • 7.12.1.6 PES-6 Sender sequence number (NM) 01065
      • 7.12.1.7 PES-7 Sender event description (FT) 01066
      • 7.12.1.8 PES-8 Sender comment (FT) 01067
      • 7.12.1.9 PES-9 Sender aware date/time (TS) 01068
      • 7.12.1.10 PES-10 Event report date (TS) 01069
      • 7.12.1.11 PES-11 Event report timing /type (ID) 01070
      • 7.12.1.12 PES-12 Event report source (ID) 01071
      • 7.12.1.13 PES-13 Event reported to (ID) 01072
    • 7.12.2 PEO - product experience observation segment
      • 7.12.2.0 PEO field definitions
      • 7.12.2.1 PEO-1 Event identifiers used (CE) 01073
      • 7.12.2.2 PEO-2 Event symptom/diagnosis code (CE) 01074
      • 7.12.2.3 PEO-3 Event onset date/time (TS) 01075
      • 7.12.2.4 PEO-4 Event exacerbation date/time (TS) 01076
      • 7.12.2.5 PEO-5 Event improved date/time (TS) 01077
      • 7.12.2.6 PEO-6 Event ended data/time (TS) 01078
      • 7.12.2.7 PEO-7 Event location occurred address (XAD) 01079
      • 7.12.2.8 PEO-8 Event qualification (ID) 01080
      • 7.12.2.9 PEO-9 Event serious (ID) 01081
      • 7.12.2.10 PEO-10 Event expected (ID) 01082
      • 7.12.2.11 PEO-11 Event outcome (ID) 01083
      • 7.12.2.12 PEO-12 Patient outcome (ID) 01084
      • 7.12.2.13 PEO-13 Event description from others (FT) 01085
      • 7.12.2.14 PEO-14 Event description from original reporter (FT) 01086
      • 7.12.2.15 PEO-15 Event description from patient (FT) 01087
      • 7.12.2.16 PEO-16 Event description from practitioner (FT) 01088
      • 7.12.2.17 PEO-17 Event description from autopsy (FT) 01089
      • 7.12.2.18 PEO-18 Cause of death (CE) 01090
      • 7.12.2.19 PEO-19 Primary observer name (XPN) 01091
      • 7.12.2.20 PEO-20 Primary observer address (XAD) 01092
      • 7.12.2.21 PEO-21 Primary observer telephone (XTN) 01093
      • 7.12.2.22 PEO-22 Primary observer's qualification' (ID) 01094
      • 7.12.2.23 PEO-23 Confirmation provided by (ID) 01095
      • 7.12.2.24 PEO-24 Primary observer aware date/time (TS) 01096
      • 7.12.2.25 PEO-25 Primary observer's identity may be divulged (ID) 01097
    • 7.12.3 PCR - possible causal relationship segment
      • 7.12.3.0 PCR field definitions
      • 7.12.3.1 PCR-1 Implicated product (CE) 01098
      • 7.12.3.2 PRC-2 Generic product (IS) 01099
      • 7.12.3.3 PCR-3 Product class (CE) 01100
      • 7.12.3.4 PCR-4 Total duration of therapy (CQ) 01101
      • 7.12.3.5 PCR-5 Product manufacture date (TS) 01102
      • 7.12.3.6 PCR-6 Product expiration date (TS) 01103
      • 7.12.3.7 PCR-7 Product implantation date (TS) 01104
      • 7.12.3.8 PCR-8 Product explantation date (TS) 01105
      • 7.12.3.9 PCR-9 Single use device (IS) 01106
      • 7.12.3.10 PCR-10 Indication for product use (CE) 01107
      • 7.12.3.11 PCR-11 Product problem (IS) 01108
      • 7.12.3.12 PCR-12 Product serial/lot number (ST) 01109
      • 7.12.3.13 PCR-16 Product available for inspection (IS) 01110
      • 7.12.3.14 PCR-14 Product evaluation performed (CE) 01111
      • 7.12.3.15 PCR-15 Product evaluation status (CE) 01112
      • 7.12.3.16 PCR-16 Product evaluation results (CE) 01113
      • 7.12.3.17 PCR-17 Evaluated product source (ID) 01114
      • 7.12.3.18 PCR-18 Date product returned to manufacturer (TS) 01115
      • 7.12.3.19 PCR-19 Device operator qualifications (ID) 01116
      • 7.12.3.20 PCR-20 Relatedness assessment (ID) 01117
      • 7.12.3.21 PCR-21 Action taken in response to the event (ID) 01118
      • 7.12.3.22 PCR-22 Event causality observations (ID) 01119
      • 7.12.3.23 PCR-23 Indirect exposure mechanism (ID) 01120
    • 7.12.4 PSH - product summary header segment
      • 7.12.4.0 PSH field definitions
      • 7.12.4.1 PSH-1 Report type (ST) 01233
      • 7.12.4.2 PSH-2 Report form identifier (ST) 01297
      • 7.12.4.3 PSH-3 Report date (TS) 01235
      • 7.12.4.4 PSH-4 Report interval start date (TS) 01236
      • 7.12.4.5 PSH-5 Report interval end date (TS) 01237
      • 7.12.4.6 PSH-6 Quantity manufactured (CQ) 01238
      • 7.12.4.7 PSH-7 Quantity distributed (CQ) 01239
      • 7.12.4.8 PSH-8 Quantity distributed method (ID) 01240
      • 7.12.4.9 PSH-9 Quantity distributed comment (FT) 01241
      • 7.12.4.10 PSH-10 Quantity in use (CQ) 01242
      • 7.12.4.11 PSH-11 Quantity in use method (ID) 01243
      • 7.12.4.12 PSH-12 Quantity in use comment (FT) 01244
      • 7.12.4.13 PSH-13 Number of product experience reports filed by facility (NM) 01245
      • 7.12.4.14 PSH-14 Number of product experience reports filed by distributor (NM) 01246
    • 7.12.5 PDC - product detail country segment
      • 7.12.5.0 PDC field definitions
      • 7.12.5.1 PDC-1 Manufacturer/distributor (XON) 01247
      • 7.12.5.2 PDC-2 Country (CE) 01248
      • 7.12.5.3 PDC-3 Brand name (ST) 01249
      • 7.12.5.4 PDC-4 Device family name (ST) 01250
      • 7.12.5.5 PDC-5 Generic name (CE) 01251
      • 7.12.5.6 PDC-6 Model identifier (ST) 01252
      • 7.12.5.7 PDC-7 Catalogue identifier (ST) 01253
      • 7.12.5.8 PDC-8 Other identifier (ST) 01254
      • 7.12.5.9 PDC-9 Product code (CE) 01255
      • 7.12.5.10 PDC-10 Marketing basis (ID) 01256
      • 7.12.5.11 PDC-11 Marketing approval ID (ST) 01257
      • 7.12.5.12 PDC-12 Labeled shelf life (CQ) 01258
      • 7.12.5.13 PDC-13 Expected shelf life (CQ) 01259
      • 7.12.5.14 PDC-14 Date first marketed (TS) 01260
      • 7.12.5.15 PDC-15 Date last marketed (TS) 01261
    • 7.12.6 FAC - facility segment
      • 7.12.6.0 FAC field definitions
      • 7.12.6.1 FAC-1 Facility ID-FAC (EI) 01262
      • 7.12.6.2 FAC-2 Facility type (ID) 01263
      • 7.12.6.3 FAC-3 Facility address (XAD) 01264
      • 7.12.6.4 FAC-4 Facility telecommunication (XTN) 01265
      • 7.12.6.5 FAC-5 Contact person (XCN) 01266
      • 7.12.6.6 FAC-6 Contact title (ST) 01267
      • 7.12.6.7 FAC-7 Contact address (XAD) 01166
      • 7.12.6.8 FAC-8 Contact telecommunication (XTN) 01269
      • 7.12.6.9 FAC-9 Signature authority (XCN) 01270
      • 7.12.6.10 FAC-10 Signature authority title (ST) 01271
      • 7.12.6.11 FAC-11 Signature authority address (XAD) 01272
      • 7.12.6.12 FAC-12 Signature authority telecommunication (XTN) 01273
  • 7.13 PRODUCT EXPERIENCE - EXAMPLES OF USE
  • 7.14 WAVEFORM
    • 7.14.1 Waveform result data types
      • 7.14.1.1 NA - numeric array
      • 7.14.1.2 MA - multiplexed array
      • 7.14.1.3 CD - Channel definition
        • 7.14.1.3.1 Channel identifier (CM)
        • 7.14.1.3.2 Channel number (NM)
        • 7.14.1.3.3 Channel name (ST)
      • 7.14.1.4 Waveform source (CM)
        • 7.14.1.4.1 Source name 1 (ST)
        • 7.14.1.4.2 Source name 2 (ST)
      • 7.14.1.5 Channel sensitivity and units (CM)
        • 7.14.1.5.1 Channel sensitivity (NM)
        • 7.14.1.5.2 Unit of measure identifier (ST)
        • 7.14.1.5.3 Unit of measure description (ST)
        • 7.14.1.5.4 Unit of measure coding system (IS)
        • 7.14.1.5.5 Alternate unit of measure identifier (ST)
        • 7.14.1.5.6 Alternate unit of measure description (ST)
        • 7.14.1.5.7 Alternate unit of measure coding system (IS)
      • 7.14.1.6 Channel calibration parameters (CM)
        • 7.14.1.6.1 Channel calibration sensitivity correction factor (NM)
        • 7.14.1.6.2 Channel calibration baseline (NM)
        • 7.14.1.6.3 Channel calibration time skew (NM)
      • 7.14.1.7 Channel sampling frequency (NM)
      • 7.14.1.8 Minimum and maximum data values (CM)
        • 7.14.1.8.1 Minimum data value (NM)
        • 7.14.1.8.2 Maximum data value (NM)
    • 7.14.2 Specific observation ID suffixes
      • 7.14.2.1 Timing information (TIM)
      • 7.14.2.2 Channel definition data (CHN)
      • 7.14.2.3 Waveform digital data (WAV)
      • 7.14.2.4 Waveform annotation (ANO)
  • 7.15 WAVEFORM - TRIGGER EVENTS & MESSAGE DEFINITIONS
    • 7.15.1 W01 - waveform result, unsolicited transmission of requested information
    • 7.15.2 W02 - waveform result, response to query
  • 7.16 WAVEFORM - SEGMENT DEFINITIONS
    • 7.16.1 Combining rules for waveform OBX segments
    • 7.16.2 Restrictions on valuation of OBX segment fields
    • 7.16.3 OBX segment - TIM category
    • 7.16.4 OBX segment - CHN category
    • 7.16.5 OBX segment - WAV category
    • 7.16.6 OBX segment - ANO category-
  • 7.17 WAVEFORM - EXAMPLES OF USE
    • 7.17.1 Example 1: "channel-block" format, using three separate sets of TIM, CHN, WAV and category OBX segments:
    • 7.17.2 Example 2: "channel-block" format, using a single set of TIM, CHN, WAV and category OBX segments, with multiple channels within the one WAV category result segment:
    • 7.17.3 Example 3: "channel-multiplexed" format, with multiple channels within the one WAV category result segment:
    • 7.17.4 Example 4: "channel-block" format, using three separate sets of TIM, CHN, WAV and category OBX segments with a break in waveform data used to pinpoint waveform annotations for channels one and three:
  • 7.18 TABLES LISTINGS
    • 7.18.1 User defined table 0396 - Coding system-
    • 7.18.2 HL7 Table 0163 - Body site-
    • 7.18.3 HL7 Table 0070 - Specimen source codes-
    • 7.18.4 Figure 7-9 - Common ISO derived units & ISO+ extensions
  • 7.19 OUTSTANDING ISSUES

V2.4 Chapter 8

• 8 .Master Files
  • 8.1 CHAPTER 8 CONTENTS
  • 8.2 PURPOSE
  • 8.3 TRIGGER EVENTS
  • 8.4 MESSAGES
    • 8.4.1 MFN/MFK - master files notification
    • 8.4.2 MFD/ACK - master files delayed application acknowledgment
    • 8.4.3 MFQ/MFR - master files query
      • 8.4.3.1 MFQ use notes
  • 8.5 GENERAL MASTER FILE SEGMENTS
    • 8.5.1 MFI - master file identification segment
      • 8.5.1.0 MFI field definitions
      • 8.5.1.1 MFI-1 Master file identifier (CE) 00658
      • 8.5.1.2 MFI-2 Master files application identifier (HD) 00659
      • 8.5.1.3 MFI-3 File-level event code (ID) 00660
      • 8.5.1.4 MFI-4 Entered date/time (TS) 00661
      • 8.5.1.5 MFI-5 Effective date/time (TS) 00662
      • 8.5.1.6 MFI-6 Response level code (ID) 00663
    • 8.5.2 MFE - master file entry segment
      • 8.5.2.0 MFE field definitions
      • 8.5.2.1 MFE-1 Record-level event code (ID) 00664
      • 8.5.2.2 MFE-2 MFN control ID (ST) 00665
      • 8.5.2.3 MFE-3 Effective date/time (TS) 00662
      • 8.5.2.4 MFE-4 Primary key value - MFE (Varies) 00667
      • 8.5.2.5 MFE-5 Primary key value type (ID) 01319
    • 8.5.3 MFA - master file acknowledgment segment
      • 8.5.3.0 MFA field definitions
      • 8.5.3.1 MFA-1 Record-level event code (ID) 00664
      • 8.5.3.2 MFA-2 MFN control ID (ST) 00665
      • 8.5.3.3 MFA-3 Event Completion date/time (TS) 00668
      • 8.5.3.4 MFA-4 MFN Record Level error return (CE) 00669
      • 8.5.3.5 MFA-5 Primary key value - MFA (CE) 01308
      • 8.5.3.6 MFA-6 Primary key value type - MFA (ID) 01320
  • 8.6 GENERIC MASTER FILE EXAMPLES
    • 8.6.1 ZL7 segment (proposed example only)
      • 8.6.1.0 ZL7 field definitions
      • 8.6.1.1 ZL7-1 HL7 table entry for table xxxx (CE) xxxxx
      • 8.6.1.2 ZL7-2 Display-sort-key (NM) xxxxx
    • 8.6.2 MFN message with original acknowledgment mode
    • 8.6.3 Enhanced mode application-level acknowledgment to the MFN message
      • 8.6.3.1 Initial message with accept acknowledgment
      • 8.6.3.2 Enhanced mode application acknowledgment message
    • 8.6.4 Delayed application-level acknowledgment
      • 8.6.4.1 Initial message with accept acknowledgment
      • 8.6.4.2 Deferred application acknowledgment message
  • 8.7 STAFF AND PRACTITIONER MASTER FILES
    • 8.7.1 MFN/MFK - staff/practitioner master file message
    • 8.7.2 Example: staff and health practitioner master file MFN message
  • 8.8 SERVICE/TEST/OBSERVATIONS MASTER FILES
    • 8.8.1 General approach of service/test/observation master files
    • 8.8.2 MFN/MFK - service/test/observation master file
    • 8.8.3 OM1 - general segment (fields that apply to most observations)
      • 8.8.3.0 OM1 field definitions
      • 8.8.3.1 OM1-1 Sequence number - test/observation master file (NM) 00586
      • 8.8.3.2 OM1-2 Producer's service/test/observation ID (CE) 00587
      • 8.8.3.3 OM1-3 Permitted data types (ID) 00588
      • 8.8.3.4 OM1-4 Specimen required (ID) 00589
      • 8.8.3.5 OM1-5 Producer ID (CE) 00590
      • 8.8.3.6 OM1-6 Observation description (TX) 00591
      • 8.8.3.7 OM1-7 Other service/test/observation IDs for the observation (CE) 00592
      • 8.8.3.8 OM1-8 Other names (recognized by the producer for the observation) (ST) 00593
      • 8.8.3.9 OM1-9 Preferred report name for the observation (ST) 00594
      • 8.8.3.10 OM1-10 Preferred short name or mnemonic for the observation (ST) 00595
      • 8.8.3.11 OM1-11 Preferred long name for the observation (ST) 00596
      • 8.8.3.12 OM1-12 Orderability (ID) 00597
      • 8.8.3.13 OM1-13 Identity of instrument used to perform this study (CE) 00598
      • 8.8.3.14 OM1-14 Coded representation of method (CE) 00599
      • 8.8.3.15 OM1-15 Portable device indicator (ID) 00600
      • 8.8.3.16 OM1-16 Observation producing department/section (CE) 00601
      • 8.8.3.17 OM1-17 Telephone number of section (XTN) 00602
      • 8.8.3.18 OM1-18 Nature of service/test/observation (IS) 00603
      • 8.8.3.19 OM1-19 Report subheader (CE) 00604
      • 8.8.3.20 OM1-20 Report display order (ST) 00605
      • 8.8.3.21 OM1-21 Date/time stamp for any change in definition for the observation (TS) 00606
      • 8.8.3.22 OM1-22 Effective date/time of change (TS) 00607
      • 8.8.3.23 OM1-23 Typical turn-around time (NM) 00608
      • 8.8.3.24 OM1-24 Processing time (NM) 00609
      • 8.8.3.25 OM1-25 Processing priority (ID) 00610
      • 8.8.3.26 OM1-26 Reporting priority (ID) 00611
      • 8.8.3.27 OM1-27 Outside site(s) where observation may be performed (CE) 00612
      • 8.8.3.28 OM1-28 Address of outside site(s) (XAD) 00613
      • 8.8.3.29 OM1-29 Phone number of outside site (XTN) 00614
      • 8.8.3.30 OM1-30 Confidentiality code (IS) 00615
      • 8.8.3.31 OM1-31 Observations required to interpret this observation (CE) 00616
      • 8.8.3.32 OM1-32 Interpretation of observations (TX) 00617
      • 8.8.3.33 OM1-33 Contraindications to observations (CE) 00618
      • 8.8.3.34 OM1-34 Reflex tests/observations (CE) 00619
      • 8.8.3.35 OM1-35 Rules that trigger reflex testing (TX) 00620
      • 8.8.3.36 OM1-36 Fixed canned message (CE) 00621
      • 8.8.3.37 OM1-37 Patient preparation (TX) 00622
      • 8.8.3.38 OM1-38 Procedure medication (CE) 00623
      • 8.8.3.39 OM1-39 Factors that may affect the observation (TX) 00624
      • 8.8.3.40 OM1-40 Service/test/observation performance schedule (ST) 00625
      • 8.8.3.41 OM1-41 Description of test methods (TX) 00626
      • 8.8.3.42 OM1-42 Kind of quantity observed (CE) 00937
      • 8.8.3.43 OM1-43 Point versus interval (CE) 00938
      • 8.8.3.44 OM1-44 Challenge information (TX) 00939
      • 8.8.3.45 OM1-45 Relationship modifier (CE) 00940
      • 8.8.3.46 OM1-46 Target anatomic site of test (CE) 00941
      • 8.8.3.47 OM1-47 Modality of imaging measurement (CE) 00942
    • 8.8.4 OM2 - numeric observation segment
      • 8.8.4.0 OM2 field definitions
      • 8.8.4.1 OM2-1 Sequence number - test/observation master file (NM) 00586
      • 8.8.4.2 OM2-2 Units of measure (CE) 00627
      • 8.8.4.3 OM2-3 Range of decimal precision (NM) 00628
      • 8.8.4.4 OM2-4 Corresponding SI units of measure (CE) 00629
      • 8.8.4.5 OM2-5 SI conversion factor (TX) 00630
      • 8.8.4.6 OM2-6 Reference (normal) range for ordinal and continuous observations (CM) 00631
        • 8.8.4.6.1 The reference (normal) range (CM)
        • 8.8.4.6.2 Administrative Sex (IS)
        • 8.8.4.6.3 Age range (CM)
        • 8.8.4.6.4 Gestational age range (CM)
        • 8.8.4.6.5 Species (TX)
        • 8.8.4.6.6 Race/subspecies (ST)
        • 8.8.4.6.7 Conditions (TX)
        • 8.8.4.6.8 Examples
      • 8.8.4.7 OM2-7 Critical range for ordinal and continuous observations (CM) 00632
      • 8.8.4.8 OM2-8 Absolute range for ordinal and continuous observations (CM) 00633
      • 8.8.4.9 OM2-9 Delta check criteria (CM) 00634
      • 8.8.4.10 OM2-10 Minimum meaningful increments (NM) 00635
    • 8.8.5 OM3 - categorical service/test/observation segment
      • 8.8.5.0 OM3 field definitions
      • 8.8.5.1 OM3-1 Sequence number - test/observation master file (NM) 00586
      • 8.8.5.2 OM3-2 Preferred coding system (CE) 00636
      • 8.8.5.3 OM3-3 Valid coded "answers" (CE) 00637
      • 8.8.5.4 OM3-4 Normal text/codes for categorical observations (CE) 00638
      • 8.8.5.5 OM3-5 Abnormal text/codes for categorical observations (CE) 00639
      • 8.8.5.6 OM3-6 Critical text/codes for categorical observations (CE) 00640
      • 8.8.5.7 OM3-7 Value type (ID) 00570
    • 8.8.6 OM4 - observations that require specimens segment
      • 8.8.6.0 OM4 field definitions
      • 8.8.6.1 OM4-1 Sequence number - test/observation master file (NM) 00586
      • 8.8.6.2 OM4-2 Derived specimen (ID) 00642
      • 8.8.6.3 OM4-3 Container description (TX) 00643
      • 8.8.6.4 OM4-4 Container volume (NM) 00644
      • 8.8.6.5 OM4-5 Container units (CE) 00645
      • 8.8.6.6 OM4-6 Specimen (CE) 00646
      • 8.8.6.7 OM4-7 Additive (CE) 00647
      • 8.8.6.8 OM4-8 Preparation (TX) 00648
      • 8.8.6.9 OM4-9 Special handling requirements (TX) 00649
      • 8.8.6.10 OM4-10 Normal collection volume (CQ) 00650
      • 8.8.6.11 OM4-11 Minimum collection volume (CQ) 00651
      • 8.8.6.12 OM4-12 Specimen requirements (TX) 00652
      • 8.8.6.13 OM4-13 Specimen priorities (ID) 00653
      • 8.8.6.14 OM4-14 Specimen retention time (CQ) 00654
    • 8.8.7 OM5 - observation batteries (sets) segment
      • 8.8.7.0 OM5 field definitions
      • 8.8.7.1 OM5-1 Sequence number - test/observation master file (NM) 00586
      • 8.8.7.2 OM5-2 Tests/observations included within an ordered test battery (CE) 00655
      • 8.8.7.3 OM5-3 Observation ID suffixes (ST) 00656
    • 8.8.8 OM6 - Observations that are calculated from other observations segment
      • 8.8.8.0 OM6 field definitions
      • 8.8.8.1 OM6-1 Sequence number -test/observation master file (NM) 00586
      • 8.8.8.2 OM6-2 Derivation rule (TX) 00657
    • 8.8.9 OM7 - additional basic attributes (fields that apply to most observations/services)
      • 8.8.9.0 OM7 field definitions
      • 8.8.9.1 OM7-1 Sequence number -test/observation master file (NM) 00586
      • 8.8.9.2 OM7-2 Universal service identifier (CE) 00238
      • 8.8.9.3 OM7-3 Category identifier (CE) 01481
      • 8.8.9.4 OM7-4 Category description (TX) 01482
      • 8.8.9.5 OM7-5 Category synonym (ST) 01483
      • 8.8.9.6 OM7-6 Effective test/service start date/time (TS) 01484
      • 8.8.9.7 OM7-7 Effective test/service end date/time (TS) 01485
      • 8.8.9.8 OM7-8 Test/service default duration quantity (NM) 01486
      • 8.8.9.9 OM7-9 Test/service default duration units (CE) 01487
      • 8.8.9.10 OM7-10 Test/service default frequency (IS) 01488
      • 8.8.9.11 OM7-11 Consent indicator (ID) 01489
      • 8.8.9.12 OM7-12 Consent identifier (CE) 01490
      • 8.8.9.13 OM7-13 Consent effective start date/time (TS) 01491
      • 8.8.9.14 OM7-14 Consent effective end date/time (TS) 01492
      • 8.8.9.15 OM7-15 Consent interval quantity (NM) 01493
      • 8.8.9.16 OM7-16 Consent interval units (CE) 01494
      • 8.8.9.17 OM7-17 Consent waiting period quantity (NM) 01495
      • 8.8.9.18 OM7-18 Consent waiting period unit (CE) 01496
      • 8.8.9.19 OM7-19 Effective date/time of change (TS) 00607
      • 8.8.9.20 OM7-20 Entered by (XCN) 00224
      • 8.8.9.21 OM7-21 Orderable-at location (PL) 01497
      • 8.8.9.22 OM7-22 Formulary status (IS) 01498
      • 8.8.9.23 OM7-23 Special order indicator (ID) 01499
      • 8.8.9.24 OM7-24 Primary key value - CDM (CE) 01306
  • 8.9 LOCATION MASTER FILES
    • 8.9.1 Patient location master file message (MFN/MFK)
    • 8.9.2 LOC - location identification segment
      • 8.9.2.0 LOC field definitions
      • 8.9.2.1 LOC-1 Primary key value - LOC (PL) 01307
      • 8.9.2.2 LOC-2 Location description (ST) 00944
      • 8.9.2.3 LOC-3 Location type - LOC (IS) 00945
      • 8.9.2.4 LOC-4 Organization name - LOC (XON) 00947
      • 8.9.2.5 LOC-5 Location address (XAD) 00948
      • 8.9.2.6 LOC-6 Location phone (XTN) 00949
      • 8.9.2.7 LOC-7 License number (CE) 00951
      • 8.9.2.8 LOC-8 Location equipment (IS) 00953
      • 8.9.2.9 LOC-9 Location service code (IS) 01583
    • 8.9.3 LCH - location characteristic segment
      • 8.9.3.0 LCH field definitions
      • 8.9.3.1 LCH-1 Primary key value - LCH (PL) 01305
      • 8.9.3.2 LCH-2 Segment action code (ID) 00763
      • 8.9.3.3 LCH-3 Segment unique key (EI) 00764
      • 8.9.3.4 LCH-4 Location characteristic ID (CE) 01295
      • 8.9.3.5 LCH-5 Location characteristic value - LCH (CE) 01294
    • 8.9.4 LRL - location relationship segment
      • 8.9.4.0 LRL field definitions
      • 8.9.4.1 LRL-1 Primary key value - LRL (PL) 00943
      • 8.9.4.2 LRL-2 Segment action code (ID) 00763
      • 8.9.4.3 LRL-3 Segment unique key (EI) 00764
      • 8.9.4.4 LRL-4 Location relationship ID (CE) 01277
      • 8.9.4.5 LRL-5 Organizational location relationship value (XON) 01301
      • 8.9.4.6 LRL-6 Patient location relationship value (PL) 01292
    • 8.9.5 LDP - location department segment
      • 8.9.5.0 LDP field definitions
      • 8.9.5.1 LDP-1 Primary key value - LDP (PL) 00963
      • 8.9.5.2 LDP-2 Location department (CE) 00964
      • 8.9.5.3 LDP-3 Location service (IS) 00965
      • 8.9.5.4 LDP-4 Specialty type (CE) 00966
      • 8.9.5.5 LDP-5 Valid patient classes (IS) 00967
      • 8.9.5.6 LDP-6 Active/inactive flag (ID) 00675
      • 8.9.5.7 LDP-7 Activation date - LDP (TS) 00969
      • 8.9.5.8 LDP-8 Inactivation date - LDP (TS) 00970
      • 8.9.5.9 LDP-9 Inactivated reason (ST) 00971
      • 8.9.5.10 LDP-10 Visiting hours (VH) 00976
      • 8.9.5.11 LDP-11 Contact phone (XTN) 00978
      • 8.9.5.12 LDP-12 Location cost center (CE) 01584
    • 8.9.6 LCC - location charge code segment
      • 8.9.6.0 LCC field definitions
      • 8.9.6.1 LCC-1 Primary key value - LCC (PL) 00979
      • 8.9.6.2 LCC-2 Location department (CE) 00964
      • 8.9.6.3 LCC-3 Accommodation type (CE) 00980
      • 8.9.6.4 LCC-4 Charge code (CE) 00981
    • 8.9.7 Example: MFN location master file message
  • 8.10 CHARGE DESCRIPTION MASTER FILES
    • 8.10.1 Charge description master file message (MFN/MFK)
    • 8.10.2 CDM - charge description master segment
      • 8.10.2.0 CDM field definitions
      • 8.10.2.1 CDM-1 Primary key value - CDM (CE) 01306
      • 8.10.2.2 CDM-2 Charge code alias (CE) 00983
      • 8.10.2.3 CDM-3 Charge description short (ST) 00984
      • 8.10.2.4 CDM-4 Charge description long (ST) 00985
      • 8.10.2.5 CDM-5 Description override indicator (IS) 00986
      • 8.10.2.6 CDM-6 Exploding charges (CE) 00987
      • 8.10.2.7 CDM-7 Procedure code (CE) 00393
      • 8.10.2.8 CDM-8 Active/inactive flag (ID) 00675
      • 8.10.2.9 CDM-9 Inventory number (CE) 00990
      • 8.10.2.10 CDM-10 Resource load (NM) 00991
      • 8.10.2.11 CDM-11 Contract number (CK) 00992
      • 8.10.2.12 CDM-12 Contract organization (XON) 00993
      • 8.10.2.13 CDM-13 Room fee indicator (ID) 00994
    • 8.10.3 PRC - pricing segment
      • 8.10.3.0 PRC fields definitions
      • 8.10.3.1 PRC-1 Primary key value - PRC (CE) 00982
      • 8.10.3.2 PRC-2 Facility ID - PRC (CE) 00995
      • 8.10.3.3 PRC-3 Department (CE) 00676
      • 8.10.3.4 PRC-4 Valid patient classes (IS) 00967
      • 8.10.3.5 PRC-5 Price (CP) 00998
      • 8.10.3.6 PRC-6 Formula (ST) 00999
      • 8.10.3.7 PRC-7 Minimum quantity (NM) 01000
      • 8.10.3.8 PRC-8 Maximum quantity (NM) 01001
      • 8.10.3.9 PRC-9 Minimum price (MO) 01002
      • 8.10.3.10 PRC-10 Maximum price (MO) 01003
      • 8.10.3.11 PRC-11 Effective start date (TS) 01004
      • 8.10.3.12 PRC-12 Effective end date (TS) 01005
      • 8.10.3.13 PRC-13 Price override flag (IS) 01006
      • 8.10.3.14 PRC-14 Billing category (CE) 01007
      • 8.10.3.15 PRC-15 Chargeable flag (ID) 01008
      • 8.10.3.16 PRC-16 Active/inactive flag (ID) 00675
      • 8.10.3.17 PRC-17 Cost (MO) 00989
      • 8.10.3.18 PRC-18 Charge on indicator (IS) 01009
    • 8.10.4 Example: MRN message charge description master file
  • 8.11 CLINICAL TRIALS MASTER FILES
    • 8.11.1 Clinical trials master file message (MFN/MFK)
    • 8.11.2 CM0 - clinical study master segment
      • 8.11.2.0 CM0 field definitions
      • 8.11.2.1 CM0-1 Set ID - CM0 (SI) 01010
      • 8.11.2.2 CM0-2 Sponsor study ID (EI) 01011
      • 8.11.2.3 CM0-3 Alternate study ID (EI) 01036
      • 8.11.2.4 CM0-4 Title of study (ST) 01013
      • 8.11.2.5 CM0-5 Chairman of study (XCN) 01014
      • 8.11.2.6 CM0-6 Last IRB approval date (DT) 01015
      • 8.11.2.7 CM0-7 Total accrual to date (NM) 01016
      • 8.11.2.8 CM0-8 Last accrual date (DT) 01017
      • 8.11.2.9 CM0-9 Contact for study (XCN) 01018
      • 8.11.2.10 CM0-10 Contact's telephone number' (XTN) 01019
      • 8.11.2.11 CM0-11 Contact's address (XAD) 01020
    • 8.11.3 CM1 - clinical study phase master segment
      • 8.11.3.0 CM1 field definitions
      • 8.11.3.1 CM1-1 Set ID - CM1 (SI) 01021
      • 8.11.3.2 CM1-2 Study phase identifier (CE) 01022
      • 8.11.3.3 CM1-3 Description of study phase (ST) 01023
    • 8.11.4 CM2 - clinical study schedule master segment
      • 8.11.4.0 CM2 field definitions
      • 8.11.4.1 CM2-1 Set ID - CM2 (SI) 01024
      • 8.11.4.2 CM2-2 Scheduled time point (CE) 01025
      • 8.11.4.3 CM2-3 Description of time point (ST) 01026
      • 8.11.4.4 CM2-4 Events scheduled this time point (CE) 01027
  • 8.12 EXAMPLES
    • Master file update examples: with original and enhanced acknowledgment protocol
  • 8.13 OUTSTANDING ISSUES

HL7 V2.4 Chapter 9

• 9 .Medical Records/Information Management
  (Document Management)
  • 9.1 CHAPTER 9 CONTENTS
  • 9.2 PURPOSES
    • 9.2.1 Definition of terms and concepts
      • 9.2.1.1 Addendum:
      • 9.2.1.2 Archived:
      • 9.2.1.3 Canceled:
      • 9.2.1.4 Composite document:
      • 9.2.1.5 Document completion table:
      • 9.2.1.6 Authenticated:
        • 9.2.1.6.1 Dictated:
        • 9.2.1.6.2 Documented:
        • 9.2.1.6.3 In progress/assigned:
        • 9.2.1.6.4 Incomplete:
      • 9.2.1.7 Legally authenticated:
        • 9.2.1.7.1 Pre-authenticated:
      • 9.2.1.8 Edited document:
      • 9.2.1.9 New or original document:
      • 9.2.1.10 Obsolete:
      • 9.2.1.11 Purged:
      • 9.2.1.12 Replacement document:
      • 9.2.1.13 Restricted:
      • 9.2.1.14 Revised document:
      • 9.2.1.15 Transcription:
  • 9.3 DOCUMENT MANAGEMENT SECTION
  • 9.4 ASSUMPTIONS
  • 9.5 TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 9.5.1 MDM/ACK - original document notification (event T01)
    • 9.5.2 MDM/ACK - original document notification and content (event T02)
    • 9.5.3 MDM/ACK - document status change notification (event T03)
    • 9.5.4 MDM/ACK - document status change notification and content (event T04)
    • 9.5.5 MDM/ACK - document addendum notification (event T05)
    • 9.5.6 MDM/ACK - document addendum notification and content (event T06)
    • 9.5.7 MDM/ACK - document edit notification (event T07)
    • 9.5.8 MDM/ACK - document edit notification and content (event T08)
    • 9.5.9 MDM/ACK - document replacement notification (event T09)
    • 9.5.10 MDM/ACK - document replacement notification and content (event T10)
    • 9.5.11 MDM/ACK - document cancel notification (event T11)
  • 9.6 MESSAGE SEGMENTS
    • 9.6.1 TXA - transcription document header segment
      • 9.6.1.0 TXA field definitions
      • 9.6.1.1 TXA-1 Set ID - TXA (SI) 00914
      • 9.6.1.2 TXA-2 Document type (IS) 00915
      • 9.6.1.3 TXA-3 Document content presentation (ID) 00916
      • 9.6.1.4 TXA-4 Activity date/time (TS) 00917
      • 9.6.1.5 TXA-5 Primary activity provider code/name (XCN) 00918
      • 9.6.1.6 TXA-6 Origination date/time (TS) 00919
      • 9.6.1.7 TXA-7 Transcription date/time (TS) 00920
      • 9.6.1.8 TXA-8 Edit date/time (TS) 00921
      • 9.6.1.9 TXA-9 Originator code/name (XCN) 00922
      • 9.6.1.10 TXA-10 Assigned document authenticator (XCN) 00923
      • 9.6.1.11 TXA-11 Transcriptionist code/name (XCN) 00924
      • 9.6.1.12 TXA-12 Unique document number (EI) 00925
      • 9.6.1.13 TXA-13 Parent document number (EI) 00926
      • 9.6.1.14 TXA-14 Placer order number (EI) 00216
      • 9.6.1.15 TXA-15 Filler order number (EI) 00217
      • 9.6.1.16 TXA-16 Unique document file name (ST) 00927
      • 9.6.1.17 TXA-17 Document completion status (ID) 00928
      • 9.6.1.18 TXA-18 Document confidentiality status (ID) 00929
      • 9.6.1.19 TXA-19 Document availability status (ID) 00930
      • 9.6.1.20 TXA-20 Document storage status (ID) 00932
      • 9.6.1.21 TXA-21 Document change reason (ST) 00933
      • 9.6.1.22 TXA-22 Authentication person, time stamp (set) (PPN) 00934
        • 9.6.1.22.1 Authentication person (component) (XCN)
        • 9.6.1.22.2 Authentication time stamp (component) (TS)
      • 9.6.1.23 TXA-23 Distributed copies (XCN) 00935
    • 9.6.2 OBX - observation segment usage
  • 9.7 EXAMPLE MESSAGE
  • 9.8 QUERY
    • 9.8.1 QRY/DOC - document query (event T12)
      • 9.8.1.1 Query usage notes
  • 9.9 OUTSTANDING ISSUES

HL7 V2.4 Chapter 10

• 10 .Scheduling
  • 10.1 CHAPTER 10 CONTENTS
  • 10.2 PURPOSE
    • 10.2.1 Schedules, appointments, and services and resources
      • 10.2.1.1 Schedules
      • 10.2.1.2 Services and resources
      • 10.2.1.3 Appointments
      • 10.2.1.4 Parent and child appointments
    • 10.2.2 Application roles
      • 10.2.2.1 The filler application role
      • 10.2.2.2 The placer application role
      • 10.2.2.3 The querying application role
      • 10.2.2.4 The auxiliary application role
      • 10.2.2.5 Application roles in a messaging environment
    • 10.2.3 Trigger events, statuses, reasons, and types
      • 10.2.3.1 Trigger events
      • 10.2.3.2 Statuses
      • 10.2.3.3 Reasons
      • 10.2.3.4 Types
    • 10.2.4 Appointments, orders, and referrals
    • 10.2.5 Glossary
      • 10.2.5.1 Appointment:
      • 10.2.5.2 Auxiliary application:
      • 10.2.5.3 Block:
      • 10.2.5.4 Book:
      • 10.2.5.5 Child appointment:
      • 10.2.5.6 Filler application:
      • 10.2.5.7 Parent appointment:
      • 10.2.5.8 Placer application:
      • 10.2.5.9 Querying application:
      • 10.2.5.10 Resource:
      • 10.2.5.11 Schedule:
      • 10.2.5.12 Service:
      • 10.2.5.13 Slot:
    • 10.2.6 Organization of this chapter: trigger events and message definitions
      • 10.2.6.1 Update mode
  • 10.3 PLACER APPLICATION REQUESTS AND TRIGGER EVENTS
    • 10.3.1 Request new appointment booking (event S01)
    • 10.3.2 Request appointment rescheduling (event S02)
    • 10.3.3 Request appointment modification (event S03)
    • 10.3.4 Request appointment cancellation (event S04)
    • 10.3.5 Request appointment discontinuation (event S05)
    • 10.3.6 Request appointment deletion (event S06)
    • 10.3.7 Request addition of service/resource on appointment (event S07)
    • 10.3.8 Request modification of service/resource on appointment (event S08)
    • 10.3.9 Request cancellation of service/resource on appointment (event S09)
    • 10.3.10 Request discontinuation of service/resource on appointment (event S10)
    • 10.3.11 Request deletion of service/resource on appointment (event S11)
  • 10.4 FILLER APPLICATION MESSAGES AND TRIGGER EVENTS UNSOLICITED
    • 10.4.1 Notification of new appointment booking (event S12)
    • 10.4.2 Notification of appointment rescheduling (event S13)
    • 10.4.3 Notification of appointment modification (event S14)
    • 10.4.4 Notification of appointment cancellation (event S15)
    • 10.4.5 Notification of appointment discontinuation (event S16)
    • 10.4.6 Notification of appointment deletion (event S17)
    • 10.4.7 Notification of addition of service/resource on appointment (event S18)
    • 10.4.8 Notification of modification of service/resource on appointment (event S19)
    • 10.4.9 Notification of cancellation of service/resource on appointment (event S20)
    • 10.4.10 Notification of discontinuation of service/resource on appointment (event S21)
    • 10.4.11 Notification of deletion of service/resource on appointment (event S22)
    • 10.4.12 Notification of blocked schedule time slot(s) (event S23)
    • 10.4.13 Notification of opened ("un-blocked") schedule time slot(s) (event S24)
    • 10.4.14 Notification that patient did not show up for scheduled appointment (event S26)
  • 10.5 QUERY TRANSACTIONS AND TRIGGER EVENTS
    • 10.5.1 Original mode queries - display oriented
    • 10.5.2 Original mode queries - record oriented
    • 10.5.3 SQM/SQR - schedule query message and response (event S25)
    • 10.5.4 Enhanced mode queries
  • 10.6 MESSAGE SEGMENTS
    • 10.6.1 ARQ - appointment request segment
      • 10.6.1.0 ARQ field definitions
      • 10.6.1.1 ARQ-1 Placer appointment ID (EI) 00860
      • 10.6.1.2 ARQ-2 Filler appointment ID (EI) 00861
      • 10.6.1.3 ARQ-3 Occurrence number (NM) 00862
      • 10.6.1.4 ARQ-4 Placer group number (EI) 00218
      • 10.6.1.5 ARQ-5 Schedule ID (CE) 00864
      • 10.6.1.6 ARQ-6 Request event reason (CE) 00865
      • 10.6.1.7 ARQ-7 Appointment reason (CE) 00866
      • 10.6.1.8 ARQ-8 Appointment type (CE) 00867
      • 10.6.1.9 ARQ-9 Appointment duration (NM) 00868
      • 10.6.1.10 ARQ-10 Appointment duration units (CE) 00869
      • 10.6.1.11 ARQ-11 Requested start date/time range (DR) 00870
      • 10.6.1.12 ARQ-12 Priority-ARQ (ST) 00871
      • 10.6.1.13 ARQ-13 Repeating interval (RI) 00872
      • 10.6.1.14 ARQ-14 Repeating interval duration (ST) 00873
      • 10.6.1.15 ARQ-15 Placer contact person (XCN) 00874
      • 10.6.1.16 ARQ-16 Placer contact phone number (XTN) 00875
      • 10.6.1.17 ARQ-17 Placer contact address (XAD) 00876
      • 10.6.1.18 ARQ-18 Placer contact location (PL) 00877
      • 10.6.1.19 ARQ-19 Entered by person (XCN) 00878
      • 10.6.1.20 ARQ-20 Entered by phone number (XTN) 00879
      • 10.6.1.21 ARQ-21 Entered by location (PL) 00880
      • 10.6.1.22 ARQ-22 Parent placer appointment ID (EI) 00881
      • 10.6.1.23 ARQ-23 Parent filler appointment ID (EI) 00882
      • 10.6.1.24 ARQ-24 Placer order number (EI) 00216
      • 10.6.1.25 ARQ-25 Filler order number (EI) 00217
    • 10.6.2 SCH - schedule activity information segment
      • 10.6.2.0 SCH field definitions
      • 10.6.2.1 SCH-1 Placer appointment ID (EI) 00860
      • 10.6.2.2 SCH-2 Filler appointment ID (EI) 00861
      • 10.6.2.3 SCH-3 Occurrence number (NM) 00862
      • 10.6.2.4 SCH-4 Placer group number (EI) 00218
      • 10.6.2.5 SCH-5 Schedule ID (CE) 00864
      • 10.6.2.6 SCH-6 Event reason (CE) 00883
      • 10.6.2.7 SCH-7 Appointment reason (CE) 00866
      • 10.6.2.8 SCH-8 Appointment type (CE) 00867
      • 10.6.2.9 SCH-9 Appointment duration (NM) 00868
      • 10.6.2.10 SCH-10 Appointment duration units (CE) 00869
      • 10.6.2.11 SCH-11 Appointment timing quantity (TQ) 00884
      • 10.6.2.12 SCH-12 Placer contact person (XCN) 00874
      • 10.6.2.13 SCH-13 Placer contact phone number (XTN) 00875
      • 10.6.2.14 SCH-14 Placer contact address (XAD) 00876
      • 10.6.2.15 SCH-15 Placer contact location (PL) 00877
      • 10.6.2.16 SCH-16 Filler contact person (XCN) 00885
      • 10.6.2.17 SCH-17 Filler contact phone number (XTN) 00886
      • 10.6.2.18 SCH-18 Filler contact address (XAD) 00887
      • 10.6.2.19 SCH-19 Filler contact location (PL) 00888
      • 10.6.2.20 SCH-20 Entered by person (XCN) 00878
      • 10.6.2.21 SCH-21 Entered by phone number (XTN) 00879
      • 10.6.2.22 SCH-22 Entered by location (PL) 00880
      • 10.6.2.23 SCH-23 Parent placer appointment ID (EI) 00881
      • 10.6.2.24 SCH-24 Parent filler appointment ID (EI) 00882
      • 10.6.2.25 SCH-25 Filler status code (CE) 00889
      • 10.6.2.26 SCH-26 Placer order number (EI) 00216
      • 10.6.2.27 SCH-27 Filler order number (EI) 00217
    • 10.6.3 RGS - resource group segment
      • 10.6.3.0 RGS field definitions
      • 10.6.3.1 RGS-1 Set ID - RGS (SI) 01203
      • 10.6.3.2 RGS-2 Segment action code (ID) 00763
      • 10.6.3.3 RGS-3 Resource group ID (CE) 01204
    • 10.6.4 AIS - appointment information - service segment
      • 10.6.4.0 AIS field definitions
      • 10.6.4.1 AIS-1 Set ID - AIS (SI) 00890
      • 10.6.4.2 AIS-2 Segment action code (ID) 00763
      • 10.6.4.3 AIS-3 Universal service identifier (CE) 00238
      • 10.6.4.4 AIS-4 Start date/time (TS) 01202
      • 10.6.4.5 AIS-5 Start date/time offset (NM) 00891
      • 10.6.4.6 AIS-6 Start date/time offset units (CE) 00892
      • 10.6.4.7 AIS-7 Duration (NM) 00893
      • 10.6.4.8 AIS-8 Duration units (CE) 00894
      • 10.6.4.9 AIS-9 Allow substitution code (IS) 00895
      • 10.6.4.10 AIS-10 Filler status code (CE) 00889
      • 10.6.4.11 AIS-11 Placer supplemental service / logistical information (CE) 01474
      • 10.6.4.12 AIS-12 Filler supplemental service / logistical information (CE) 01475
    • 10.6.5 AIG - appointment information - general resource segment
      • 10.6.5.0 AIG field definitions
      • 10.6.5.1 AIG-1 Set ID - AIG (SI) 00896
      • 10.6.5.2 AIG-2 Segment action code (ID) 00763
      • 10.6.5.3 AIG-3 Resource ID (CE) 00897
      • 10.6.5.4 AIG-4 Resource type (CE) 00898
      • 10.6.5.5 AIG-5 Resource group (CE) 00899
      • 10.6.5.6 AIG-6 Resource quantity (NM) 00900
      • 10.6.5.7 AIG-7 Resource quantity units (CE) 00901
      • 10.6.5.8 AIG-8 Start date/time (TS) 01202
      • 10.6.5.9 AIG-9 Start date/time offset (NM) 00891
      • 10.6.5.10 AIG-10 Start date/time offset units (CE) 00892
      • 10.6.5.11 AIG-11 Duration (NM) 00893
      • 10.6.5.12 AIG-12 Duration units (CE) 00894
      • 10.6.5.13 AIG-13 Allow substitution code (IS) 00895
      • 10.6.5.14 AIG-14 Filler status code (CE) 00889
    • 10.6.6 AIL - appointment information - location resource segment
      • 10.6.6.0 AIL field definitions
      • 10.6.6.1 AIL-1 Set ID - AIL (SI) 00902
      • 10.6.6.2 AIL-2 Segment action code (ID) 00763
      • 10.6.6.3 AIL-3 Location resource ID (PL) 00903
      • 10.6.6.4 AIL-4 Location type-AIL (CE) 00904
      • 10.6.6.5 AIL-5 Location group (CE) 00905
      • 10.6.6.6 AIL-6 Start date/time (TS) 01202
      • 10.6.6.7 AIL-7 Start date/time offset (NM) 00891
      • 10.6.6.8 AIL-8 Start date/time offset units (CE) 00892
      • 10.6.6.9 AIL-9 Duration (NM) 00893
      • 10.6.6.10 AIL-10 Duration units (CE) 00894
      • 10.6.6.11 AIL-11 Allow substitution code (IS) 00895
      • 10.6.6.12 AIL-12 Filler status code (CE) 00889
    • 10.6.7 AIP - appointment information - personnel resource segment
      • 10.6.7.0 AIP field definitions
      • 10.6.7.1 AIP-1 Set ID - AIP (SI) 00906
      • 10.6.7.2 AIP-2 segment action code (ID) 00763
      • 10.6.7.3 AIP-3 Personnel resource ID (XCN) 00913
      • 10.6.7.4 AIP-4 Resource role (CE) 00907
      • 10.6.7.5 AIP-5 Resource group (CE) 00899
      • 10.6.7.6 AIP-6 Start date/time (TS) 01202
      • 10.6.7.7 AIP-7 Start date/time offset (NM) 00891
      • 10.6.7.8 AIP-8 Start date/time offset units (CE) 00892
      • 10.6.7.9 AIP-9 Duration (NM) 00893
      • 10.6.7.10 AIP-10 Duration units (CE) 00894
      • 10.6.7.11 AIP-11 Allow substitution code (IS) 00895
      • 10.6.7.12 AIP-12 Filler status code (CE) 00889
    • 10.6.8 APR - appointment preferences segment
      • 10.6.8.0 APR field definitions
      • 10.6.8.1 APR-1 Time selection criteria (SCV) 00908
      • 10.6.8.2 APR-2 Resource selection criteria (SCV) 00909
      • 10.6.8.3 APR-3 Location selection criteria (SCV) 00910
      • 10.6.8.4 APR-4 Slot spacing criteria (NM) 00911
      • 10.6.8.5 APR-5 Filler override criteria (SCV) 00912
  • 10.7 EXAMPLE TRANSACTIONS
    • 10.7.1 Request and receive new appointment - event S01
    • 10.7.2 Unsolicited notification of rescheduled appointment - event S13
    • 10.7.3 Request and receive new appointment with repeating interval - event S01
  • 10.8 IMPLEMENTATION CONSIDERATIONS
    • 10.8.1 Logical relationship of resource and service segments
    • 10.8.2 Multiple placer applications
  • 10.9 ISSUES
    • 10.9.1 Logical relationship of resource and service segments
  • 10.10 OUTSTANDING ISSUES

HL7 V2.4 Chapter 11

• 11 .Patient Referral
  • 11.1 CHAPTER 11 CONTENTS
  • 11.2 PURPOSE
    • 11.2.1 Patient referral and responses
      • 11.2.1.1 Patient referral
      • 11.2.1.2 Responding to a patient referral
    • 11.2.2 Application roles and data process
      • 11.2.2.1 Application roles
      • 11.2.2.2 The referring provider application role
      • 11.2.2.3 The referred-to provider application role
      • 11.2.2.4 The querying application role
      • 11.2.2.5 The auxiliary application role
      • 11.2.2.6 Application roles in a messaging environment
    • 11.2.3 Glossary
      • 11.2.3.1 Benefits:
      • 11.2.3.2 Clinical information:
      • 11.2.3.3 Dependent:
      • 11.2.3.4 Eligibility/coverage:
      • 11.2.3.5 Encounter:
      • 11.2.3.6 Guarantor:
      • 11.2.3.7 Healthcare provider:
      • 11.2.3.8 Payor:
      • 11.2.3.9 Pre-authorization:
      • 11.2.3.10 Primary care provider:
      • 11.2.3.11 Referral:
      • 11.2.3.12 Referring provider:
      • 11.2.3.13 Referred-to-provider:
      • 11.2.3.14 Specialist:
      • 11.2.3.15 Subscriber:
  • 11.3 PATIENT INFORMATION REQUEST MESSAGES AND TRIGGER EVENTS
    • 11.3.1 RQI/RPI - request for insurance information (event I01)
    • 11.3.2 RQI/RPL - request/receipt of patient selection display list (event I02)
    • 11.3.3 RQI/RPR - request/receipt of patient selection list (event I03)
    • 11.3.4 RQP/RPI - request for patient demographic data (event I04)
    • 11.3.5 RQC/RCI - request for patient clinical information (event I05)
    • 11.3.6 RQC/RCL - request/receipt of clinical data listing (event I06)
    • 11.3.7 PIN/ACK - unsolicited insurance information (event I07)
  • 11.4 PATIENT TREATMENT AUTHORIZATION REQUESTS
    • 11.4.1 RQA/RPA - request patient authorization message
    • 11.4.2 RQA/RPA - request for treatment authorization information (event I08)
    • 11.4.3 RQA/RPA - request for modification to an authorization (event I09)
    • 11.4.4 RQA/RPA - request for resubmission of an authorization (event I10)
    • 11.4.5 RQA/RPA - request for cancellation of an authorization (event I11)
  • 11.5 PATIENT REFERRAL MESSAGES AND TRIGGER EVENTS
    • 11.5.1 REF/RRI - patient referral message
    • 11.5.2 REF/RRI - patient referral (event I12)
    • 11.5.3 REF/RRI - modify patient referral (event I13)
    • 11.5.4 REF/RRI - cancel patient referral (event I14)
    • 11.5.5 REF/RRI - request patient referral status (event I15)
  • 11.6 SEGMENTS
    • 11.6.1 RF1 - referral information segment
      • 11.6.1.0 RF1 - field definitions
      • 11.6.1.1 RF1-1 Referral status (CE) 01137
      • 11.6.1.2 RF1-2 Referral priority (CE) 01138
      • 11.6.1.3 RF1-3 Referral type (CE) 01139
      • 11.6.1.4 RF1-4 Referral disposition (CE) 01140
      • 11.6.1.5 RF1-5 Referral category (CE) 01141
      • 11.6.1.6 RF1-6 Originating referral identifier (EI) 01142
      • 11.6.1.7 RF1-7 Effective date (TS) 01143
      • 11.6.1.8 RF1-8 Expiration date (TS) 01144
      • 11.6.1.9 RF1-9 Process date (TS) 01145
      • 11.6.1.10 RF1-10 Referral reason (CE) 01228
      • 11.6.1.11 RF1-11 External referral identifier (EI) 01300
    • 11.6.2 AUT - authorization information segment
      • 11.6.2.0 AUT - field definitions
      • 11.6.2.1 AUT-1 Authorizing payor, plan ID (CE) 01146
      • 11.6.2.2 AUT-2 Authorizing payor, company ID (CE) 01147
      • 11.6.2.3 AUT-3 Authorizing payor, company name (ST) 01148
      • 11.6.2.4 AUT-4 Authorization effective date (TS) 01149
      • 11.6.2.5 AUT-5 Authorization expiration date (TS) 01150
      • 11.6.2.6 AUT-6 Authorization identifier (EI) 01151
      • 11.6.2.7 AUT-7 Reimbursement limit (CP) 01152
      • 11.6.2.8 AUT-8 Requested number of treatments (NM) 01153
      • 11.6.2.9 AUT-9 Authorized number of treatments (NM) 01154
      • 11.6.2.10 AUT-10 Process date (TS) 01145
    • 11.6.3 PRD - provider data segment
      • 11.6.3.0 PRD field definitions
      • 11.6.3.1 PRD-1 Provider role (CE) 01155
      • 11.6.3.2 PRD-2 Provider name (XPN) 01156
      • 11.6.3.3 PRD-3 Provider address (XAD) 01157
      • 11.6.3.4 PRD-4 Provider location (PL) 01158
      • 11.6.3.5 PRD-5 Provider communication information (XTN) 01159
      • 11.6.3.6 PRD-6 Preferred method of contact - provider (CE) 00684
      • 11.6.3.7 PRD-7 Provider identifiers (CM) 01162
      • 11.6.3.8 PRD-8 Effective start date of provider role (TS) 01163
      • 11.6.3.9 PRD-9 Effective end date of provider role (TS) 01164
    • 11.6.4 CTD - contact data segment
      • 11.6.4.0 CTD field definitions
      • 11.6.4.1 CTD-1 Contact role (CE) 00196
      • 11.6.4.2 CTD-2 Contact name (XPN) 01165
      • 11.6.4.3 CTD-3 Contact address (XAD) 01166
      • 11.6.4.4 CTD-4 Contact location (PL) 01167
      • 11.6.4.5 CTD-5 Contact communication information (XTN) 01168
      • 11.6.4.6 CTD-6 Preferred method of contact - provider (CE) 00684
      • 11.6.4.7 CTD-7 Contact identifiers (CM) 01171
  • 11.7 EXAMPLES
    • 11.7.1 RQI message using an I01 event with an immediate response
    • 11.7.2 RQA message using an I08 event with an immediate response
    • 11.7.3 RQA message using an I08 event with a deferred response
    • 11.7.4 REF message using an I11 event with an immediate response
    • 11.7.5 REF message using an I11 event with a deferred response
    • 11.7.6 RQC inquiry message using an I05 event with an immediate response
  • 11.8 OUTSTANDING ISSUES
    • 11.8.1 HL7 overlapping with ASC X12N

HL7 V2.4 Chapter 12

• 12 .Patient Care
  • 12.1 CHAPTER 12 CONTENTS
  • 12.2 INTRODUCTION AND OVERVIEW
    • 12.2.1 Glossary
      • 12.2.1.1 Goal:
      • 12.2.1.2 Problem:
      • 12.2.1.3 Role:
      • 12.2.1.4 Clinical pathway:
      • 12.2.1.5 Variance:
    • 12.2.2 Scenario descriptions
      • 12.2.2.1 Patient pre-admission or patient admission
      • 12.2.2.2 Consultation
      • 12.2.2.3 Loading a clinical repository
      • 12.2.2.4 Communicating clinical pathways and multidisciplinary plans of care
    • 12.2.3 Trigger events
    • 12.2.4 Use of action codes
      • 12.2.4.1 Examples of action code usage
    • 12.2.5 Message construction rules
      • 12.2.5.1 Rule 1
      • 12.2.5.2 Rule 2
      • 12.2.5.3 Rule 3
      • 12.2.5.4 Rule 4
      • 12.2.5.5 Rule 5
      • 12.2.5.6 Rule 6
  • 12.3 MESSAGE DEFINITIONS
    • 12.3.1 PGL/ACK - patient goal message (events PC6, PC7, PC8)
    • 12.3.2 PPR/ACK - patient problem message (events PC1, PC2, PC3)
    • 12.3.3 PPP/ACK - patient pathway message (problem-oriented) (events PCB, PCC, PCD)
    • 12.3.4 PPG/ACK - patient pathway message (goal-oriented) (events PCG, PCH, PCJ)
    • 12.3.5 QRY - patient care problem query (event PC4)
    • 12.3.6 PRR - patient problem response (event PC5)
    • 12.3.7 QRY - patient goal query (event PC9)
    • 12.3.8 PPV - patient goal response (event PCA)
    • 12.3.9 QRY - patient pathway (problem-oriented) query (event PCE)
    • 12.3.10 PTR - patient pathway (problem-oriented) response (event PCF)
    • 12.3.11 QRY - patient pathway (goal-oriented) query (event PCK)
    • 12.3.12 PPT - patient pathway (goal-oriented) response (event PCL)
  • 12.4 MESSAGE SEGMENTS
    • 12.4.1 GOL - goal detail segment
      • 12.4.1.0 GOL field definitions
      • 12.4.1.1 GOL-1 Action code (ID) 00816
      • 12.4.1.2 GOL-2 Action date/time (TS) 00817
      • 12.4.1.3 GOL-3 Goal ID (CE) 00818
      • 12.4.1.4 GOL-4 Goal instance ID (EI) 00819
      • 12.4.1.5 GOL-5 Episode of care ID (EI) 00820
      • 12.4.1.6 GOL-6 Goal list priority (NM) 00821
      • 12.4.1.7 GOL-7 Goal established date/time (TS) 00822
      • 12.4.1.8 GOL-8 Expected goal achieve date/time (TS) 00824
      • 12.4.1.9 GOL-9 Goal classification (CE) 00825
      • 12.4.1.10 GOL-10 Goal management discipline (CE) 00826
      • 12.4.1.11 GOL-11 Current goal review status (CE) 00827
      • 12.4.1.12 GOL-12 Current goal review date/time (TS) 00828
      • 12.4.1.13 GOL-13 Next goal review date/time (TS) 00829
      • 12.4.1.14 GOL-14 Previous goal review date/time (TS) 00830
      • 12.4.1.15 GOL-15 Goal review interval (TQ) 00831
      • 12.4.1.16 GOL-16 Goal evaluation (CE) 00832
      • 12.4.1.17 GOL-17 Goal evaluation comment (ST) 00833
      • 12.4.1.18 GOL-18 Goal life cycle status (CE) 00834
      • 12.4.1.19 GOL-19 Goal life cycle status date/time (TS) 00835
      • 12.4.1.20 GOL-20 Goal target type (CE) 00836
      • 12.4.1.21 GOL-21 Goal target name (XPN) 00837
    • 12.4.2 PRB - problem detail segment
      • 12.4.2.0 PRB field definitions
      • 12.4.2.1 PRB-1 Action code (ID) 00816
      • 12.4.2.2 PRB-2 Action date/time (TS) 00817
      • 12.4.2.3 PRB-3 Problem ID (CE) 00838
      • 12.4.2.4 PRB-4 Problem instance ID (EI) 00839
      • 12.4.2.5 PRB-5 Episode of care ID (EI) 00820
      • 12.4.2.6 PRB-6 Problem list priority (NM) 00841
      • 12.4.2.7 PRB-7 Problem established date/time (TS) 00842
      • 12.4.2.8 PRB-8 Anticipated problem resolution date/time (TS) 00843
      • 12.4.2.9 PRB-9 Actual problem resolution date/time (TS) 00844
      • 12.4.2.10 PRB-10 Problem classification (CE) 00845
      • 12.4.2.11 PRB-11 Problem management discipline (CE) 00846
      • 12.4.2.12 PRB-12 Problem persistence (CE) 00847
      • 12.4.2.13 PRB-13 Problem confirmation status (CE) 00848
      • 12.4.2.14 PRB-14 Problem life cycle status (CE) 00849
      • 12.4.2.15 PRB-15 Problem life cycle status date/time (TS) 00850
      • 12.4.2.16 PRB-16 Problem date of onset (TS) 00851
      • 12.4.2.17 PRB-17 Problem onset text (ST) 00852
      • 12.4.2.18 PRB-18 Problem ranking (CE) 00853
      • 12.4.2.19 PRB-19 Certainty of problem (CE) 00854
      • 12.4.2.20 PRB-20 Probability of problem (0-1) (NM) 00855
      • 12.4.2.21 PRB-21 Individual awareness of problem (CE) 00856
      • 12.4.2.22 PRB-22 Problem prognosis (CE) 00857
      • 12.4.2.23 PRB-23 Individual awareness of prognosis (CE) 00858
      • 12.4.2.24 PRB-24 Family/significant other awareness of problem/prognosis (ST) 00859
      • 12.4.2.25 PRB-25 Security/sensitivity (CE) 00823
    • 12.4.3 ROL - role segment
      • 12.4.3.0 ROL - field definitions
      • 12.4.3.1 ROL-1 Role instance ID (EI) 01206
      • 12.4.3.2 ROL-2 Action code (ID) 00816
      • 12.4.3.3 ROL-3 Role-ROL (CE) 01197
      • 12.4.3.4 ROL-4 Role person (XCN) 01198
      • 12.4.3.5 ROL-5 Role begin date/time (TS) 01199
      • 12.4.3.6 ROL-6 Role end date/time (TS) 01200
      • 12.4.3.7 ROL-7 Role duration (CE) 01201
      • 12.4.3.8 ROL-8 Role action reason (CE) 01205
      • 12.4.3.9 ROL-9 Provider type (CE) 01510
      • 12.4.3.10 ROL-10 Organization unit type (CE) 01461
      • 12.4.3.11 ROL-11 Office/home address (XAD) 00679
      • 12.4.3.12 ROL-12 Phone (XTN) 00678
    • 12.4.4 PTH - pathway segment
      • 12.4.4.0 PTH - field definitions
      • 12.4.4.1 PTH-1 Action code (ID) 00816
      • 12.4.4.2 PTH-2 Pathway ID (CE) 01207
      • 12.4.4.3 PTH 3 Pathway instance ID (EI) 01208
      • 12.4.4.4 PTH 4 Pathway established date/time (TS) 01209
      • 12.4.4.5 PTH 5 Pathway life cycle status (CE) 01210
      • 12.4.4.6 PTH 6 Change pathway life cycle status (TS) 01211
    • 12.4.5 VAR - variance segment
      • 12.4.5.0 VAR - field definitions
      • 12.4.5.1 VAR-1 Variance instance ID (EI) 01212
      • 12.4.5.2 VAR-2 Documented date/time (TS) 01213
      • 12.4.5.3 VAR-3 Stated variance date/time (TS) 01214
      • 12.4.5.4 VAR-4 Variance originator (XCN) 01215
      • 12.4.5.5 VAR-5 Variance classification (CE) 01216
      • 12.4.5.6 VAR-6 Variance description (ST) 01217
  • 12.5 EXAMPLE TRANSACTIONS
  • 12.6 IMPLEMENTATION CONSIDERATIONS
  • 12.7 OUTSTANDING ISSUES

HL7 V2.4 Chapter 13

• 13 .Clinical Laboratory Automation
  • 13.1 CHAPTER 13 CONTENTS
  • 13.2 BACKGROUND AND INTRODUCTION
    • 13.2.1 Background
    • 13.2.2 Introduction
    • 13.2.3 Glossary
      • 13.2.3.1 Accession Identifier (also accession number):
      • 13.2.3.2 Additive:
      • 13.2.3.3 Aliquot:
      • 13.2.3.4 Analyzer:
      • 13.2.3.5 Automated:
      • 13.2.3.6 Automated instrument:
      • 13.2.3.7 Automation system:
      • 13.2.3.8 Bar code:
      • 13.2.3.9 Bar length:
      • 13.2.3.10 Barrier:
      • 13.2.3.11 Barrier Delta:
      • 13.2.3.12 Bottom of cap:
      • 13.2.3.13 Bottom of container//Bottom of tube:
      • 13.2.3.14 Bottom of tube:
      • 13.2.3.15 Carrier:
      • 13.2.3.16 Character:
      • 13.2.3.17 Clinical laboratory automation:
      • 13.2.3.18 Clinical laboratory automation systems:
      • 13.2.3.19 Closed-container sampling//Closed-tube sampling:
      • 13.2.3.20 Closed-tube sampling:
      • 13.2.3.21 Container//Tube//Test Tube:
      • 13.2.3.22 Container Identifier
      • 13.2.3.23 Cycle time components:
      • 13.2.3.24 Decapping:
      • 13.2.3.25 Delimiter:
      • 13.2.3.26 Directions of the specimen, Transportation system, Instrument or Specimen processing and handling device interfaces:
      • 13.2.3.27 Directions of the sample, Transportation system, Instrument or Specimen processing handling device and interfaces
      • 13.2.3.28 Direct track sampling:
      • 13.2.3.29 Docking site:
      • 13.2.3.30 Flection:
      • 13.2.3.31 Interaction:
      • 13.2.3.32 Label:
      • 13.2.3.33 Laboratory automation system (LAS):
      • 13.2.3.34 Laboratory equipment control interface specification (LECIS):
      • 13.2.3.35 Laboratory information system (LIS):
      • 13.2.3.36 LECIS:
      • 13.2.3.37 Location:
      • 13.2.3.38 Open-container sampling//Open-tube sampling:
      • 13.2.3.39 Open-tube sampling:
      • 13.2.3.40 Pitch:
      • 13.2.3.41 Point of reference//Point in space, (POR):
      • 13.2.3.42 Process instruments:
      • 13.2.3.43 Quiet zone:
      • 13.2.3.44 Recap:
      • 13.2.3.45 Robotic arm:
      • 13.2.3.46 Sample//(Specimen):
      • 13.2.3.47 Sample carrier:
      • 13.2.3.48 Sample container:
      • 13.2.3.49 Sample-positioning system:
      • 13.2.3.50 Sample probe:
      • 13.2.3.51 Separator:
      • 13.2.3.52 Serum/Plasma Separator:
      • 13.2.3.53 Service envelope:
      • 13.2.3.54 Specimen:
      • 13.2.3.55 Specimen carrier//Sample carrier//Carrier:
      • 13.2.3.56 Specimen collection container//Specimen container//Sample container//Container:
      • 13.2.3.57 Specimen-positioning system//Sample-positioning system (SPS):
      • 13.2.3.58 Specimen probe//Sample probe:
      • 13.2.3.59 Stay clear zone:
      • 13.2.3.60 Symbol:
      • 13.2.3.61 Test mnemonics:
      • 13.2.3.62 Top of container//Top of tube:
      • 13.2.3.63 Top of tube:
      • 13.2.3.64 Tray:
      • 13.2.3.65 X-direction:
      • 13.2.3.66 Y-direction:
      • 13.2.3.67 Z-direction:
  • 13.3 TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 13.3.1 ESU/ACK - automated equipment status update (event U01)
    • 13.3.2 ESR/ACK - automated equipment status request (event U02)
    • 13.3.3 SSU/ACK - specimen status update (event U03)
    • 13.3.4 SSR/ACK - specimen status request (event U04)
    • 13.3.5 INU/ACK - automated equipment inventory update (event U05)
    • 13.3.6 INR/ACK - automated equipment inventory request (event U06)
    • 13.3.7 EAC/ACK - automated equipment command (event U07)
    • 13.3.8 EAR/ACK - automated equipment response (event U08)
    • 13.3.9 EAN/ACK - automated equipment notification (event U09)
    • 13.3.10 TCU/ACK - automated equipment test code settings update (event U10)
    • 13.3.11 TCR/ACK - automated equipment test code settings request (event U11)
    • 13.3.12 LSU/ACK - automated equipment log/service update (event U12)
    • 13.3.13 LSR/ACK - automated equipment log/service request (event U13)
  • 13.4 MESSAGE SEGMENTS
    • 13.4.1 EQU - equipment detail segment
      • 13.4.1.0 EQU field definitions
      • 13.4.1.1 EQU-1 Equipment instance identifier (EI) 01479
      • 13.4.1.2 EQU-2 Event date/time (TS) 01322
      • 13.4.1.3 EQU-3 Equipment state (CE) 01323
      • 13.4.1.4 EQU-4 Local/remote control state (CE) 01324
      • 13.4.1.5 EQU-5 Alert level (CE) 01325
    • 13.4.2 ISD - interaction status detail segment
      • 13.4.2.0 ISD field definitions
      • 13.4.2.1 ISD-1 Reference interaction number (NM) 01326
      • 13.4.2.2 ISD-2 Interaction type identifier (CE) 01327
      • 13.4.2.3 ISD-3 Interaction active state (CE) 01328
    • 13.4.3 SAC- specimen and container detail segment
      • 13.4.3.0 SAC field definitions
      • 13.4.3.1 SAC-1 External accession identifier (EI) 01329
      • 13.4.3.2 SAC-2 Accession identifier (EI) 01330
      • 13.4.3.3 SAC-3 Container identifier (EI) 01331
      • 13.4.3.4 SAC-4 Primary (parent) container identifier (EI) 01332
      • 13.4.3.5 SAC-5 Equipment container identifier (EI) 01333
      • 13.4.3.6 SAC-6 Specimen source (CM) 00249
      • 13.4.3.7 SAC-7 Registration date/time (TS) 01334
      • 13.4.3.8 SAC-8 Container status (CE) 01335
      • 13.4.3.9 SAC-9 Carrier type (CE) 01336
      • 13.4.3.10 SAC-10 Carrier identifier (EI) 01337
      • 13.4.3.11 SAC-11 Position in carrier (NA) 01338
      • 13.4.3.12 SAC-12 Tray type - SAC (CE) 01339
      • 13.4.3.13 SAC-13 Tray identifier (EI) 01340
      • 13.4.3.14 SAC-14 Position in tray (NA) 01341
      • 13.4.3.15 SAC-15 Location (CE) 01342
      • 13.4.3.16 SAC-16 Container height (NM) 01343
      • 13.4.3.17 SAC-17 Container diameter (NM) 01344
      • 13.4.3.18 SAC-18 Barrier delta (NM) 01345
      • 13.4.3.19 SAC-19 Bottom delta (NM) 01346
      • 13.4.3.20 SAC-20 Container diameter/height/delta units (CE) 01347
      • 13.4.3.21 SAC-21 Container volume (NM) 00644
      • 13.4.3.22 SAC-22 Available volume (NM) 01349
      • 13.4.3.23 SAC-23 Initial specimen volume (NM) 01350
      • 13.4.3.24 SAC-24 Volume units (CE) 01351
      • 13.4.3.25 SAC-25 Separator type (CE) 01352
      • 13.4.3.26 SAC-26 Cap type (CE) 01353
      • 13.4.3.27 SAC-27 Additive (CE) 00647
      • 13.4.3.28 SAC-28 Specimen component (CE) 01355
      • 13.4.3.29 SAC-29 Dilution factor (SN) 01356
      • 13.4.3.30 SAC-30 Treatment (CE) 01357
      • 13.4.3.31 SAC-31 Temperature (SN) 01358
      • 13.4.3.32 SAC-32 Hemolysis index (NM) 01359
      • 13.4.3.33 SAC-33 Hemolysis index units (CE) 01360
      • 13.4.3.34 SAC-34 Lipemia index (NM) 01361
      • 13.4.3.35 SAC-35 Lipemia index units (CE) 01362
      • 13.4.3.36 SAC-36 Icterus index (NM) 01363
      • 13.4.3.37 SAC-37 Icterus index units (CE) 01364
      • 13.4.3.38 SAC-38 Fibrin index (NM) 01365
      • 13.4.3.39 SAC-39 Fibrin index units (CE) 01366
      • 13.4.3.40 SAC-40 System induced contaminants (CE) 01367
      • 13.4.3.41 SAC-41 Drug interference (CE) 01368
      • 13.4.3.42 SAC-42 Artificial blood (CE) 01369
      • 13.4.3.43 SAC-43 Special handling considerations (CE) 01370
      • 13.4.3.44 SAC-44 Other environmental factors (CE) 01371
    • 13.4.4 INV - inventory detail segment
      • 13.4.4.0 INV field definitions
      • 13.4.4.1 INV-1 Substance identifier (CE) 01372
      • 13.4.4.2 INV-2 Substance status (CE) 01373
      • 13.4.4.3 INV-3 Substance type (CE) 01374
      • 13.4.4.4 INV-4 Inventory container identifier (CE) 01532
      • 13.4.4.5 INV-5 Container carrier identifier (CE) 01376
      • 13.4.4.6 INV-6 Position on carrier (CE) 01377
      • 13.4.4.7 INV-7 Initial quantity (NM) 01378
      • 13.4.4.8 INV-8 Current quantity (NM) 01379
      • 13.4.4.9 INV-9 Available quantity (NM) 01380
      • 13.4.4.10 INV-10 Consumption quantity (NM) 01381
      • 13.4.4.11 INV-11 Quantity units (CE) 01382
      • 13.4.4.12 INV-12 Expiration date/time (TS) 01383
      • 13.4.4.13 INV-13 First used date/time (TS) 01384
      • 13.4.4.14 INV-14 On board stability duration (TQ) 01385
      • 13.4.4.15 INV-15 Test/fluid identifier(s) (CE) 01386
      • 13.4.4.16 INV-16 Manufacturer lot number (ST) 01387
      • 13.4.4.17 INV-17 Manufacturer Identifier (CE) 00286
      • 13.4.4.18 INV-18 Supplier identifier (CE) 01389
    • 13.4.5 ECD - equipment command segment
      • 13.4.5.0 ECD field definitions
      • 13.4.5.1 ECD-1 Reference command number (NM) 01390
      • 13.4.5.2 ECD-2 Remote control command (CE) 01391
      • 13.4.5.3 ECD-3 Response required (ID) 01392
      • 13.4.5.4 ECD-4 Requested completion time (TQ) 01393
      • 13.4.5.5 ECD-5 Parameters (ST) 01394
    • 13.4.6 ECR - equipment command response segment
      • 13.4.6.0 ECR field definitions
      • 13.4.6.1 ECR-1 Command response (CE) 01395
      • 13.4.6.2 ECR-2 Date/time completed (TS) 01396
      • 13.4.6.3 ECR-3 Command response parameters (ST) 01397
    • 13.4.7 NDS - notification detail segment
      • 13.4.7.0 NDS field definitions
      • 13.4.7.1 NDS-1 Notification reference number (NM) 01398
      • 13.4.7.2 NDS-2 Notification date/time (TS) 01399
      • 13.4.7.3 NDS-3 Notification alert severity (CE) 01400
      • 13.4.7.4 NDS-4 Notification code (CE) 01401
    • 13.4.8 CNS - clear notification segment
      • 13.4.8.0 CNS field definitions
      • 13.4.8.1 CNS-1 Starting notification reference number (NM) 01402
      • 13.4.8.2 CNS-2 Ending notification reference number (NM) 01403
      • 13.4.8.3 CNS-3 Starting notification date/time (TS) 01404
      • 13.4.8.4 CNS-4 Ending notification date/time (TS) 01405
      • 13.4.8.5 CNS-5 Starting notification code (CE) 01406
      • 13.4.8.6 CNS-6 Ending notification code (CE) 01407
    • 13.4.9 TCC - test code configuration segment
      • 13.4.9.0 TCC field definitions
      • 13.4.9.1 TCC-1 Universal service Identifier (CE) 00238
      • 13.4.9.2 TCC-2 Equipment test application identifier (EI) 01408
      • 13.4.9.3 TCC-3 Specimen source (CM) 00249
      • 13.4.9.4 TCC-4 Auto-dilution factor default (SN) 01410
      • 13.4.9.5 TCC-5 Rerun dilution factor default (SN) 01411
      • 13.4.9.6 TCC-6 Pre-dilution factor default (SN) 01412
      • 13.4.9.7 TCC-7 Endogenous content of pre-dilution diluent (SN) 01413
      • 13.4.9.8 TCC-8 Inventory limits warning level (NM) 01414
      • 13.4.9.9 TCC-9 Automatic rerun allowed (ID) 01415
      • 13.4.9.10 TCC-10 Automatic repeat allowed (ID) 01416
      • 13.4.9.11 TCC-11 Automatic reflex allowed (ID) 01417
      • 13.4.9.12 TCC-12 Equipment dynamic range (SN) 01418
      • 13.4.9.13 TCC-13 Units (CE) 00574
      • 13.4.9.14 TCC-14 Processing type (CE) 01419
    • 13.4.10 TCD - test code detail segment
      • 13.4.10.0 TCD field definitions
      • 13.4.10.1 TCD-1 Universal service Identifier (CE) 00238
      • 13.4.10.2 TCD-2 Auto-dilution factor (SN) 01420
      • 13.4.10.3 TCD-3 Rerun dilution factor (SN) 01421
      • 13.4.10.4 TCD-4 Pre-dilution factor (SN) 01422
      • 13.4.10.5 TCD-5 Endogenous content of pre-dilution diluent (SN) 01413
      • 13.4.10.6 TCD-6 Automatic repeat allowed (ID) 01416
      • 13.4.10.7 TCD-7 Reflex allowed (ID) 01424
      • 13.4.10.8 TCD-8 Analyte repeat status (CE) 01425
    • 13.4.11 SID - substance identifier segment
      • 13.4.11.0 SID field definitions
      • 13.4.11.1 SID-1 Application / method identifier (CE) 01426
      • 13.4.11.2 SID-2 Substance lot number (ST) 01129
      • 13.4.11.3 SID-3 Substance container identifier (ST) 01428
      • 13.4.11.4 SID-4 Substance manufacturer identifier (CE) 01429
    • 13.4.12 EQP - equipment log/service segment
      • 13.4.12.0 EQP field definitions
      • 13.4.12.1 EQP-1 Event type (CE) 01430
      • 13.4.12.2 EQP-2 File name (ST) 01431
      • 13.4.12.3 EQP-3 Start date/time (TS) 01202
      • 13.4.12.4 EQP-4 End date/time (TS) 01432
      • 13.4.12.5 EQP-5 Transaction data (FT) 01433
  • 13.5 NOTES REGARDING USAGE
    • 13.5.1 Other required original HL7 messages
    • 13.5.2 Transfer of laboratory test orders and results
    • 13.5.3 Transfer of QC results
    • 13.5.4 Query for order information - triggers for download of test orders
    • 13.5.5 Transfer of additional information for automated processing
    • 13.5.6 Laboratory order message
    • 13.5.7 Unsolicited laboratory observation message
    • 13.5.8 Automated equipment status update
    • 13.5.9 Automated equipment status request
    • 13.5.10 Specimen status update
    • 13.5.11 Specimen status request
    • 13.5.12 Automated equipment inventory update
    • 13.5.13 Automated equipment inventory request
    • 13.5.14 Automated equipment command
    • 13.5.15 Automated equipment response
    • 13.5.16 Automated equipment notification
    • 13.5.17 Automated equipment test code settings update
    • 13.5.18 Automated equipment test code settings request
    • 13.5.19 Automated equipment log/service update
    • 13.5.20 Automated equipment log/service request
  • 13.6 OUTSTANDING ISSUES

HL7 V2.4 Chapter 14

• 14 .Application Management
  • 14.1 CHAPTER 14 CONTENTS
  • 14.2 INTRODUCTION
  • 14.3 APPLICATION MANAGEMENT TRIGGER EVENTS AND MESSAGE DEFINITIONS
    • 14.3.1 NMQ - application management query message (event N01)
      • 14.3.1.1 QRD use notes
    • 14.3.2 NMD - application management data message (event N02)
  • 14.4 MESSAGE SEGMENTS
    • 14.4.1 NCK - system clock segment
      • 14.4.1.0 NCK field definitions
      • 14.4.1.1 NCK-1 System date/time (TS) 01172
      • 14.4.1.2 NCK use notes
    • 14.4.2 NSC - Application status change segment
      • 14.4.2.0 NSC field definitions
      • 14.4.2.1 NSC-1 Application change type (IS) 01188
      • 14.4.2.2 NSC-2 Current CPU (ST) 01189
      • 14.4.2.3 NSC-3 Current fileserver (ST) 01190
      • 14.4.2.4 NSC-4 Current application (HD) 01191
      • 14.4.2.5 NSC-5 Current facility (HD) 01192
      • 14.4.2.6 NSC-6 New CPU (ST) 01193
      • 14.4.2.7 NSC-7 New fileserver (ST) 01194
      • 14.4.2.8 NSC-8 New application (HD) 01195
      • 14.4.2.9 NSC-9 New facility (HD) 01196
      • 14.4.2.10 NSC use notes
    • 14.4.3 NST - Application control-level statistics segment
      • 14.4.3.0 NST field definitions
      • 14.4.3.1 NST-1 Statistics available (ID) 01173
      • 14.4.3.2 NST-2 Source identifier (ST) 01174
      • 14.4.3.3 NST-3 Source type (ID) 01175
      • 14.4.3.4 NST-4 Statistics start (TS) 01176
      • 14.4.3.5 NST-5 Statistics end (TS) 01177
      • 14.4.3.6 NST-6 Receive character count (NM) 01178
      • 14.4.3.7 NST-7 Send character count (NM) 01179
      • 14.4.3.8 NST-8 Messages received (NM) 01180
      • 14.4.3.9 NST-9 Messages sent (NM) 01181
      • 14.4.3.10 NST-10 Checksum errors received (NM) 01182
      • 14.4.3.11 NST-11 Length errors received (NM) 01183
      • 14.4.3.12 NST-12 Other errors received (NM) 01184
      • 14.4.3.13 NST-13 Connect timeouts (NM) 01185
      • 14.4.3.14 NST-14 Receive timeouts (NM) 01186
      • 14.4.3.15 NST-15 Application control-level errors (NM) 01187
      • 14.4.3.16 NST use notes
  • 14.5 OUTSTANDING ISSUES

HL7 V2.4 Chapter 15

• 15 .Personnel Management
  • 15.1 CHAPTER 15 CONTENTS
  • 15.2 PURPOSE
    • 15.2.1 Usage of chapter 15 vs. chapter 8
  • 15.3 TRIGGER EVENTS AND MESSAGE DESCRIPTIONS
    • 15.3.1 PMU/ACK - Add personnel record (event B01)
    • 15.3.2 PMU/ACK - Update personnel record (event B02)
    • 15.3.3 PMU/ACK - Delete personnel record (event B03)
    • 15.3.4 PMU/ACK - Activate practicing person (event B04)
    • 15.3.5 PMU/ACK - Deactivate practicing person (event B05)
    • 15.3.6 PMU/ACK - Terminate practicing person (event B06)
    • 15.3.7 QBP/RSP - Query information (event Q25/K25)
  • 15.4 MESSAGE SEGMENTS
    • 15.4.1 AFF - Professional affiliation segment
      • 15.4.1.0 AFF field definitions
      • 15.4.1.1 AFF-1 Set ID - AFF- (SI) 01427
      • 15.4.1.2 AFF-2 Professional organization (XON) 01444
      • 15.4.1.3 AFF-3 Professional organization address (XAD) 01445
      • 15.4.1.4 AFF-4 Professional organization affiliation date range (DR) 01446
      • 15.4.1.5 AFF-5 Professional affiliation additional information (ST) 01447
    • 15.4.2 EDU - Educational detail segment
      • 15.4.2.0 EDU field definitions
      • 15.4.2.1 EDU-1 Set ID - EDU (SI) 01448
      • 15.4.2.2 EDU-2 Academic degree (IS) 01449
      • 15.4.2.3 EDU-3 Academic degree program date range (DR) 01597
      • 15.4.2.4 EDU-4 Academic degree program participation date range (DR) 01450
      • 15.4.2.5 EDU-5 Academic degree granted date (DT) 01451
      • 15.4.2.6 EDU-6 School (XON) 01452
      • 15.4.2.7 EDU-7 School type code (CE) 01453
      • 15.4.2.8 EDU-8 School address (XAD) 01454
    • 15.4.3 LAN - Language detail segment
      • 15.4.3.0 LAN field definitions
      • 15.4.3.1 LAN-1 Set ID - LAN (SI) 01455
      • 15.4.3.2 LAN-2 Language code (CE) 01456
      • 15.4.3.3 LAN-3 Language ability code (CE) 01457
      • 15.4.3.4 LAN-4 Language proficiency code (CE) 01458
    • 15.4.4 ORG - Practitioner organization unit segment
      • 15.4.4.0 ORG field definitions
      • 15.4.4.1 ORG-1 Set ID - ORG (SI) 01459
      • 15.4.4.2 ORG-2 Organization unit code (CE) 01460
      • 15.4.4.3 ORG-3 Organization unit type code (CE) 01625
      • 15.4.4.4 ORG-4 Primary org unit indicator (ID) 01462
      • 15.4.4.5 ORG-5 Practitioner org unit identifier (CX) 01463
      • 15.4.4.6 ORG-6 Health care provider type code (CE) 01464
      • 15.4.4.7 ORG-7 Health care provider classification code (CE) 01614
      • 15.4.4.8 ORG-8 Health care provider area of specialization code (CE) 01615
      • 15.4.4.9 ORG-9 Effective date range (DR) 01465
      • 15.4.4.10 ORG-10 Employment status code (CE) 01276
      • 15.4.4.11 ORG-11 Board approval indicator (ID) 01467
      • 15.4.4.12 ORG-12 Primary care physician indicator (ID) 01468
    • 15.4.5 PRA - Practitioner detail segment
      • 15.4.5.0 PRA field definitions
      • 15.4.5.1 PRA-1 Primary key value - PRA (CE) 00685
      • 15.4.5.2 PRA-2 Practitioner group (CE) 00686
      • 15.4.5.3 PRA-3 Practitioner category (IS) 00687
      • 15.4.5.4 PRA-4 Provider billing (ID) 00688
      • 15.4.5.5 PRA-5 Specialty (CM) 00689
      • 15.4.5.6 PRA-6 Practitioner ID numbers (CM) 00690
      • 15.4.5.7 PRA-7 Privileges (CM) 00691
      • 15.4.5.8 PRA-8 Date entered practice (DT) 01296
      • 15.4.5.9 PRA-9 Institution (CE) 01613
      • 15.4.5.10 PRA-10 Date left practice (DT) 01348
      • 15.4.5.11 PRA-11 Government reimbursement billing eligibility (CE) 01388
      • 15.4.5.12 PRA-12 Set ID - PRA (SI) 01616
    • 15.4.6 STF - Staff identification segment
      • 15.4.6.0 STF field definitions
      • 15.4.6.1 STF-1 Primary key value - STF (CE) 00671
      • 15.4.6.2 STF-2 Staff ID code (CX) 00672
      • 15.4.6.3 STF-3 Staff name (XPN) 00673
      • 15.4.6.4 STF-4 Staff type (IS) 00674
      • 15.4.6.5 STF-5 Administrative sex (IS) 00111
      • 15.4.6.6 STF-6 Date/time of birth (TS) 00110
      • 15.4.6.7 STF-7 Active/inactive flag (ID) 00675
      • 15.4.6.8 STF-8 Department (CE) 00676
      • 15.4.6.9 STF-9 Hospital service - STF (CE) 00677
      • 15.4.6.10 STF-10 Phone (XTN) 00678
      • 15.4.6.11 STF-11 Office/home address (XAD) 00679
      • 15.4.6.12 STF-12 Institution activation date (CM) 00680
      • 15.4.6.13 STF-13 Institution inactivation date (CM) 00681
      • 15.4.6.14 STF-14 Backup person ID (CE) 00682
      • 15.4.6.15 STF-15 E-mail address (ST) 00683
      • 15.4.6.16 STF-16 Preferred method of contact (CE) 00684
      • 15.4.6.17 STF-17 Marital status (CE) 00119
      • 15.4.6.18 STF-18 Job title (ST) 00785
      • 15.4.6.19 STF-19 Job code/class (JCC) 00786
      • 15.4.6.20 STF-20 Employment status code (CE) 01276
      • 15.4.6.21 STF-21 Additional insured on auto (ID) 01275
      • 15.4.6.22 STF-22 Driver's license number - staff' (DLN) 01302
      • 15.4.6.23 STF-23 Copy auto ins (ID) 01229
      • 15.4.6.24 STF-24 Auto ins expires (DT) 01232
      • 15.4.6.25 STF-25 Date last DMV review (DT) 01298
      • 15.4.6.26 STF-26 Date next DMV review (DT) 01234
      • 15.4.6.27 STF-27 Race (CE) 00113
      • 15.4.6.28 STF-28 Ethnic group (CE) 00125
      • 15.4.6.29 STF-29 Re-activate approval indicator (ID) 01596
  • 15.5 EXAMPLE TRANSACTIONS
    • 15.5.1 Add personnel record - event B01
  • 15.6 OUTSTANDING ISSUES

HL7 V2.4 Appendix A

• A .Data Definition Tables
  • A.1 APPENDIX A CONTENTS
  • A.2 INTRODUCTION
  • A.3 MESSAGE TYPES
  • A.4 SEGMENTS
  • A.5 HL7 AND USER-DEFINED TABLES - ALPHABETIC SORT
  • A.6 HL7 AND USER-DEFINED TABLES - NUMERIC SORT
  • A.7 DATA ELEMENT NAMES

HL7 V2.4 Appendix B

• B. Lower Layer Protocols

HL7 V2.4 Appendix C

• C .Version 2.4 BNF Message Descriptions
  • C.1 APPENDIX C CONTENTS
  • C.2 BNF DESCRIPTIONS OF HL7 VERSION 2.4 ABSTRACT MESSAGES
    • C.2.1 Overview
    • C.2.2 Tokens
      • C.2.2.1 Terminators
      • C.2.2.2 Segments
        • C.2.2.2.1 Control/query
        • C.2.2.2.2 Master files
        • C.2.2.2.3 Patient administration
        • C.2.2.2.4 Financial information
        • C.2.2.2.5 Orders/Observations
    • C.2.3 BNF Message Definitions

HL7 V2.4 Appendix D

• D .
  Glossary