HL7 V2.4 Style Guide

  • Doc File 632.50KByte



HL7 V2.5 Style Guide

|Co-Chair: |Helen Stevens |

| |McKesson HBOC |

|Co-Chair: |Klaus D. Veil |

| |HL7S&S |

|Editor: |Frank Oemig |

| |KIS Laufenberg GmbH & Co. KG |

1.1 Style Guide Contents

1.1 Style Guide Contents 1-1

1.2 Purpose 1-4

1.3 General Rules 1-4

1.3.1 Exceptions 1-4

1.3.2 General Specifications and Settings 1-4

1.3.3 Heading Capitalization 1-5

1.3.4 Enabling Macros 1-5

1.4 Document Structure 1-6

1.4.1 Introductory Page 1-6

1.4.2 Table of Contents 1-6

1.4.3 Statement of Purpose 1-7

1.4.4 Notes to Balloters 1-7

1.4.5 Preparing documents for publishing 1-7

1.4.6 Event/Message and Segment Definition 1-8

1.4.7 Field Definitions 1-8

1.5 Document properties 1-8

1.6 Formatting 1-8

1.6.1 Text Indentation 1-8

1.6.2 Message Definitions 1-9

1.6.3 Segment Definitions 1-9

1.6.4 Field Definitions 1-10

1.6.5 Components 1-10

1.6.6 Components (Data type) 1-10

1.6.7 Component Definitions 1-11

1.6.8 Table Definitions 1-11

1.6.9 Table Value Definitions 1-13

1.6.10 References to Data Elements 1-13

1.6.11 References to HL7 Tables 1-13

1.6.12 References to User Tables 1-13

1.6.13 Notes 1-13

1.6.14 Examples 1-13

1.6.15 Page Headers 1-14

1.6.16 Page Footers 1-14

1.6.17 Setting Bookmarks 1-14

1.7 Lists 1-15

1.8 Indexing 1-15

1.8.1 Data Types 1-15

1.8.2 Data Elements 1-16

1.8.3 Segments 1-16

1.8.4 Attribute Tables 1-16

1.8.5 Events 1-16

1.8.6 Tables 1-16

1.8.7 Message Types 1-16

1.9 Conformance Statements 1-16

1.9.1 Distinct Parts of a Conformance Statement 1-16

1.9.2 Formatting the different parts of a conformance statement with styles 1-17

1.10 Other EDITING TASKS and Issues 1-19

2.1 Authorized Paragraph Styles for the HL7-2 Template 21

2.1.1 Style Name Notes 25

2.1.2 Font 25

2.1.3 Kern 25

2.1.4 Line Spacing 25

2.1.5 Space Before 25

2.1.6 Space After 25

2.1.7 Justification 25

2.1.8 Other 25

2.1.9 Indent 25

2.1.10 Tabs 25

2.1.11 Base Style 25

2.1.12 Style for Following Paragraph 25

2.2 Authorized Character Styles for the HL7-2 Template 25

2.3 Withdrawn Styles for the HL7-2 Template 26

2.4 List of new styles for the Conformance Statement 26

2.5 List of column widths for all tables 27

2.6 REMARKS 27

2.7 A NOTE ON HTML STYLE SHEETS 27

2.8 Formatting Macros (Style Fixer) 28

2.8.1 Enabling Macros 28

2.8.2 General Remarks 28

2.8.3 Adjust the properties of the styles 28

2.8.4 Format all Tables within the document 28

2.8.5 References 29

2.8.6 Adjust the numbering of the headings 29

2.8.7 Adjust the Number Gallery 29

2.8.8 Delete unused styles 29

2.8.9 Convert message tables into 5 column format 29

2.8.10 Add 3rd column to tables 30

2.8.11 Reformat Message table 30

What table is this 30

2.8.13 Goto a specific table 30

2.8.14 Get All Formats 30

2.8.15 Requirements to run the macros 30

2.8.16 Manually Correcting Styles 30

2.8.17 Questions/Errors 31

2.8.18 History (last changes at the end) 31

2.9 Procedures 31

2.9.1 Procedure for Troubleshooting Normal List Alpha 31

2.9.2 Troubleshooting styles that change erratically 32

2.9.3 Procedure for inserting a picture 32

2.9.4 Troubleshooting the macro Format All Tables 33

1.2 Purpose

This document describes how HL7 Version 2.5 Chapters should be formatted in order to get a uniform layout, which in turn allows automatic generation of the HL7 V2.5 Database. For the automatic scanning and data extraction processing it is important to maintain consistency across all HL7 chapters.

To demonstrate the styles this document uses the same formatting rules.

All formatting is set by MS Word “styles”. (The use of a MS Word .DOT template file was found to be too unreliable). A set of macros is available (see the end of this document) to apply the styles to the document.

1.3 General Rules

To reduce the amount of formatting effort and to allow easy processing of HL7 Chapters no direct formatting should be applied. All necessary formatting shall be done by the help of MS Word “styles”.

1.3.1 Exceptions

Only a few exceptions are accepted. One is the numbering of the chapter. Others are identified later.

1.3.2 General Specifications and Settings

This HL7 Style Guide is for HL7 V2.5 documents.

This Style Guide assumes the use of MS Word 97 SR-2 or a later version of MS word (Office 2000, etc.).

Some settings are standard:

• The language is American English

• Hyphenation is enabled.

• Paper orientation is portrait

• “Fast saves” are disabled (keeps the documents to a minimum size)

• “Templates and Add-Ins ( automatic updates” is disabled.

1.3.2.1

1.3.2.2 Page Setup

Top margin: 0.4" (1,016 cm)

Bottom margin: 0.5" (1.27 cm)

Left margin: 0.75" (1.905 cm)

Right margin: 0.75" (1.905 cm)

Gutter (for binding): 0.5" (1.27 cm)

Header: 0.6” (1.524 cm)

Footer: 0.6” (1.524 cm)

1.3.2.3 Filename Conventions

The naming convention for the files is:

|Ch.doc |for the chapters including a two digit chapter number |

|Appendix.doc |for the appendices including a one character appendix number |

This convention is necessary to achieve hyperlinking across the different chapters.

1.3.3 Heading Capitalization

Capitalize the first and last words and all others except articles, prepositions, the to in infinitives and coordinate conjunctions (such as “and”, “but”, “or” and “yet2).

The same should be applied to data elements and segment names.

1.3.4 Enabling Macros

Regarding disabled macros. Word 97 (I don't know about later versions) will (is suppose to ask) if you want to enable/disable macros when you open a document that contains macros. The prompt can be turned on/off by checking/unchecking Macro Virus Protection in the General tab of Tools:Options. But, it you are not getting the prompt, the macros are suppose to be enabled.

You can get to the macros directly (not using the buttons) by going to Tools:Macro:Macros or pressing Alt+F8. The window will list the available macros. If the window is empty, then the macros have been disabled via Word's virus protection: Enable Macro Virus Protection (check it) in Tools:Options:General, then close and re-openthe document and click Enable on the dialog. If the dialog still doesn't show up then get a "fresh" copy of the style guide either re-extract it from the zip or download the zip again. (On the copy that I use I don't get the macro disable dialog, but I do get the dialog when I open a new copy out of the zip file.)

1.4 Document Structure

1.4.1 Introductory Page

Every chapter begins with an introductory page which names the number of the chapter, the name of the chapter and the responsible chairs and editors.

1.4.2 Table of Contents

A Table of Contents appears after the introductory information.

The TOC lists the chapter contents at the Heading 2 and Heading 3 levels.

The TOC is constructed as follows:

1) Select and delete the current TOC.

2) From the Insert menu, select Index and Tables

3) Select the Table of Contents menu.

4) Select “From Template” as the format

5) Show Page Number should be checked

6) Right Align Page Number should be checked

7) Show levels should be set to (WHAT)

8) Tab Leader should be set to “dots”

9) Select the Options menu

