HL7 Publications The Publication Process

1
HL7 PublicationsThe Publication Process

• Helen Stevens
• Senior Project Manager Architecture
• McKesson Information Solutions
• HL7 Publications Committee Chair
• HL7 Canada Implementation Committee Chair
• HL7 Orders/Observations Committee Co-Chair

2
Overview

• Artifacts, Contents and Naming Conventions
• What are the parts of the HL7 ballot and their
  naming conventions?
• HL7 technical committee input
• What are the forms of content submission from the
  HL7 technical committees?
• Publication Process
• What is the process used to convert the committee
  submissions into the publication?
• Publication product
• What is the product of V3 Publication?

3
Why a naming convention?

• Artifacts are uniquely identified
• Avoids conflicts/duplicates between committees or
  working groups
• Artifact types and responsibilities are clearly
  defined and understood from the name
• Increases accuracy and efficiency in ensuring
  that correct artifacts are published properly
• High volume of artifacts and submissions being
  received from many committees to be coordinated
  centrally by publications

4
Sections

• Health Clinical
• Management of the health and clinical care of
  individuals. Includes Orders/Observations,
  Reasoning (Patient Care/Decision Support) and
  Medical Records
• Administrative
• Administrative management of health care
  enterprises, assuming a separation of duties that
  distinguishes between the provision of health and
  clinical services and the management of the
  processes whereby those services are provided.
• Infrastructure
• Information structures and communications tools
  to support the interactions specified by the
  Health Clinical and Administrative Sections.
• Focus on the logical structures used to convey
  clinical and administrative information rather
  than on the clinical or administrative
  information itself.

Section Health Clinical Management
Section Administrative Management
Section Infrastructure Management
5
Artifact Naming

• All artifacts delivered for V3 must be named
  using the following convention
• SSUU_DD_AAnnnnn
• SS Section code
• UU Sub-Section code
• DD Domain code
• AA Artifact or Document code
• nnnnn Five digit zero-filled number assigned by
  Domain. Domain may assign this number in any way
  they wish to organize their artifacts.
• Example
• HMPO_RX_AR00001
• Health Clinical Section, Practices
  Operations Sub-Section, Pharmacy Domain,
  Application Role Artifact number 00001.

6
Section, Sub-Section Domain Codes
AM Section Administrative Management Section Administrative Management Section Administrative Management
PR Sub-Section Practice Sub-Section Practice
PA Domain Patient Administration
SC Domain Scheduling
FI Sub-Section Financial Sub-Section Financial
FM Domain Financial Management
CR Domain Claims Reimbursement
AB Domain Accounting Billing
HM Section Health Clinical Management Section Health Clinical Management Section Health Clinical Management
PO Sub-Section Practice Operations Sub-Section Practice Operations
LB Domain Laboratory
RX Domain Pharmacy
RE Sub-Section Reasoning Sub-Section Reasoning
PC Domain Patient Care
RC Sub-Section Records Sub-Section Records
MR Domain Medical Records
IM Section Infrastructure Management Section Infrastructure Management Section Infrastructure Management
CO Sub-Section Control Sub-Section Control
MC Domain Message Control
MF Domain Master File Update
QU Sub-Section Query Sub-Section Query
QD Domain Query
Applicable to all sub-sections Applicable to all sub-sections
XX Non Domain Specific
CM CMET
7
Section, Sub-Section Domain Codes
8
Artifact Document Codes
9
Sample Committee Naming SchemeSubmitted by
Michael Van Campen, HL7 Canada
RIM
HL7
e-Claims DIM RM00000
Superset of all RMIMs
etc.
Superset of all HMDs
E01 RMIM RM01000
E02 RMIM RM02000
etc.
Generic HMD HD01000
Pharmacy HMD HD01100
Laboratory HMD HD01200
Generic Laboratory MT MT01200
Generic Pharmacy MT MT01100
Payor2 MT MT01002
Payor1 MT MT01001
Generic MT MT01000
Payor2 MT MT01202
Payor1 MT MT01201
Payor2 MT MT01102
Payor1 MT MT01101
etc.
etc.
etc.
10
Overview

• Artifacts, Contents and Naming Conventions
• What are the parts of the HL7 ballot and their
  naming conventions?
• HL7 technical committee input
• What are the forms of content submission from the
  HL7 technical committees?
• Publication Process
• What is the process used to convert the committee
  submissions into the publication?
• Publication product
• What is the product of V3 Publication?

11
Committee Deliverables

• Domain Database
• Application Roles
• Interaction Categories
• Storyboards Examples
• Trigger Events
• Interactions
• R-MIM, HMD and Message Type Descriptions
• Diagrams
• Refined Message Information Models (R-MIM)
• Storyboard Interaction Diagrams
• Other Diagrams
• Design Repository
• R-MIM
• Hierarchical Message Descriptors (HMD)
• Message Types
• XML Narrative Introductions

