HL7 - Version 2.3.1 Final Std.


Back Nach oben

Changes to the Final Standard V.2.3.1

Most of the chapters contain internal information ("properties") saying that it is Version 2.3.2 and chapter 3.

Corrections to the documents due to parsing process

Most of these changes will be done when the documents appear an CD.

Chapter 2

2.8.52.2: Table 0202 ?
2.11.1: WRF,WRQ,WRP: apply style "Msg Table Header Example"
2.13.1: ACK: apply style "Msg Table Header Example"
2.13.2: MCF: apply style "Msg Table Header Example"

Chapter 3

3.2.19: A19: delete blanks
3.3.1: EVN: move index entries to the end of the line
3.3.7: NPU: dto.
3.3.8: MRG: dto.
3.3.10: DB1: dto.

Chapter 4

4.3.1: apply style "Attribute Table ..."
Segment ORC: no ascending number in first column
4.5.1.15: table 0163: apply style "HL7 Table Caption"
4.5.1.25: apply style "HL7 Table Header"
4.8.18: RAR: index entries at the end of line
4.8.19: R0R: dto.
4.8.20: RER: dto.
4.8.21: RGR: dto.
4.11: Figure 4-20: "Other Table Header"

Chapter 5

ok

Chapter 6

ok

Chapter 7

7.3.1: no leading blanks
7.3.2: OBX-5: no footnotes within the segment tables
7.18.4: OBX "segment" ==> "attributes"

Chapter 8

8.7.6.3 apply style "HL7 Table Header"
8.4.3 apply style "Attribute Table Header"

Chapter 9

Chapter 10

10.4.3: Table 0048: where is it used?

Chapter 11

ok

Chapter 12

12.2.11: QRY^PCK: define event PCK

Appendix C

NMQ, NMR, NMD: assigned events?

Corrections due to extraction of table values

Chapter 2

table 0290 (MIME base64 encoding characters): define values in separate columns

Corrections due to internal consistency

assign new descriptions:
GT1-46: 00749 => Contact Person's Telephone Number
GT1-32+IN2-45: 00783 => Employment Stop Date
CM0-2: 01011 => Sponsor Study Identifier

Assign new data element IDs:

CTD-1: Contact Role => 00196

assign new data type and length:

STF-17: 00119 => CE + 80

Assign new length

NK1-7: 00196 => 200
OBR-16: 00226 => 120
OBX-2, OM3-7: 00570: => 2

Corrections to data element description due to typing errors

OBR-3: 00217 (2 times) => Filler Order Number
OBX-4: 00569 (4 times) => Set ID - OBX
OBR-6: 00240 (2 times) => Requested Date/Time
OBR-29: 00261 => Parent
OBR-5: 00239 => Priority
RXE-21: 00330 => Pharmacy/Treatment Supplier's Special Dispensing Instructions
OM6-1: 00586 => Sequence Number - Test/Observation Master File
EQL-2, SPR-2: 00697 => Query/Response Format Code
CTI-1: 01011 => Sponsor Study ID
RXA-21: 01224 => Action Code

Corrections to table descriptions

ch.9.5.1.3: 0191 => Type of referenced data
ch.12: 0003 => Event type

Table 0003:

Is defined in chapter 2 and 12, but some events are declared with different message types: (must be corrected in chapter 2.24.1.9)

PC4: PRQ => QRY
PC9: PGQ => QRY
PCA: PGR => PPV
PCE: PTQ => QRY
PCK: PTU => QRY
PCL: PTV => PPT
QO4: instead of Q04 (Zero instead of "ooooh")

Table 0256

8.7.3.45: 30 minutes post challenge => value 30M

Table 0191 (ch.2.8.36.3 + 9.5.1.3)

image data: IM vs. Image
other application data: AP vs. Application
audio data: AU vs. Audio
machine readable text document: TEXT
structured generalized markup language: SGML

Inconsistent Attribute Tables

Apply the proposed change on the underlined parts:

Segment Data element Description Change
OBR-3 00217 Filler Order Number + Delete
OBX-2 00570 Value Type Delete
CTI-1 01011 Sponsor Study Identifier
=> Sponsor Study ID
Change
GT1-32 00783 Guarantor Employment Stop Date Delete
IN2-45 00783 Insuredīs Employment Stop Date Delete
GT1-46 00749 Contact Personīs Telephone Number Insert
CTD-1

01156
=> 00196