10) Etc

Heading 2

3.2 CHAPTER xx CONTENTS

{ VERZEICHNIS \T "Heading 2,1,Heading 3,2,Heading 4,3" }

Another important issue is to move the level down, i.e. make “Heading 2” “TOC 1”.

1.4.3 Statement of Purpose

Except for chapter 2, the first paragraph specifies the purpose of the chapter. The formatting is as follows:

Heading 1 (consists of a soft end of line [SHIIFT+RETURN] and the heading, but is auto-numbered and sets the number "base" for the whole chapter)

3.

Patient Administration

|Chapter Chair: |Freida B. Hall |

| |Ernest & Young |

|Chapter Chair: |Michael Hawver |

| |Eclipsys Corporation |

|Editor: |Klaus D. Veil |

| |HL7S&S |

3.2 PURPOSE Heading 2

The black horizontal line is built up by a graphical box across the page with 5 mm in height. The list of chairs and the editors is a table with no borderlines. This allows for easy alignment.

To set the "base" numbering for a chapter, set the number a *one* place in each chapter, namely in the actual chapter number ("3.") with the style of "Heading 1". Go to Format->Bullets and Numbering->Customize->Start at.

Heading 3

1.4.4 Notes to Balloters

Preparing a document for balloting often requires some additional information which should be taken care of when reading the document. This initial section appears directly below the list of co-chairs and editors, but before the table of contents. This ensures that everybody is aware of this additional information.

Notes to Balloters

• This is the Member Ballot for V2.x.

• Please ballot on chapter content only. The formatting of the chapters is mainly driven by the requirement to automatically extract data for automatic consistency checking and to build the HL7 V2.4 Database. The format has been reviewed by the HL7 Architectural Review Board. As HL7 also intends to publish the Standard in PDF and HTML/XML format, variations in presentation may not be avoidable. For this reason, not all style enhancements have change marks.

• HL7 HQ, the TC Chairs and the International Affiliates thank you for your consideration!

This section is makes use of the available styles.

Afterwards the whole section (without a section heading) is shaded in grey 15% and border lines are 1½ points.

1.4.5 Preparing documents for publishing

a) Run Macros

b) Clear number gallery (seep rocedure in section 1.7.1)

c) Correct typos

d) Make technical corrections approved by ARB that do not need to be balloted

e) Make any sections moves that do not involve content change

f) Make any other styleguide changes that do not involve content change

g) Set place holders for new sections

h) Check and correct bookmarks

i) Check that Header is correct

j) Check that the Footer indicates the proper ballot name or final name and the date

k) Turn Tracking (Checkmarking) on

l) Make content changes as needed

1.4.6 Event/Message and Segment Definition

The structure of the HL7 chapters consists of two parts. The first lists events, triggers and messages with the relevant message structures; the second part defines the segments, elements, components and subcomponents in detail.

1.4.7 Field Definitions

The field definitions for a segment have to be appended to the segment definition. It starts with the level 4 heading naming the segment after which the fields/elements are defined. No text is necessary.

Heading 4

1.4.7.1 PID-1 Set ID - PID (SI) 00104

All field definitions start with a level 4 heading consisting of four parts:

1) The data element identifier

2) the name of the data element

3) the type of the data element (in brackets)

4) the data element ID number

The four heading parts are separated by three spaces each.

The field definition header also contains an invisible entry for index generation. Look at the “Set ID – PID” heading above with Tools -> Options -> View -> All checked on.

1.5 Document properties

Title: The contents of this document, i.e. the name of the chapter

Topic: “HL7” and the corresponding version number

Author: The name of the editors.

1.6 Formatting

1.6.1 Text Indentation

Text following headings level 1 and 2 are flush left with no indentation; the MS Word style is “Normal”.

Text following level 3 headings and lower is formatted using "Normal Indented", indented 1/4" (0.63cm).

1.6.2 Message Definitions

Message definitions are in form of a table to simplify the document data extraction This table consists of three columns and as many rows as necessary.

The first row (“Msg Table Header”) describes:

• in the first column the message type, the event/trigger code and the message structure ID separated by "^",

• in the second column a short description

• in the third column the group name to identify logical groups of segments

• in the fourth column a status concerning backward compatibility

• in the fifth column the corresponding HL7 chapter.

All subsequent rows are used for the message description (“Msg Table Body”). The segments used and structure symbols are listed in the left column. The middle column holds the segment name.

If this message applies to more than one event, all event codes are listed within the second field of the first column in the first row. Ranges are separated by dashes (“-“) and single values by commas.

The message definition tables are indented by 1/4" (0.63cm).

Msg Table Header Hyperlink to “EVN” Msg Table Body

|ADT^A01^ADT_A01 |ADT Message |Group Name |Status |Chapter |

|MSH |Message Header | | |2 |

|EVN |Event Type | | |3 |

|PID |Patient Identification | | |3 |

|[PD1] |Additional Demographics | | |3 |

|[ { NK1 } ] |Next of Kin /Associated Parties | | |3 |

|PV1 |Patient Visit | | |3 |

|[ PV2 ] |Patient Visit - Additional Info. | | |3 |

|[ { DB1 } ] |Disability Information | | |3 |

|[ { OBX } ] |Observation/Result | | |7 |

|[ { AL1 } ] |Allergy Information | | |3 |

|[ { DG1 } ] |Diagnosis Information | | |6 |

|[ DRG ] |Diagnosis Related Group | | |6 |

|[ | |PROCEDURE | | |

| { | | | | |

| PR1 |Procedures | | |6 |

| [{ROL}] |Role | | |12 |

| } | | | | |

|] | | | | |

|[ { GT1 } ] |Guarantor | | |6 |

|[ | |INSURANCE | | |

| { | | | | |

| IN1 |Insurance | | |6 |

| [ IN2 ] |Insurance Additional Info. | | |6 |

| [ {IN3} ] |Insurance Additional Info. - Cert. | | |6 |

| } | | | | |

|] | | | | |

Columns 1 and 2 are left justified – and columns 3 to 5 are centered.

It is required that all segments in the message structure that are defined in the same chapter have a hyperlink to the segment attribute table.

Whenever brackets are used for one segment only they should appear within the same cell. Otherwise separate rows should be used.

Indentation can use tabs or spaces. The latter are preferred. If possible the closing brackets should appear below the corresponding opening bracket.

1.6.3 Segment Definitions

Attribute headers start on a new page. The attribute tables, i.e. the list of data elements used, are indented 1/4" (0.63cm) and should be formatted as follows:

Attribute Table Caption

Attribute Table Header

Attribute Table Body Bookmark (“EVN”) Index information

Hyperlink to “ID”

HL7 Attribute Table – EVN – Events {XE “HL7 Attribute Table: EVN” }{XE “EVN attributes”}

|SEQ |LEN |DT |OPT |RP/# |TBL# |ITEM# |ELEMENT NAME |

|1 |3 |ID |B | |0003 |00099 |Event Type Code |

|2 |26 |TS |R | | |00100 |Recorded Date/Time |

|3 |26 |TS |O | | |00101 |Date/Time Planned Event |

|4 |3 |IS |O | |0062 |00102 |Event Reason Code |

|5 |60 |XCN |O |Y |0188 |00103 |Operator ID |

|6 |26 |TS |O | | |01278 |Event Occurred |

The attribute table caption line information is used to generate the index of HL7 attribute tables. Therefore the complete caption is repeated in the index field. To facilitate the generation of the database the index field must be positioned at the end of the line!

The attribute table caption line must be bookmarked with the 3-letter segment ID (i.e. "EVN") for referencing by the message structure tables.

The header is shaded 10%.

The attribute table grid lines are ¾ points, and the border is a dual ¾ point line.

Additional index information is added at the end of the paragraph. This kind of information is hidden and therefore only visible when switching on “all” in Extras->Options->non-printable characters. (The information above is formatted as normal text so it appears in the printed version of this document.)