12
Domain Database

• MS Access database developed by Austin Kriesler
  (McKesson) for HL7 to help the technical
  committees to manage 3.0 artifacts and
  documentation
• One database for each publication domain
• Contains all content except for extended
  narratives, diagrams and Rose Tree generated
  messages

13
Domain introduction
Application Roles
14
Interaction Categories
Trigger Events
15
Storyboards
Interactions
16
R-MIM HMD Descriptions
17
RMIM Diagrams

• VISIO diagrams generated using HL7 Stencil
  developed by Lloyd McKenzie (HL7 Canada) to
  document RMIM designs
• One diagram for each RMIM developed

18
General Orders Status Change RMIM
19
Other Diagrams

• Storyboard interaction diagrams are required to
  support each storyboard submitted
• Other diagrams may also be developed to support
  narrative content or provide additional value to
  the content.

• Recommend use of VISIO to build and maintain all
  diagrams

20
Storyboard Interaction Diagram
21
Repository Database

• MS Access database developed by Woody Beeler
  (Beeler Consulting) to store message designs
  including RIM, RMIM, HMD, and Message Types that
  are generated by Rosetree
• One or more databases for each domain

22
Repository Screenshot (Rosetree)
HMD
Common HMD
Message Types
23
Converting VISIO to Repository

• Using HL7 menu in VISIO R-MIM diagrams can be
  automatically verified against current RIM and
  converted into Rosetree Repository

24
XML Narratives

• Narratives maintained and submitted in XML for
  Sub-Section or Domain introductions.
• Publications committee will perform initial
  conversion from Word to XML, but document must be
  maintained in XML unless specific arrangement
  made with publications.
• Required when introductions includes diagrams,
  tables or formatted text that cannot be entered
  into the Domain Database directly.

25
TC Submissions

• Submissions from TCs for V3 must be in files
  named as follows
• Repository Database SSUU_DD_RPnnnnn.mdb
• RMIM Diagram(s) SSUU_DD_RMnnnnn.vsd
• (one diagram per file)
• Storyboard Diagram(s) SSUU_DD_STnnnnn.vsd
• (one diagram per file)
• Publication/ Domain Database SSUU_DD_PBnnnnn.mdb
• Narrative Documents SSUU_DD_NAnnnnn.mdb
• Submit Files to http //www.hl7.org/v3
• If an update to a file must be submitted, then it
  should be named exactly the same as the original
  file. HQ will automatically add a timestamp to
  received files and keep all historical files.

26
Overview

• Artifacts, Contents and Naming Conventions
• What are the parts of the HL7 ballot and their
  naming conventions?
• HL7 technical committee input
• What are the forms of content submission from the
  HL7 technical committees?
• Publication Process
• What is the process used to convert the committee
  submissions into the publication?
• Publication product
• What is the product of V3 Publication?

27
Publication Format

• Publication in two final formats
• PDF
• appropriate for printing, submission to ANSII and
  off-line viewing
• Each document available as stand alone or will
  be inter-linked
• HTML
• Appropriate for viewing online
• Each document can be downloaded separately
• Backbone is required

28
Using XML

• All documentation will be converted from XML into
  PDF and HTML
• Primary source of truth for normative content
  is the HL7 Repository.
• HL7 Repository is Microsoft Access database.

29
Publication Process

• Build the Master Repository Database
• Build the Master Domain Database
• Note currently publication uses two master
  databases, in future this may be merged to be the
  same database.
• Convert Diagrams
• Generate Publication from Databases
• Section content (Repository Domain Db)
• Reference Information Model
• Vocabulary
• Generate other publication documents

30
Build Master Repository
Master Repository (DMIM/RMIM/HMD/MT)

1. Verify VISIO diagrams against repository database
   contents
2. Verify repository database is self-consistent
   (names, duplicates etc.)
3. Merge repositories and migrate to Master
   repository containing RIM Vocabulary

31
Build Master Domain
Master Domain Db

1. Verify VISIO other diagrams against domain
   database contents
2. Verify domain database is self-consistent (names,
   duplicates etc.)
3. Use RepLinker to import domain databases into
   blank Master DomainDb

32
Convert Diagrams

• HL7 publishes using GIF format diagrams
• All diagrams are saved-as GIF from VISIO (or any
  other submitted format) and cropped appropriately
• This is currently a manual process

