DFT_P03DFT_P11REF_I12 (2x)RSP_Z86 (2x)SRM_S01 (6x)SRR_S01 (3x)11.5.1: "PATIENT VISIT" => "PATIENT_VISIT" (underscore!)
HL7 - Version 2.5 Final StandardSuggested Corrections to the Standard Documents |
In order to provide the original standard in a database, several changes to the official documents are required. These changes are introduced as proposals for the next release of HL7 v2.6.
The "errors" listed in this section are identified before issuing the final version of the standard.
This list represents they "typos" in a layout sense and are corrected within the provided final documents. Some of them are almost invisible to the reader:
| Section | Correction |
|---|---|
| 2.5.3.3 | use "Normal Indented" for the definition |
| 2.5.16 | FHS: attribute table contains empty row |
| 2.10.2.3 | assign "Other table" style (2 times) |
| 2.15.9.17 | MSH-17 Country code: separate paragraph above and use style "HL7 Table Caption" |
| 2.A.9 | wrong index information in heading |
| 2.A.9.8 | User-defined Table => apply correct style for header |
| 2.A.12 | CSU.1 length "6 0" => "60" |
| 2.A.80 | VH.3 + VH.4: wrong numbering of components |
| 3.6.4.5 | Figure 3-2: uses style "Other Table Caption" => "Standard" |
| 3.6.4.8 | Figure 3-6: uses style "User Table Caption" => "Standard" (2 times) |
| 4.22 | style "Attribute Table Caption" is used instead of "Standard" |
| 5.3.2.3 | RCP in message table uses wrong style (AttributeTableCaption => MsgTableBody) |
| 5.2.4 | style "Attribute Table Caption" is used instead of "Standard" |
| 5.2.4 | furthermore, HL7 Table Caption is used instead of "Other Table Body" |
| 6.5.5 | GT1-55: attribute table contains empty row |
| 6.5.12 | ABS: below the table is an invisible paragraph "Attribute Table Caption" => index information moved upwards and paragaph deleted |
| 7.4.3.4 | introduce HL7 table 0487 specimen type |
| 7.4.3.22 | Table 0491: use style "User Table Caption" |
| 7.4.3.24 | Table uses wrong styles |
| 7.12.2.22 | wrong use of apostrophes! |
| 7.16.6 | OBX wrong caption (missing "-") |
| 8.9.3.4 | table 0324: use style User Table Caption |
| 8.10.2.1 | table 0268: use style User Table Caption |
| 8.10.2.9 | introduce user table 0463 Inventory Number: use style User Table Caption |
| 9.9.4 | CON-18: no prefix "HL7 table" |
| 13.4.3.28 | table 0372: use style "User Table Caption" |
| 13.4.3.40 | table 0374: use style "User Table Caption" |
| 13.4.3.42 | table 0375: use style "User Table Caption" |
| 13.4.3.44 | table 0377: use style "User Table Caption" |
| 13.4.5.2 | table 0368: use style "User Table Caption" |
| 13.4.6.1 | table 0387: use style "User Table Caption" |
This part identifies the required changes as they are applied to the contents of the database. They are not done within the standard documents and need correction in the next release. This list has been submitted to the proposal database before the Memphis Working Group Meeting in September 2003.
| Section | Correction |
|---|---|
| 3.5.4.11 | NK1-11: delete table information for Job Code/Class (it is done via component definition!) |
| 4.14.4.2 | RXE-2: can only assign one table for CE (proposal: introduce new field) |
| 4 + 7 | OBX-8: Abnormal Flags: Datatype "ID" or "IS"? => "IS" 7.4.2.5 |
| 6.5.9.4 | table 0347 "Auto Accident State" => "State/Province" |
| 7.16.x | delete example tables for OBX from data resp. mark them as examples in document |
| 8.8.8.44 | OM1-44 delete assigned tables 0256 and 0257 (proposal: define specific data type instead of TX!) |
| 8.9.3.5 | LCH-5: split into 3 different fields! (=proposal) (therefore the assigned tables are deleted!) |
| 9.6.2.5 | set OBX-5 data type to "varies" instead of "*" and length from 0 to 99999 |
| 9.6.2.8 | set OBX-8 data type to "IS", it is a user-defined table |
| 9.6.2.12 | set OBX-12 from "Date Last Observation Normal Values" to "Effective Date of Reference Range" |
This part of the list identifies all changes which are necessary for the preparing the database. They are detected after publication of the final standard and must therefore be submitted as proposals for the next release.
It includes the contents of 1.b).
Some of these changes have been applied to the documents and are submitted to the editors therefore.
Again, there are some formatting issues:
| Section | Correction |
|---|---|
| 2.5.3.4 | introduce "-" in middle column of table for "withdrawn" elements |
| 2.7.6 | use "Other table body" as style for table |
| 2.12.4.0 | use "Standard" as style for image |
| 4.16 4.22 |
redraw as Word Image for HTML file usage |
| 4.23 | re-order table 0119 to make description 2nd column |
| 3.6.4.8 | use "Word Images" |
| 11.3.7 | in ACK message style Index4 is used instead of MsgTableBody |
| 13.2.3.25 | reformat as image within a text row |
| 13.4.4 | reformat as image within a text row |
Of course, there are some content issues I cannot change for my own. They require a checking and correction by the corresponding TC.
| Section | Correction |
|---|---|
| 1 | check and adjust names and addresses of editors |
| 5.9.1.1 | define message structure identifiers for message |
| 5.10.x.y | define message structure identifiers for all messages |
| 8.9.1 | check repetitionality of LDP |
Beside that the content issues which need an investigation by the TC, there are also a few I believe have to correct directly because they obviously can't be true. I have selected those changes which require the fewest amount of changes and maintain the original intend.
| Section | Correction |
|---|---|
| 3.3.31 | Procedure group: ROL segment has one closing bracket ("]") too much |
| 3.3.31 | Insurance group: rearrangement of opening and closing brackets |
| 4.13.15 | NTE in R0R_R0R has a closing bracket too much |
| 4.13.7 | groupname: ORDER_DETAIL+SUPPLEMENT => ORDER_DETAIL_SUPPLEMENT |
| 5.4.x | delete wrong information from message structure |
| 5.7.3.1 5.9.2.4 13.3.3 3.3.57 |
re-order brackets ("{ [" => "[ {") |
| 5.7.3.1 | wrong naming convention for group names (underscore at wrong place) |
| 5.7.3.1 | PV2 closing bracket too much |
| 5.9.1.1.1 | RSP_Z82: PV1 is not an optional segment |
| 5.9.1.1.2 | RSP_Z86: AL1 is an optional and repetitional segment |
| 5.9.2.4 | PV2 closing bracket too much |
| 5.9.3.1.1 | Z91: result message is Z92, but not Z94 |
| 6.4.3 | P03: one closing bracket to much for NTE |
| 6.4.9 | P12: wrong use of styles for PR1 |
| 8.9.1 | define correct and complete message MFR_M05 instead of fragments for replacement |
| 8.10.1 | ditto. for MFR_M04 |
| 8.11.1 | ditto. for MFR_M06 (check brackets) and MFR_M07 |
| 9.5.2 9.5.4 9.5.6 9.5.8 9.5.10 |
groupname is missing, because opening bracket was on same row as OBX |
| 10.4 | ACK: bracket for SFT are wrong |
| 11.4.1 | RQA_I08: GT1 segment: one opening bracket too much |
| 12.3.6 | PRR_PC5: message structure aroung OBR is wrong (misuse of angle brackets) |
This section introduces all changes which have been identified after the Working Group Meeting in Memphis in September 2003.
Once more, there are a few more layout issues.
| Section | Correction |
|---|---|
| 7.3.1 7.3.2 7.3.3 7.3.7 7.3.9 7.7.2 7.11.2 |
a lot of "Hidden" paragraphs (style) in the message table => convert to "Msg Table Body" |
Again, some contents issues:
| Section | Correction |
|---|---|
| 4.13 | define Conformance Statement Header for Queries Q26 to Q30 |
| 7.3.3 | Groupname QUERY_RESPNSE => QUERY_RESPONSE |
| 8.13.1 | structure MFD_MFA as used in example is not defined! |
| 11.4.1 | I08: AUTHORIZATION group 2 times! => AUTHORIZATION_1 and AUTHORIZATION_2 |
| 12.3.1 12.3.2 12.3.3 12.3.4 12.3.6 12.3.8 12.3.10 12.3.12 |
introduce segment "Hxx" for any HL7 defined segment (there is an empty cell in the segment column) |
| 14.3.1 | NMR_N01: the structure cannot be parsed due to grouping (see NMD_N02) |
Groupnames are a new construct officially coming with v2.5. Some of them need adjustments:
| Section | Correction |
|---|---|
| all | choices => CHOICE |
| 9.8.1 | DOC_T12: => RESULT |
Migrating the new groupnames to all other versions I could identify a lot of inconsistencies among the all versions. They are very complicated so that I couldn't provide a workaround. The database contains them as is!
I suppose the ARB have to check them.
| Message Structure | Version | Comment |
|---|---|---|
| OML_O21 | v2.4 => v2.5 | change of sequence and grouping |
| ORL_O22 | ditto. | ditto. |
| RSP_K22 | v2.4 | => migrated to RSP_K21 |
| OMS_O01 + OMN_O01 | v2.3.1 | => OMN_O07: structure change??? |
| RDO_O01 | v2.3.1 | => OMP_O09: structure change??? |
| MFM_M08 | v2.3.1 => v2.4 + v2.5 | structure change: group for OM2, OM3, OM4 is missing (groupname = MF_NUMERIC_OBSERVATION) |
| NMD/NMQ N01/N02 | v2.2 => v2.3, v2.3.1, v2.4, v2.5 | N01 and N02 are switched! |
| ORF^R04 | v2.2 => v2.3, v2.3.1, v2.4, v2.5 | grouping changes |
There are also some simple errors hidden in the message structures:
| Section | Message Structure | Correction |
|---|---|---|
| 4.20.5 | BRP_O30 | missing closing bracket for PATIENT |
| 5.3.3.2, 5.4.1, .. | QBP_Q11 | is used several times with different structures! |
| 5.9.3.1.1, 5.3.1.2, .. | QBP_Q13 | is used several times with different structures! |
| 5.3.3.1 | RTB_K13 | closing bracket for ROW_DEFINITION instead of opening |
| SIU_S12 | groupname for closing bracket RESOURCES assigned to wrong row | |
| 5.9.2.4 | RSP_Z90 | closing bracket for VISIT instead of opening |
Finally, some message structures contain a blank in their groupname. I have changed the blanks to an underscore:
Last Update: October 7, 2003