Contact Role Change
OBR-1 00237 Set ID - OBR Delete
OBX-1 (4x) 00569 Set ID - Observational Simple
=> Set ID - OBX
Change
OBR-6 00240 Requested Date/tTme Change to i
OBX-1 00569 Set ID- OBX Insert blank before "-"
TXA-1 00914 Set ID- TXA Insert blank before "-"
CM2-1 01024 Set ID- CM2 Insert blank before "-"
OBX-7 00575 References Range Insert
OBR-5 00239 Priority - OBR Insert
OBR-29 00261 Parent * Delete
OBX-11 (5x) 00579 Observ Result Status
=> Observation
Change
OBX-14 00582 Date/Time of the Observation Insert
OM6-1 00586 Sequence Number - Test/Observation Master File Insert blank behind "-"
VTQ-2 00697 Query/ Response Format Code Insert blank behind "/"
STF-17 00119 Marital Status Data type IS -> CE
Length 1 -> 80
OBX-16 00584 Responsible Observer Data type CN -> XCN (4x)
Length 60 -> 80 (5x)
OBX-5 00573 Observation Value Length -> 65536 (2x)
Data Type -> * (4x)
NK1-7 00196 Contact Role Length 60 -> 200
OBR-16 00226 Ordering Provider Length 80 -> 120
OBR-26 00259 Parent Result + Length 400 -> 200
OBX-1 00569 Set ID - OBX Length 10 -> 4
OBX-8 00576 Abnormal Flags Length 10 -> 5
OBX-10 00578 Nature of Abnormal Test Length 5 -> 2
OBX-11 00579 Observation Result Status Length 2 -> 1
OBX-17 00936 Observation Method Length 60 -> 80 (2x)
OBX-2 00570 Value Type Length 3 -> 2 (2x)
RGS-2 00763 Segment Action Code Refer to table 0206
RXG-21
RXD-20
01131 Substance Manufacturer Name Refer to table 0227
OBX-9 00577 Probability Repetitions: Y/5 (3x)
OBX-10 00578 Nature of Abnormal Test Repetitions N
PID-6
(GT1-42,
IN2-40,
NK1-26)
00746
=> 00109
Motherīs Maiden Name Duplicate with different data element Ids but the same data type and length
OBX-5
OBX-8
OBX-16
OBX-17
    Repeatable or not?
    Message type "R0R" vs. "ROR"  
    Table 0003 event type:
This table is listed twice: in chapter 2 and 12. The information for the events in chapter 12 are listed in chapter 2 with wrong message types.
Compare with the messages in chapter 12.
    Within the message description for I01 the event code is mistyped two times. Rename I0I into I01 in chapter 11.
    Within the message description for I07 the event code is mistyped. Rename 107 into I07 in chapter 11.
    Event R0R vs. ROR
Message Type ROR vs. R0R
Check correctness
OBR-45 01316 Chapter 7.3.1.45: wrong table referenced Change to User-defined table 0340 - Procedure code modifier
MSH-9 00009 Message type Refer also to table 0354 in MSH attributes
OM1-44 00939 Challenge information A structured text field?
LCH-5 01294 Location characteristic value Is of data type CE, but refers to three different tables according to the value of LCH-4.

Therefor a special data structure is defined to maintain a reference that these tables are used.

    Family name within data type CN According to other data types this component should also have a second sub-component "last name prefix"

New data fields for segments

Segment data element description chapter
ORC-20 01310 Advanced Beneficiary Notice Code 4.3.1.20
ORC-21 01311 Ordering Facility Name 4.3.1.21
ORC-22 01312 Ordering Facility Address 4.3.1.22
ORC-23 01313 Ordering Facility Phone Number 4.3.1.23
ORC-24 01314 Ordering Provider Address 4.3.1.24

Missing Table declarations

Missing Table declarations (not in form of a separate table) out of the segment descriptions:

ID Description
0005 Race
0006 Religion
0010 Physician ID
0018 Patient Type
0019 Anesthesia Code
0021 Bad Debt Agency Code
0022 Billing Status
0024 Fee Schedule
0032 Charge/Price Indicator
0042 Company Plan Code
0044 Contract Code
0045 Courtesy Code
0046 Credit Rating
0049 Department Code
0050 Accident Code
0051 Diagnosis Code
0053 Diagnosis Coding Methed
0055 Diagnostic Related Group
0056 DRG Grouper Review Code
0059 Consent Code
0063 Relationship
0064 Financial Class
0066 Employment Status
0068 Guarantor Type
0069 Hospital Service
0072 Insurance Plan ID
0073 Interest Rate Code
0084 Performed By Code
0086 Plan Type
0087 Preadmit Test Indicator
0088 Procedure Code
0089 Procedure Coding Method
0092 Re-admission Indicator
0099 VIP Indicator
0110 Transfer to Bad Debt Code
0111 Delete Account Code
0113 Discharged to Location
0114 Diet Type
0115 Servicing Facility
0116 Bed status
0117 Account Status
0118 Major Diagnostic Category
0129 Accommodation Code
0130 Visit User Code
0131 Contact Role
0132 Transaction Code
0139 Employer Information Data
0143 Non-covered Insurance Code
0151 Second Opinion Status
0152 Second Opinion Documentation Received
0171 Citizenship
0172 Veterans Military Status
0182 Staff Type
0184 Department
0186 Practioner Category
0188 Operator ID
0189 Ethnic Group
0212 Nationality
0214 Special Program Codes
0215 Publicity Code
0216 Patient Status Code
0217 Visit Priority Code
0218 Patient Charge Adjustment Code
0219 Recurring Service Code
0222 Contact Reason
0233 Non-concur Code/Description
0244 Single Use Device
0245 Product Problem
0246 Product Available For Inspection
0249 Generic Product
0285 Insurance company ID codes
0289 County Code
0293 Billing Category
0295 Handicap
0296 Primary Language
0311 Job Status
0312 Policy Scope
0313 Policy Source
0319 Department Cost Center
0320 Item Natural Account Code
0327 Job Code/Class
0328 Employee Classification
0340 Procedure Code Modifier
0342 Dependent Of Military Recipient
0343 Military Handicapped Program
0345 Appeal Reason
0346 Certification Agency
0347 Auto Accident State
0358 Practitioner Group
0361 Sending/receiving application
0362 Sending/receiving facility

Missing Table declarations (not in form of a separate table) out chapter 2:

ID Description
0288 Census Tract
0297 CN ID source
0300 Namespace ID
0302 Point Of Care
0303 Room
0304 Bed
0305 Person Location Type
0306 Location Status
0307 Building
0308 Floor
0335 Repeat Pattern
0363 Assigning Authority

Define message structure identifier in order to reduce the amount of work:

Message structure ID Chapter
SRM_S01 10
SRR_S01 10
ACK_S12 10
SIU_S12 10
ACK_PC6 12
PGL_PC6 12
ACK_PCG 12
PPG_PCG 12
ACK_PCB 12
PPP_PCB 12
ACK_PC1 12
PPR_PC1 12
PEX_P07 12
MFK_M01 8
MFN_M01 8
MFQ_M01 8
MFR_M01 8
RFI_I12 11
RQA_I08 11
CSU_C09 7
CRM_C01 7

Changes to the message definitions. Sometimes in the left column some words are used which are not a legal segment name. For any Z-segment use "Z.." and for any HL7 defined segment use "?":

Chapter Event Annotation
8.3.3 M01  
8.7.2 M03 Use "?" in the left column as wildcard for any other segment
12.2.1 PC6 Delete "etc." form the left column
12.2.2 PC1 Dto.
12.2.3 PCB Dto.
12.2.4 PCG Dto.
12.2.7 PC5 Dto.
12.2.8 PCA Dto.
12.2.10 PCF Dto.
12.2.12 PCL Dto.

Message Definitions

Corrections to the message definition

Chapter Event Correction
12.2.8 PCA "[{NTE]}" => "[{NTE}]" (last occurence of NTE)
12.2.10 PCF "{NTE]}" => "[{NTE}]" (3rd occurence of NTE)
12.2.12 PCL Move "}]" from the second to the first column
12.2.1 PC6 "[{VAR}]}2 => "[{VAR}]"
11.3.1 I08 Move "]" from the second to the first column (in the middle of the message)
11.4.1 I12
(RQA)
Move "]" from the second to the first column (in the middle of the message)
11.4.1 I12
(RRI)
Move "]" from the second to the first column (in the middle of the message)
8.8.3 M01
(MFR)
Closing bracket behind segment QAK must be "]"

Modifications to the data types:

Chapter Data Type Correction
2.8.4 CF Identifier is of the same data type like it is for CE: ST
2.8.17 EI 2nd components refers to table 0300 "namespace ID"

Wrong indices within the documents:

Chapter Corrections to index entry
2.8.8 CE => CNE
2.8.11 CE => CWE
2.8.13 No index entry for DLN
2.8.14 No index entry for DR
2.8.16 Invalid index entry for ED
2.8.22 ID => IS
2.8.23 No index entry for JCC
2.8.30 No index entry for PPN
2.8.31 No index entry for PT
2.8.32 No index entry for QIP
2.8.33 No index entry for QSC
2.8.34 No index entry for RCD
2.8.35 No index entry for RI
2.8.46 No index entry for VH
2.8.47 No index entry for VID
2.8.51.x Format as level 4 title

Last Update : 17 Januar 2000