Save-As
Crop
33
Generating HTML and PDF
Master Repository (DMIM/RMIM/HMD/MT)
XML Extract
DTD
XML Document
Transform
Transform
Base HTML XSL
Base fo (PDF) XSL
Document Specific HTML XSL
Document Specific fo (PDF) XSL
HTML Files
Formatting Objects(fo) XML File
Render
XEP Program
PDF Files
RenderX Corp.
34
Generating HTML and PDF
Master Repository RMIM/HMD/MT
Master Repository - RIM
35
Generating HTML and PDF
Master Repository RMIM/HMD/MT
Master Repository - RIM
Master Repository - Vocabulary
36
Generating HTML and PDF
Master Repository RMIM/HMD/MT
Master Repository - RIM
Master Repository - Vocabulary
Master Domain Database
XML Narratives
37
Generating HTML and PDF
Master Repository RMIM/HMD/MT
Master Repository - RIM
Master Repository - Vocabulary
Master Domain Database
XML Documents Data Types 1 and 2 XML
Implementation Technology Spec V3 Publication
Backbone V3 Guide
38
Overview

• Artifacts, Contents and Naming Conventions
• What are the parts of the HL7 ballot and their
  naming conventions?
• HL7 technical committee input
• What are the forms of content submission from the
  HL7 technical committees?
• Publication Process
• What is the process used to convert the committee
  submissions into the publication?
• Publication product
• What is the product of V3 Publication?

39
HL7 3.0 Core Publication Structure
Reference Content is harmonized during HL7
meetings or approved by the HL7 Board. It is not
subject to ballot acceptance

• V3 Backbone
• Welcome
• Introduction
• V3 Principles
• Quick Start
• Getting Started
• Glossary

Informative Content is balloted by general
membership however, it is not considered to be a
structural part of the standard, only supporting
information.
Normative Content is balloted by general
membership and is considered structural component
of HL7 standard. Negative ballots MUST be
resolved.
Implementable Technology Specifications
XML
Data Types
Data Types
Part I
Part II
Section Infrastructure Management
Sub-sections
Legend
Section Health Clinical Management
Reference
Sub-sections
Informative
Section Administrative Management
Normative
Sub-sections
40
HL7 3.0 Section Publication Structure
CMET
R-MIM
HMD
Message Type
Sub-sections
Domain
Application Roles
R-MIM
HMD
Message Type
Storyboard
Interaction Category
Storyboard Examples
Legend
Reference
Trigger Event
Informative
Normative
Interaction
41
V3 Backbone

• Introduction
• Principles
• Managing message development
• Quick Start
• Getting Started
• Glossary
• Links to all other documents content.
• Differing entry points for different users
• New Implementer
• Project Manager / Manager / Marketer
• Interface Developer / Analyst / Programmer
• Standards Developer

• V3 Backbone
• Welcome
• Introduction
• Quick Start
• Getting Started
• Glossary

42
HL7 V3 Guide

• Instruction manual for understanding the V3
  Ballot and Specification
• Overview and Metamodel
• Storyboards
• Information Model
• Vocabulary
• Interaction Model
• Conformance
• Message Specification
• Replaces Message Development Framework in
  publication.
• Focus on the ballot publication, not development
  methodology.

HL7 V3 Guide
43
Sections

• Health Clinical
• Management of the health and clinical care of
  individuals. Includes Orders/Observations,
  Reasoning (Patient Care/Decision Support) and
  Medical Records
• Administrative
• Administrative management of health care
  enterprises, assuming a separation of duties that
  distinguishes between the provision of health and
  clinical services and the management of the
  processes whereby those services are provided.
• Infrastructure
• Information structures and communications tools
  to support the interactions specified by the
  Health Clinical and Administrative Sections.
• Focus on the logical structures used to convey
  clinical and administrative information rather
  than on the clinical or administrative
  information itself.

Section Health Clinical Management
Section Administrative Management
Section Infrastructure Management
44
Final HTML Presentation

• New HL7 look feel using green/blue colour
  scheme
• Pull down menus for quick navigation
• Specific help documentation and access to
  discussion boards to support membership reviews

45
E-Claims Demonstration

• Michael van Campen
• E-claims TAG Chair
• Technical Architecture Group
• HL7 PAFM TC Co-chair (acting)
• Responsible for Financial Management

46
Next Release Plans

• Improved download/distribution system
• Improved faster menus
• Improved graphic presentation
• Improved HMD Message Type presentation
• PDF for Vocabulary and HMD
• Examples
• Increased hyper linking
• On-line help files
• Possibly on-line automated balloting tool
• More feedback and contributions welcome!

47
Anticipated Schedule
Committee Ballot 1
Committee Ballot 1 Review
Ballot 2 Development
Committee Ballot 2
Committee Ballot 2 Review
Membership Ballot
Membership Ballot Review
V3.0 Release
48
Questions ?