1.6.4 Field Definitions

Style “Heading 4” 1.5.10.0 starts with zero to ensure that “field definitions” after a HL7 Attribute Table are automatically renumbered. Where a zero-numbered heading is not desired, hide it with Format -> Font -> Hidden.

The Field Definition heading now consists of 5 components:

• Section heading number: 3.3.2.3 (automatically generated by Word)

• Element name: PID-3

• Element description: Patient Identifier List (Use Title Case)

• Element data type: (CX)

• Unique data element identifier: 00106

The 5 heading components are separated by 3 spaces each. The complete heading looks as follows:

3.3.2.3 PID-3 Patient Identifier List (CX) 00106

1.6.5 Components

Whenever a data element consists of components, they are defined first within the description. This definition is done in a paragraph like form. This definition also applies for subcomponents.

Components: ^ ^ ^ ^ ^

Components

The component definition, i.e. the list of components, is not repeated within each field definition since this functionality can be reached by hyperlinking! This change reduces drastically the amount of pages necessary for printing.

1.6.6 Components (Data type)

The components which make up a data type are specified in form of a table like segments or real tables.

Component Table Caption

Component Table Header

Component Table Body Bookmark (“CE”) Index information

Hyperlink to “ST”

HL7 Component Table - CE – coded element{XE “HL7 Component Table - CE ” }

|SEQ |LEN |DT |OPT |TBL# |COMPONENT NAME |COMMENTS |SEC.REF. |

|1 | |ST |R | |Identifier | | |

|2 | |ST |O | |Text | | |

|3 | |IS |R |0396 |Name Of Coding System | | |

|4 | |ST |O | |Alternate Identifier | | |

|5 | |ST |O | |Alternate Text | | |

|6 | |IS |O |0396 |Name Of Alternate Coding System | | |

Length: 250

Example:

|F-11380^CREATININE^I9^2148-5^CREATININE^LN|

The header is shaded 10%.

Columns 6 and 7 are left justified.

The attribute table grid lines are ¾ points, and the border is a dual ¾ point line.

Within the comments column there is no hint whether this component is itself a complex data type. The user can find out by checking the underlying data type. Within the narrative a hint (note) can be found to give an indication the data type which embeds the current one. But this should only apply to sparsely use data types.

See Bookmark procedure for setting a Bookmark in the caption.

1.6.7 Component Definitions

Style “Heading 4” 1.5.10.0 starts with zero to ensure that “component definitions” after a HL7 Component Table are automatically renumbered. Where a zero-numbered heading is not desired, hide it with Format -> Font -> Hidden.

The Component Definition heading now consists of 4 components:

• Section heading number: 3.3.2.3 (automatically generated by Word)

• Component name: CE.1

• Component description: Identifier (Use Title Case)

• Component data type: (ST)

The 4 heading components are separated by 3 spaces each. The complete heading looks as follows:

3.3.2.3 CE.1 Identifier (ST)

1.6.8 Table Definitions

Whenever a table is referenced within a field description the first time (according to the sequence of chapters) the corresponding values have to be defined in form of a table. If no values can be identified this table should contain one entry saying “no suggested values”.

1.6.8.1

1.6.8.2 General rules

• Tables with double borders are normative, tables with single borders are user-defined.

• Each table consists of a caption, a header and a body.

• The header part is shaded.

• Table structures are to be inserted in the standard, even if values have not been determined.

1.6.8.3 HL7 Tables

HL7 Table Caption

HL7 Table Header

HL7 Table Body Bookmark (“HL70103”) Index information

HL7 Table 0103 – Processing ID{XE “HL7 Table: 0103 - Processing ID ” }

|Value |Description |

|01 |Patient request |

|02 |Physician order |

|03 |Census management |

Note the index field in the HL7 table caption above.

The HL7 table caption line must be bookmarked with the 7-character table ID (ie. "HL70103", see 2.8.3.3) for referencing by all references (ie. HL7 Table 0103 – Processing ID) to that table within the same chapter.

The header is shaded 10%.

HL7 table grid lines are ¾ points, and the border is a dual ¾ point line.

As the width of HL7 tables changes, they are centered.

Note: HL7 Table 0136 - Yes/no Indicator should not be repeated with different values, rather the interpretations should be given in a “normal list” style. (This avoids the duplication of HL7 table 0136 with differing values.) Example:

Definition: This field indicates whether or not the patient’s identity is known. Refer to HL7 Table 0136 - Yes/no indicator for suggested values.

Y the patient’s identity is unknown

N the patient’s identity is known

1.6.8.4 User-defined Tables

User Table Caption

User Table Header

User Table Body Bookmark (“HL70062”) Index information

User-defined Table 0062 - Event reason{XE “ User-defined Table: 0062-Event reason ” }

|Value |Description |

|01 |Patient request |

|02 |Physician order |

|03 |Census management |

Note the index field in the User Table caption above.

The user-defined table caption line must be bookmarked with the 7-character table ID (ie. "HL70062", see 2.8.3.3) for referencing by all references (ie. User-defined Table 0062 – Event Reason) to that table within the same chapter.

The header is shaded 10%.

User Table grid lines are ¾ points, and the border is a 1½ point line.

As the width of User-defined tables changes, they are centered.

It is a requirement that all user-defined tables are included in a chapter, even if values have not been determined. The tables should be formatted the same as any other user-defined table, but there should be only one "User Table Body" row, which should read: "No suggested values defined."

1.6.8.5 Other Tables

All other tables use the styles

• Other Table Caption

• Other Table Header

• Other Table Body

1.6.9 Table Value Definitions

We propose the following notation:

• The basic structure of a table is value in the left-most column and the description in the 2nd-leftmost column. Only one value pair per row is allowed. If comments, etc. are required, these can be entered in additional columns on the right.

• A range of values is indicated by three dots separated by spaces from the first and last value: …

A dash ("-") seems to be a bad solution because it may indicate a negative value.

• Different values with the same description can be separated by commas, eg. NO, NIL, NONE.

1.6.10 References to Data Elements

References to data elements are used within standard text shall be formatted like in PV1-6 - Prior Patient Location.

Reference Attribute

Here the character style “Reference Attribute” is used. This assignment of styles will be used later to identify incorrect references of data elements in accordance with the definition.

1.6.11 References to HL7 Tables

References to HL7 Tables should be done by hyperlinking. If this cannot be achieved the references within text like HL7 Table 0103 - Processing ID shall be formatted using the MS Word Style “Reference HL7 Table”.

1.6.12 References to User Tables

The same applies to the references to User Tables. If no hyperlinking is applied the text like User-defined Table 0062 – Event Reason shall be formatted using the MS Word Style “Reference User Table”.

1.6.13 Notes

Note

Note: The official title of UB is “National Uniform Billing Data Element Specifications.” Most of the codes added came from the UB-92 specification, but some came from the UB-82.

The “note” box is aligned with the text indentation. The bolded initial text "Note:" is followed by two spaces after the colon.

The “Note” style has 4 points before and 3 after each paragraph.

1.6.14 Examples

If an example is necessary to illustrate the meaning of a message the style “Example” should be used.

Example

MSH|.|..|...

EVN|..|..|...

PID|||.....

.....

Examples and use cases should be placed as close to the relevant chapter section as possible.

1.6.15 Page Headers

The header line consists of a ¾ point border line below. It merely names the document.

1.6.15.1 (This header is hidden!)

1.6.15.2 First Page Headers

The first page does not have a header.

1.6.15.3 Odd Page Headers

Chapter 3: Patient Administration

The number and name of the chapter is shown in the page header, right justified

1.6.15.4 Even Page Headers

Chapter 3: Patient Administration

The number and name of the chapter is shown in the page header, left justified.

1.6.16 Page Footers

Footer lines consist of two lines. The first lists a copyright statement and the page number with total number separated by a dash. The second line contains the status of this document as well as the issue date.

1.6.16.1

1.6.16.2 Odd pages and first page

The footer consists of different parts:

1) the copyright notice including the year and "All rights reserved."

2) a reference to Health Level Seven, Inc.

3) the version number

Health Level Seven, Version 2.5 © 2001. All rights reserved Page 3-5

Ballot May 2001

4) the release status (i.e. one of: “Draft”, “Ballot”, “Final Standard”)

5) the chapter and page number formatted as “-”.

6) the month and year of release, Yk2 compliant and internationally readable.

1.6.16.3 Even pages

Page 3-6 Health Level Seven, Version 2.5 © 2001. All rights reserved

May 2001 Ballot

1.6.17 Setting Bookmarks

Word gives only limited help on how to set bookmarks. The following list might assist you:

1) Highlight the text that you want to bookmark

2) Go to the Insert->Bookmark

3) Enter the name of your bookmark

4) Select ADD

5) The text will appear in brackets [ ] when you have the “bookmark view” or “all hidden characters” turned on

1.7 Lists

For listing items we provide four different styles:

“Normal List”

a) “Normal List Alpha”

1) “Normal List Numbered”

I) “Normal List Roman”

• “Normal List Bullets”

Here is some technical information on lists:

|List |Gallery |

|Normal |- |

|Alpha |Number 5 |

|Numbered |Number 2 |

|Roman |Number 7 |

|Bullet |Bullet 7 |

Lists should be standardized in its usage. Alpha, numbered and roman lists represents a hierarchy, also in their indentation. Therefore, whenever possible try to use alpha lists first.

Use Normal List Alpha under the following circumstances:

• The items occur in a definite sequential order

• A large number of items are being enumerated.

Use Normal List Numbered under the following circumstances:

• Steps in a procedure or process are being enumerated

• Lists embedded within alpha lists

Use Normal List Bullets under the following circumstances:

• Fewer than 6 (or perhaps 7 or fewer) items are listed and they do not meet above criteria

Avoid using the Normal List. Consider using a table instead.

Avoid deeply indented lists.

Please the procedures section for trouble shooting.

1.8 Indexing

Another important point for documentation is the generation of an index. For this a lot of additional information is necessary. To get a consistent result some rules have to be established how to formulate such entries.

In order not to interrupt the parsing process this information must be placed at specific points within the text.

The use of a colon (“:”) build up groups like a list of all tables.

1.8.1 Data Types

1) „Data Types:“ + + “ - “ +

2) + “ - “ +

3)

1.8.2 Data Elements

The name of the data element is repeated within the title.

1.8.3 Segments

Within the title three different entries are necessary:

1)

2) “Segments:” +

3) + “ (“ + +”)”

1.8.4 Attribute Tables

The index information must be added at the end of the paragraph (i.e. line).

1)

2) “HL7 Attribute Table:“ +

1.8.5 Events

1)

2) “Events:” +

1.8.6 Tables

1) “Tables: User or HL7 defined:” + + “ - “ +

2) ” + “ (“ + +”)”

1.8.7 Message Types

1)

2) “Message Types:” +

1.9 Conformance Statements

Conformance Statements are a new construct in version 2.4.

Three different conformance statements do exist:

• Query with tabular response

• Query with segment pattern response

• Query with display response

Every conformance statement consists of several distinct parts identified within the next section.

1.9.1 Distinct Parts of a Conformance Statement

The numbers within the right three columns specify the sequence order of the part within the conformance statement.

|No. |Part |Tabular response |Segment pattern |Display response |

| | | |response | |

|1 |introduction (= main table conformance statement) |1 |1 |1 |

|2 |query grammar |2 |2 |2 |

|3 |response grammar |3 |3 |3 |

|4 |QPD input parameter specification |4 |4 |4 |

|5 |QPD input parameter field description and commentary |5 |5 |5 |

|6 |output specification and commentary |6 | |6 |

|7 |virtual table |7 | | |

|8 |RCP Response Control Parameter Field Description and Commentary |8 | | |

1.9.2 Formatting the different parts of a conformance statement with styles

• Some fields are divided into two parts, i.e. the row now contains more cells

• A style is assigned to each field

• Some rows are inserted due to layout

• Some fields are spread over separate rows due to storage reasons for the database

The applied styles are inserted into the text and marked in red.

Some rows can be repeated as often as necessary. These rows are marked by a red arrow on the right side.

The table border is a dual ¾ point line. The grid lines are ¾ points single line.

1.9.2.1

1.9.2.2 Introduction

Conformance Statement (Qry Table Caption)

|Query Statement ID: |Q31 (Qry Table ID) |

|Type: |Query (or Publish) (Qry Table Type) |

|Query Name: |Dispense History (Qry Table Name) |

|Query Trigger (= MSH-9): |QBP^Q11^QBP_Q31 (Qry Table Trigger Query) |

|Query Mode: |Both (Qry Table Mode) |

|Response Trigger (= MSH-9): |RSP^K31^RSP_K31 (Qry Table Response Trigger) |

|Query Characteristics: |Returns response sorted by Medication Dispensed unless otherwise specified. (Qry Table|

| |Characteristics Query) |

|Purpose: |Find medications dispensed between specified date range for specified medical record |

| |numbers (Qry Table Purpose) |

|Response Characteristics: |Returns response sorted by Medication Dispensed unless otherwise specified. (Qry Table|

| |Characteristics Response) |

|Based on Segment Pattern: |RDS_O01 (Qry Table Segment Pattern) |

|Response Control Characteristics: |[RCP segment options go here] (Qry Table Response Control Characteristics) |

|RCP Constraints: |(Qry Table RP Constraints) |

|Modify Indicator: |(Qry Table Modify Indicator) |

1.9.2.3 Query Grammar

The query grammar is exactly the same as any normal message definition. This is especially true for the used styles. If a message should be used, which is defined somewhere else no additional definition is required because the definition in the main table refers to it.

Please see section 1.5.2.

1.9.2.4 QPD Input Parameter Specification

|Field |Field Name (Qry |Key/ |Sort|LEN |TYPE |Opt |Rep |Match Op |TBL |Segment |LOINC or HL7 |Element Name |

|Seq |Table Input Header) |Search | | | | | | | |Field Name |Code | |

|1 |PatientList (Qry |S |Y |20 |CX |O | | | |PID-3 | |Patient Identifier |

| |Table Input) | | | | | | | | | | |List |

|2 |MedicationDispensed |S |Y |100 |CE |O | |= | |RXD-2 | |Dispense/Give Code |

|3 |DispenseDate.LL |S |Y |26 |TS |O | |> | |RXD-3 | |Date/Time Dispensed |

| | | | | | | | |= | | | | |

|4 |DispenseDate.UL |S |Y |26 |TS |O | |< | |RXD-3 | |Date/Time Dispensed |

| | | | | | | | |= | | | | |

|5 |SortControl | | | |SRT |O | | |NNNN | | | |

1.9.2.5 QPD Input Parameter Field Description and Commentary

|Input Parameter (Qry |Comp. Name |DT |Description |

|Table Input Param | | | |

|Header) | | | |

|PatientList (Qry | |CX | |

|Table Input Param) | | | |

| | | |Components: ^ ^ ^ < assigning authority (HD)> ^ ^ < assigning facility (HD)> |

| | | |The combination of values for PatientID, and PatientIDAssigningAuthority, are intended to |

| | | |identify a unique entry on the PATIENT_MASTER table. The PatientIDTypeCode is useful for |

| | | |further filtering or to supply uniqueness in the event that the assigning authority may have |

| | | |more than one coding system. (The PATIENT_MASTER table contains a constraint that prevents |

| | | |multiple patients from being identified by the same combination of field values.) This |

| | | |PATIENT_MASTER entry will be searched against on the PHARMACY_DISPENSE_TRANSACTION table to |

| | | |retrieve the rows fulfilling the query conditions. |

| | | |If this field is not valued, all values for this field are considered to be a match. |

| |ID |ST |If this field, PID.3.1, is not valued, all values for this field are considered to be a match. |

| |Assigning |HD |If this field, PID.3.4, is not valued, all values for this field are considered to be a match. |

| |Authority | | |

1.9.2.6 Response Grammar

The response grammar is much like any normal message definition, except the three additional columns. Please see section 1.5.2.

If a conformance statements can make use of response message definition which is defined somewhere else, no additional specification is necessary.

1.9.2.7 Output specification and commentary

If the message contains a DSP segment for displaying data it looks like the next table. Please consider that each line is represented by one row.

|The data will display as follows: (Q13) (Qry Table DisplayLine Header) |

|DSP|| GENERAL HOSPITAL – PHARMACY DEPARTMENT DATE:mm-dd-yy (Qry Table DisplayLine) |

|DSP|| DISPENSE HISTORY REPORT PAGE n |

|DSP||MRN Patient Name MEDICATION DISPENSED DISP-DATE |

|DSP||XXXXX XXXXXx, XXXXX XXXXXXXXXXXXXXXX mm/dd/ccyy |

|… |

|DSP|| > |

1.9.2.8 RCP Response Control Parameter Field Description and Commentary

|Field |Name |Component Name |LEN |DT |Description |

|Seq | | | | | |

|1 |Query Priority | |1 |ID |D(eferred) or I(mmediate). Default is I |

|2 |Quantity Limited | |10 |CQ | |

| |Request | | | | |

| | |Quantity | |NM |Number of units |

| | |Units | |CE |CH, LI, PG, RD. Default is LI. |

|3 |Response Modality | |60 |CE | |

1.9.2.9 Virtual Table

A virtual is identical to the input parameter specification. In order to distinguish both, please use different styles:

|Column Name (Qry |Key/ |Sort|LEN |TYPE |Opt |Rep |Match Op|TBL |Segment |LOINC or |Element Name |

|Table Virtual |Search | | | | | | | |Field Name |HL7 Code | |

|Header) | | | | | | | | | | | |

|PatientList (Qry |S |Y |20 |CX |O | | | |PID-3 | |Patient Identifier List |

|Table Virtual) | | | | | | | | | | | |

|MedicationDispense|S |Y |100 |CE |O | |= | |RXD-2 | |Dispense/Give Code |

|d | | | | | | | | | | | |

|DispenseDate.LL |S |Y |26 |TS |O | |> | |RXD-3 | |Date/Time Dispensed |

| | | | | | | |= | | | | |

|DispenseDate.UL |S |Y |26 |TS |O | |< | |RXD-3 | |Date/Time Dispensed |

| | | | | | | |= | | | | |

|SortControl | | | |SRT |O | | |NNNN | | | |

1.10 Other EDITING TASKS and Issues

• Ensure any new or changed datatypes are communicated to the C/Q TC for inclusion in Chapter 2.

• Check if any changes to the datatypes are required to any other chapters.

• Check example messages for compliance with any changes made to the chapter content.

• Any new triggers must be included in Table 0354 (Message Structure, the 3rd component of MSH-9) in Chapter 2.

• Any new style elements introduced into the standard must be checked with the Publishing Committee to ensure a uniform layout and future integration into the database.

HL7 STYLE SHEET

1 Authorized Paragraph Styles for the HL7-2 Template

|Style Name |Attributes | | | | | | | | | | |

| |(Where none listed, follows base | | | | | | | | | | |

| |style) | | | | | | | | | | |

| |Font |Kern |Line Spacing |Space Before|Space After |Justification |Other |Indent |Tabs |Base Style |Style for |

| | | | | | | | | | | |following |

| | | | | | | | | | | |Paragraph |

|Attribute Table Body |Arial 8 pt |8 pt |9 pt |2 pt |1.5 pt |Centered | | | |Normal | |

|Attribute Table Caption |Times New Roman 10 pt | | |9 pt |3 pt |Centered |Keep with next | | |Attribute Table | |

| | | | | | | | | | |Body | |

|Attribute Table Header |Arial 8 pt bold | | |2 pt |1.5 pt |Centered |Keep with next | | |Attribute Table | |

| | | | | | | | | | |Caption | |

|Components |Courier New 8 pt |7 pt |8 pt |6 pt |6 pt | |Keep lines |Left 0.75” | |Normal | |

| | | | | | | |together |Hanging 0.75” | | | |

|Component Table Body |Arial 8 pt |8 pt |9 pt |3 pt |0 pt |Centered | | | |Normal | |

|Component Table Caption |Arial 10 pt | | |9 pt |3 pt |Centered |Keep with next | | |Component Table | |

| | | | | | | | | | |Body | |

|Component Table Header |Arial 8 pt bold | | |2 pt | |Centered |Keep with next | | |Component Table | |

| | | | | | | | | | |Caption | |

|Example |LinePrinter 8 pt (no proofing) |8.5 pt | |0 pt |0 pt | |Keep lines |Left 1.3” | |Normal | |

| | | | | | | |together |Hanging 0.25” | | | |

|Footer |Arial 8 pt | | |0 pt |0 pt | | | |6.5” right |Normal | |

| | | | | | | | | |flush | | |

|Footnote text |Arial 8 pt | |10 pt | | | | |Hanging 0.25” |0.25 |Normal | |

|Header |Arial Bold | |10 pt |0 pt |18 pt | |Border: bottom | |6.35” right |Normal | |

| | | | | | | |(single solid | |flush | | |

| | | | | | | |line); Border | | | | |

| | | | | | | |spacing: 1 pt | | | | |

|Heading 1 Right |Times New Roman 36 pt bold | |36 pt |12 pt | |Flush right | | |None |Heading 1 | |

|HL7 Table Body |Arial 8 pt | | |1 pt |0.5 pt | | | | |Normal | |

|HL7 Table Caption |Times New Roman 10 pt | | |9 pt |3 pt |Centered |Keep with next | | |HL7 Table Body | |

|HL7 Table Header |Arial 8 pt bold | | |2 pt |1 pt |Centered |Keep with next | | |HL7 Table Caption | |

|Msg Table Body |Courier New 8 pt | |single |0 pt |0 pt | | | | |Normal | |

|Msg Table Caption |Times New Roman 10 pt | |9 pt |0 pt |3 pt | |Keep with next | | |Msg Table Body | |

|Msg Table Header |Courier New 8 pt bold underline | | |6 pt |2 pt | |Keep with next | | |Msg Table Caption | |

|Normal |Times New Roman 10 pt |10 pt |single |0 pt |6 pt |Flush left |Widow /orphan | | | | |

| | | | | | | |control | | | | |

| | | | | | | |Outline level body| | | | |

| | | | | | | |text | | | | |

|Normal Indented |“ |“ |“ |0 pt |6 pt |“ |“ |Left 0.5” | |Normal | |

|Normal List |“ |“ |“ |0 pt |6 pt |“ |“ |Left 0.5” | |Normal | |

|Normal List Alpha |“ |“ |“ |6 pt |6 pt |“ |Numbered (alpha): |Left 0.7” |.95” left |Normal |Normal List Alpha |

| | | | | | | |a), b), c) |Hanging 0.2” | | | |

|Normal List Numbered |“ |“ |“ |6 pt |6 pt |“ |Numbered (arabian |Left 0.9” | |Normal |Normal List |

| | | | | | | |numerals) |Hanging 0.2” | | |Numbered |

| | | | | | | |1), 2), 3) | | | | |

|Normal List Roman |“ |“ |“ |6 pt |6 pt |“ |Numbered (roman |Left 1.4” | |Normal |Normal List Roman |

| | | | | | | |numerals) |Hanging 0.3” | | | |

| | | | | | | |i), ii), iii) | | | | |

|Normal List Bullets |“ |“ |“ |6 pt |6 pt |“ |Bulleted |Left 0.7” | |Normal |Normal List |

| | | | | | | | |Hanging 0.25” | | |Bullets |

|Note |Arial 9 pt |8 pt | |4 pt |3 pt | |Border single |Left 0.6” |0.5” left |Normal | |

| | | | | | | |solid line ¾ pt |hanging 0.5” |1” left | | |

| | | | | | | |line width | | | | |

|Note Indented |Arial 9 pt | | |4 pt |3 pt | |Border single |Left 0.7” | |Note |Normal Indented |

| | | | | | | |solid line ¾ pt |hanging 0.5” | | | |

| | | | | | | |line width | | | | |

|Other Table Body |9 pt | | |3 pt |3 pt | | | | |Normal | |

|Other Table Caption | | | |9 pt |3 pt |Centered |Keep with next | | |Normal | |

|Other Table Header |9 pt bold | | |1 pt | |Centered |Keep with next | | |Normal | |

|TOC1 |Arial 12 pt bold all caps | | |18 pt |0 pt | | | |0.5” left |Normal | |

| | | | | | | | | |6.5” right | | |

| | | | | | | | | |flush | | |

|TOC2 |Arial Bold 10 pt bold all caps | | |6 pt |6 pt | | |Left 0.14” |6.5” right |TOC1 | |

| | | | | | | | | |flush | | |

|TOC3 |Arial Bold 10 pt bold small caps | | |0 pt |0 pt | | |Left 0.28” |6.5” right |TOC2 | |

| | | | | | | | | |flush | | |

|TOC4 |Arial 9 pt | | |0 pt |0 pt | | |Left 0.42” |6.5” right |TOC3 | |

| | | | | | | | | |flush | | |

|TOC5 | | | |0 pt |0 pt | | |Left 0.56” |6.5” right |TOC4 | |

| | | | | | | | | |flush | | |

|TOC6 | | | |0 pt |0 pt | | |Left 0.69” |6.5” right |TOC5 | |

| | | | | | | | | |flush | | |

|TOC7 | | | |0 pt |0 pt | | |Left 0.83” |6.5” right |TOC6 | |

| | | | | | | | | |flush | | |

|TOC8 | | | |0 pt |0 pt | | |Left 0.97” |6.5” right |TOC7 | |

| | | | | | | | | |flush | | |

|TOC9 | | | |0 pt |0 pt | | |Left 1.11” |6.5” right |TOC8 | |

| | | | | | | | | |flush | | |

|User Table Body |Arial 8 pt | | |1 pt |0.5 pt | | | | |Normal | |

|User Table Caption |Times New Roman 10 pt | | |9 pt |3 pt | |Keep with next | |0.63” |Normal | |

|User Table Header |Arial 8 pt bold | | |2 pt |1 pt |Centered |Keep with next | | |Normal | |

|Heading 1 |Times New Roman 36 pt bold |14 pt | |18 pt |6 pt |Flush right |Keep with next |None |None |Normal |Normal |

| | | | | | | |Level 1 outline | | | | |

| | | | | | | |numbered. | | | | |

| | | | | | | |Follow with | | | | |

| | | | | | | |nothing. | | | | |

|Heading 2 |Arial 14 pt bold all caps | |Single |18 pt |3 pt | |Keep with next |Hanging 0.7” |0.7” left |Heading 1 |Normal |

| | | | | | | |Level 2 outline | | | | |

| | | | | | | |numbered. | | | | |

| | | | | | | |Follow with tab. | | | | |

|Heading 3 |Arial 12 pt bold | | |12 pt |3 pt | |Keep with next |Hanging 0.7” |0.7” left |Heading 2 |Normal Indented |

| | | | | | | |Level 3 outline | | | | |

| | | | | | | |numbered. | | | | |

| | | | | | | |Follow with tab. | | | | |

|Heading 4 * |Arial 10 point | | |6 pt |3 pt | |No widow /orphan |Hanging 0.7” |0.7” left |Heading 3 |Normal Indented |

| | | | | | | |Keep with next | | | | |

| | | | | | | |Level 4 outline | | | | |

| | | | | | | |numbered. | | | | |

| | | | | | | |Follow with tab. | | | | |

|Heading 5 |Arial 10 point italic | | |6 pt |3 pt | |Keep with next |Hanging 0.7” |0.7” left |Heading 4 |Normal Indented |

| | | | | | | |Level 5 outline | | | | |

| | | | | | | |numbered. | | | | |

| | | | | | | |Follow with tab. | | | | |

|Heading 6 |Arial 10 point italic | | | | | | |Hanging 0.7” | |Heading 5 | |

|Heading 7 |Arial 10 point italic | | | | | | |Hanging 0.7” | |Heading 6 | |

• Style “Heading 4” N.N.N.0 starts with zero to ensure that “field definitions” after a HL7 Attribute Table are automatically renumbered. Where a zero-numbered heading is not desired, hide it with Format -> Font -> Hidden.

|Style Name |Attributes | | | | | | | | | | |

| |(Where none listed, follows base | | | | | | | | | | |

| |style) | | | | | | | | | | |

| |Font |Size |Attribute | | | | | | |Base Style |Style for |

| | | | | | | | | | | |following |

| | | | | | | | | | | |Paragraph |

|Hyperlink |Times New Roman |10 pt | | | | | | | | | |

|Reference Attribute |Times New Roman | | | | | | | | |Hyperlink | |

|Reference HL7 Table |Times New Roman | |Italics | | | | | | |Hyperlink | |

|Reference User Table |Times New Roman | |italics | | | | | | |Hyperlink | |

2 1 Style Name Notes

• Style “Heading 4” N.N.N.0 starts with zero to ensure that “field definitions” after a HL7 Attribute Table are automatically renumbered. Where a zero-numbered heading is not desired, hide it with Format -> Font -> Hidden.

2 Font

Where set: Format/Style/Modify/Font

3 Kern

Where set: Format/Style/Modify/Font/Character Spacing

4 Line Spacing

Where set: Format/Style/Modify/Paragraph/Indents and Spacing/Spacing:Line Spacing box

5 Space Before

Where set: Format/Style/Modify/ Paragraph/Indents and Spacing/Spacing:Before box

6 Space After

Where set: Format/Style/Modify/ Paragraph/Indents and Spacing/Spacing:After box

7 Justification

Where set: Format/Style/Modify/ Paragraph/Indents and Spacing/Alignment

8 Other

This includes notes for text control, borders and shading

Text control Where set: Format/Style/Modify/paragraphs/Line and Page Breaks

Border control Where set: Format/Style/Modify/Border

9 Indent

Where set: Format/Style/Modify/ Paragraph/Indents and Spacing/Indentation: Left

Where set: Format/Style/Modify/ Paragraph/Indents and Spacing/Indentation: Special and By

10 Tabs

Where set: Format/Style/Modify/Tabs

11 Base Style

Where set: Format/Style/Modify/Based On

12 Style for Following Paragraph

Where set: Format/Style/Modify/Style for Following Paragraph

3 Authorized Character Styles for the HL7-2 Template

|Style Name |Attributes (Where none listed, follows Normal) |

| |Font |Other |Base Style |

|Default Paragraph Font |Times New Roman 10 pt | | |

|Reference Data Element |Times New Roman 10 pt |Italics |Default Paragraph Font |

|Reference HL7 Table |Times New Roman 10 pt |Italics |Default Paragraph Font |

|Reference User Table |Times New Roman 10 pt |italics |Default Paragraph Font |

4 Withdrawn Styles for the HL7-2 Template

• Indent Normal ( Normal Indented

• MsgHeader ( Msg Table Header

• MsgStructure ( Msg Table Body

• Attribute Table Heading ( Attribute Table Header

• Msg Table Heading ( Msg Table Header

5 List of new styles for the Conformance Statement

Indent: 0”

No tabs used.

Other: nothing special

|Style Name |Font |Line Spacing|Space Before|Space |Justification |Base Style |

| | | | |After | | |

|Qry Table Caption |Times New Roman 12pt bold | |6 |6 |Centered |Qry Table Header |

|Qry Table Characteristics Query |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Characteristics |Arial 8pt | |1 |6 | |Qry Table Name |

|Response | | | | | | |

|Qry Table DisplayLine |Courier New 8pt | |1 |6 | |Qry Table Name |

|Qry Table DisplayLine Header |Courier New 8pt | |1 |6 | |Qry Table Header |

|Qry Table Header |Arial 8pt bold | |1 |6 | |Standard |

|Qry Table ID |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Input |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Input Header |Arial 8pt bold | |1 |6 | |Qry Table Header |

|Qry Table Input Param |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Input Param Header |Arial 8pt bold | |1 |6 | |Qry Table Header |

|Qry Table Mode |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Modify Indicator |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Name |Arial 8pt | |1 |6 | |Standard |

|Qry Table Purpose |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table RCP |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table RCP Header |Arial 8pt bold | |1 |6 | |Qry Table Header |

|Qry Table RCP Constraints |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Response Trigger |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Response Control |Arial 8pt | |1 |6 | |Qry Table Name |

|Characteristics | | | | | | |

|Qry Table Segment Pattern |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Trigger Query |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Type |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Virtual |Arial 8pt | |1 |6 | |Qry Table Name |

|Qry Table Virtual Header |Arial 8pt bold | |1 |6 | |Qry Table Header |

6 List of column widths for all tables

This table reflects the widths (in inches) of the different tables.

|Column |1 |2 |3 |4 |5 |6 |7 |8 |9 |10 |11 |12 |13 |

|Table | | | | | | | | | | | | | |

|Attribute Table |0.45 |0.45 |0.45 |0.45 |0.45 |0.6 |0.5 |3 |- |- |- |- |- |

|Component Table |0.45 |0.4 |0.5 |0.4 |0.5 |2 |1 |0.7 |- |- |- |- |- |

|HL7 Table |? |? |? |- |- |- |- |- |- |- |- |- |- |

|Msg Table |1.5 |2 |1 |0.55 |0.75 |- |- |- |- |- |- |- |- |

|Qry Table |2 |3.2 |- |- |- |- |- |- |- |- |- |- |- |

|Qry Table Input |0.45 |0.9 |0.55 |0.2 |0.4 |0.5 |0.2 |0.2 |0.5 |0.5 |0.6 |0.5 |0.7 |

|Qry Table Input Param |1.1 |0.7 |0.4 |4 |- |- |- |- |- |- |- |- |- |

|Qry Table DisplayLine |6 |- |- |- |- |- |- |- |- |- |- |- |- |

|Qry Table Virtual |1 |0.6 |0.2 |0.4 |0.5 |0.2 |0.4 |0.5 |0.5 |0.65 |0.7 |0.55 |- |

|Qry Table RCP |0.5 |1.5 |0.6 |0.3 |0.3 |2 |- |- |- |- |- |- |- |

|User-defined Table |? |? |? |- |- |- |- |- |- |- |- |- |- |

7 REMARKS

8 A NOTE ON HTML STYLE SHEETS

Larry devised a style sheet that uses SOME of the above styles, with suitable modifications, for applying to HTML documents. Copies of this style sheet can be found in the HTML subdirectories where the HTML copies of the Standards Guide and Implementation Guide are saved.

To imbed the style sheet into an HTML document, make sure it is copied into the same directory as that document. Then, just above the tag, type the following sequence:

Styles for Heading 1-Heading 5 are in this sheet as modified -- since HTML does not support outline numbering, numbers must be manually added.

The HL7 style “Components” is incorporated into the HTML stylesheet as “definition.”

The HL7 style “Example” is incorporated into the HTML stylesheet as “defined term.” This has been modified to be in System font rather than LinePrinter, because the font the viewer sees it in depend on the fonts available on his machine; therefore Larry thinks it advisable to only use the most common fonts.

9 Formatting Macros (Style Fixer)

This part of this document contains the macros which help formatting the HL7 standard documents. These pages provide an easy access to the macros.

In order to make use of the macros you have to enable them during loading this file.

The macros operate on open files. Therefor the document(s) onto which these macros should be applied should be opened first.

Macro Overview

|Sequence |Macro Name |Comment |

|1 |Adjust All Formats | |

|2 |Adjust Chapter Number | |

|3 |Adjust Number Gallery |I found this needs to be done manually. See section 2.8 |

|4 |Delete Unused Styles | |

|5 |Convert Message Tables into New Format | |

|6 |Add 3rd Column to Tables | |

|7 |Format All Tables |You will get an error if you do this one before Convert Message |

| | |Tables into New Format |

| |Format Reference Entries |Use hyperlinking instead. |

| |Get All Formats |It is not necessary to execute this macro |

1 Enabling Macros

If you are not prompted to enable macros when opening this document, select Tools, Macro, Security and verify that your security level is not set to High (which automatically disables all macros).

2 General Remarks

It is not such easy to do some auto-format an already formatted documents. We can try to format tables if an indication is available. We also can try to adjust the properties of styles according to the rules established by the publishing committee. But I can not guarantee that this will work in any case since Word has a built-in automatism which tries to correct the actions we execute.

Additionally some documents make intensive use of direct formatting, especially when creating numeric, alpha-numeric or bulleted lists without using the style “Normal List xxxx”.

Another fact to mention is that these macros apply a huge amount of corrections. As a result an error may occur saying that Word is not able to keep track of all changes. A possible solution is to save the file to disc.

Formatting tables assumes that the tables are “real” tables with the same number of columns each row (except conformance statements). Furthermore all cells within the same column should have the same width. If this requirement is NOT acceptable please let me know. I can change that but it would increase computation time!

So, PLEASE execute these macros on safe copy of the document!

3 Adjust the properties of the styles

This macro was generated by the help of “Get All Formats”. In contrast to it this one adjusts the properties according to the style guide.

Double click here. Whenever such a button-like frame appears, it hides the macros which can be activated by double-clicking onto the text inside!

Currently the styles for lists do not adjust the numbering or bulleting due to problems with the rest of the styles! A lot of paragraphs are formatted directly so that such an approach surprisingly displays funny results.

4 Format all Tables within the document

This macro formats all relevant tables. First of all the user is asked for the document to which the formatting should be applied. For this purpose a combo box will be displayed. After selecting the file out of the list a new dialog box will appear asking the user for the range of tables. Per default all tables are formatted, but the user can also reduce the set of tables. On ok the formatting rules will be applied to all the requested tables within this document.

Up to now I haven’t found a method to align the whole cell like it can be done by “Table->Mark whole table” and “center”, so this is left for manual correction. The correct rules are determined out of the formatting of the upper left cell of each table:

This task will take up to 5 to 10 minutes to apply the rules to all tables!

5 References

The next macro provides a dialog which allows for modifying the reference entries. It starts with a combo box for selecting the document. Next a dialog will be shown which guides through the formatting process:

This Macro applies the styles! We have decided to use hyperlinking for references. Therefore this macro will NOT work.

If the necessary character styles are not available they will be created automatically.

The button “next” searches for the next text which corresponds to the format specified in the top frame (italics or bolded) and is not formatted as a reference (at least the left part of it). According to the text found the action to be performed will be selected automatically. The user has the opportunity to modify this selection by hand. On the one hand he can modify the action to be performed. On the other hand he can expand or shrink the selected text be the help of the four buttons at the top right corner of this dialog.

The button “apply” performs the specified modification of the styles on the selected text.

At this place it is important to mention that the styles are assigned to the exact selected text. Otherwise the usage of styles becomes worthless.

6 Adjust the numbering of the headings

The numbering of the different chapters requires a manual adaptation of the corresponding properties. This macro asks for the chapter number.

This macro currently does not adjust the tab stops. Therefor this macro should be applied before the following one.

7 Adjust the Number Gallery

To use lists (alpha, numeric or roman) requires to adjust the properties of the built-in galleries. It is possible to create own ones, but it seems to be too difficult to maintain them. This macro helps to adjust the number galleries 2, 5 and 7.

8 Delete unused styles

This macro deletes all styles which are not used an more.

This task will take up to 3 hours to check each paragraph separately! It would be quicker just to delete the styles, but we want to keep the layout information we have entered so far. This is the only solution if the old and the new style are used in parallel.

9 Convert message tables into 5 column format

This macro should be used to convert the message tables into the five column format. It also reformats the table and assigns the correct styles as well as inserts the necessary headings.

The editor has to fill in the missing information by hand.

In case of the six column representation the column with the comments will be deleted. The column for the support indicator will be reused for the status information.

10 Add 3rd column to tables

This macro should be used to add a third column to the tables containing table values. It also reformats the table and assigns the correct styles as well as inserts the necessary headings.

The editor can now fill in the missing information (comments) by hand.

11 Reformat Message table

This and the next macro has been provided by Scott Robertson:

Well, this is my “standard,” segment groups are indented two spaces for each grouping. [{/{[ and }]/]} order is standardized. Segment identifiers within group line up. Unbalanced [/]/{/} are reported and stop at the point that the problem is noted (the actual problem will probably be somewhere above that point.)

Note: the result looks really ugly if you have tracking on. Accepting (or hiding) the changes shows the nice, consistent

Warning: this macro will remove any hyperlinking in the message structure

1. Place the insertion point in the message structure table to adjust (any column/row/cell)

2. Back in this document, double click on the shaded portion above

3. You will be asked to select the document

4. The message syntax will be adjusted to a standard form (left hand column of the message syntax table). While processing, the current message line will be displayed in the Status Bar at the bottom of the Work window.

12 What table is this

1. Place the insertion point in the table in question.

2. Back in this document, double click on the shaded portion above

3. You will be asked to select the document

4. The table number for the insertion point in that document will be determined and displayed in a dialog box (during the search, progress will be noted in the Status Bar at the bottom of the Word window

13 Goto a specific table

It is almost not possible to select the current table. This macro should be used to jump to a specific table according to its number. By “Try and Error” one can approach the table he/she desires. The dialog provides to complete range. Please use the left field to enter the desired number.

14 Get All Formats

This macro should be used to generate a VBA procedure which can be used to adjust the styles of other documents. This macro appends VBA-code which can be copied to a new module to the end of the document. This code allows for copying the properties listed in the style guide.

This code does not adjust the properties, it just copies the values to the document in a readable form. Therefor it is not necessary to execute it!

15 Requirements to run the macros

Running of the macros above requires VBA.

16 Manually Correcting Styles

The styles can be corrected by hand, too. Using “Format => Styles” displays a list of all used styles. Here you can modify the name of the styles by just typing in the correct name. Wherever the styles is used the new name is assigned.

17 Questions/Errors

Please let me know if there are questions or errors in applying these macros:

Frank.Oemig@

It would be helpful to submit the name of the macro and the name of the function and the line number – is possible.

18 History (last changes at the end)

• formatting column width for attribute and message tables

• setting styles for conformance statements

• additional macro to insert three columns into message table (for group names), i.e. converting into 6 column format

• additional macro to insert fourth column to HL/ and user-defined tables for comment

• additional macro to jump to a specific table (go to table)

• formatting of TOC corrected

• description of TOC added

• formatting for component table styles added

#20

• note to balloters

• preparing documents for publishing

• no component definition within the field definitions

• filename conventions

• additional guidelines and formats on lists

• new macro for adjusting the necessary gallery entries

• heading and title capitalization

#21

• adjusting definition of message tables to fit the five column representation

• adjusting the macro to convert message tables into the five column representation

• adjusting the column width for message tables in the format table macro

#22

• Joann’s comments added

• Scott’s macros added

• Increased font size for components and HL7 and User-defined table captions

#23

• introduction on how to enable macros

• new page margins

• before/after paragraph spaces adjusted to normal, note and body of tables

• setting character styles

10 Procedures

This section is intended to give some hints how to fight Word best.

1 Procedure for Troubleshooting Normal List Alpha

Clearing Number Gallery

|Step ID |Step Description |Result |Comment |

|1 |After running the macros go to the first instance of Normal | | |

| |List Alpha in your document. | | |

|2 |Highlight the first item and go to the Format tab. | |(You may optionally do |

| | | |a right click) |

|3 |Select "Bullets and Numbering" | | |

|4 |Select the Numbering tab |8 boxes will appear | |

|5 |Select each box, in turn, except for "None" and do "Reset". | | |

|6 |Select the "lower case alpha" box and go to customize | | |

|7 |On the "Customized Numbered List", set Number Position Aligned | | |

| |At to .7 | | |

|8 |Set Text Position Indent At to .9 | | |

|9 |Return to previous window and select "Okay" | |This should clear the |

| | | |"gallery" |

|10 |Go to the next instance of your Normal Alpha List | | |

|11 |If the style looks correct except for the number, select Format| | |

| |-> Bullets and Numbering-> | | |

|12 |Select the correct box (lower case alpha) and select Restart | | |

| |Numbering | | |

|13 |If the style was not correct in step 11, re-apply the style | | |

| |before going to step 13. | | |

2 Troubleshooting styles that change erratically

Problem: A change is manually applied to the Style. When the document is saved and then re-opened, the style change is lost.

Clearing Previous Templates

|Step ID |Step Description |Result |Comment |

|1 |Select Tools/Templates and Add-Ins |Templates and Add-Ins | |

| | |window will display | |

|2 |Inspect Document Template box. Delete HL73.dot if it is | |HL73.dot was the template for the previous|

| |there. | |version. |

|3 |Inspect the Automatically Update Document Styles indicator.| | |

| |It should not be activated. | | |

|4 |Select okay | |If you later return to this window you may|

| | | |find that Word has assigned the normal.dot|

| | | |template. However, this does not seem to |

| | | |interfere. The important thing is that the|

| | | |Auto Update flag is de-activated. |

|5 |Return to document and manually correct any styles that are| |In particular you may need to reset |

| |not right. | |galleries. See table above. |

3 Procedure for inserting a picture

This procedure should work for pictures, diagrams or flowcharts.

Preparing and Inserting a Picture

|Step ID |Step Description |Result |Comment |

|1 |Create and save the picture in the appropriate application, | | |

| |e.g., Visio | | |

|2 |Open the chapter and go to the place you want to insert the | |HL73.dot was the template for the |

| |picture. | |previous version. |

|3 |Choose Insert/Object/Create From File |Your visio file should| |

| | |be one of the choices | |

|4 |Open |Your picture should |It should be visible in the normal view |

| | |display. |mode. |

4 Troubleshooting the macro Format All Tables

Format All Tables: Common Errors

|Error ID |Description |Action Required |Comment |

|4605 |This command is not available |Go to Debug and read message |"ForegroundPatternColorIndex = wdAuto" |

| | | |This statement seemed to be in the General Section; |

| | | |Format Tables in a subsection on formatting borders. |

| | | |I just went on to the next macro assuming I would take |

| | | |care of the problem manually later. |

| |Query tables in my chapter |I just had to re-start the macro with a| |

| |that do not conform to the |table number past the messed up table. | |

| |standard formatting. | | |

| |the table did not have columns|This took a little more investigation. | |

| |with consistent widths. |I finally found that some of the added | |

| | |rows had an extra column at the end | |

| | |that was set to a 0" width. I had to | |

| | |insert some more rows, move the cells | |

| | |contents I wanted to keep, and then | |

| | |delete the offending rows. | |

| |"Message Table does not |Run "convert message tables into new | |

| |contain 5 columns! Abort?" |format" | |

| | |first? | |

|5941 |The requested member of the |Go to Debug | |

| |collection does not exist. | | |

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download