Transcript Document

HL7 Publications
The 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
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?
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
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 SubSection, Pharmacy Domain, Application Role Artifact
number 00001.
Section, Sub-Section &
Domain Codes
AM
Section: Administrative Management
PR
HM
Section: Health & Clinical Management
PO
RE
Sub-Section: Practice & Operations
PA
Domain: Patient Administration
SC
Domain: Scheduling
Sub-Section: Financial
LB
Domain: Laboratory
FM
Domain: Financial Management
RX
Domain: Pharmacy
CR
Domain: Claims & Reimbursement
AB
Domain: Accounting & Billing
Sub-Section: Reasoning
PC
RC
FI
Sub-Section: Practice
Domain: Patient Care
Sub-Section: Records
MR
Domain: Medical Records
IM
Section: Infrastructure Management
CO
Applicable to all sub-sections
XX
Non Domain Specific
CM
CMET
QU
Sub-Section: Control
MC
Domain: Message Control
MF
Domain: Master File Update
Sub-Section: Query
QD
Domain: Query
Section, Sub-Section &
Domain Codes
Code
Section
Code
AM
HM
IM
Administrative Management
Health & Clinical Management
Infrastructure Management
AB
CM
CR
FM
LB
MC
MF
MR
PC
QD
RX
SC
XX
Code
CO
FI
PA
PO
PR
QU
RC
RE
Sub-Section
Control
Financial
Patient Administration
Practice & Operations
Practice
Query
Records
Reasoning
Domain
Accounting & Billing
CMET Domain
Claims & Reimbursement
Financial Management
Laboratory
Message Control
Master File Update
Medical Records
Patient Care
Query
Pharmacy
Scheduling
Non-Domain specific Domain
Artifact & Document Codes
Code
AR
CT
HD
IC
IN
NA
RM
ST
SX
TE
Artifact
Application Role
Common Message Type
HMD
Interaction Category
Interaction
Narrative Content
R-MIM
Storyboard
Storyboard Example
Trigger Event
Code
BB
DT
IT
PB
RI
RP
VG
VO
Document
Backbone
Data Types
ITS
Publication/Domain Database
RIM
Repository Database
V3 Guide
Vocabulary
Sample Committee Naming Scheme
Submitted by: Michael Van Campen, HL7 Canada
RIM
DIM (RM)
RMIM (RM)
HMD (HD)
MT (MT)
RIM
HL7
Superset of all RMIMs
Legend
e-Claims
DIM
[ RM00000 ]
Naming convention: AARRHMM, where
• AA is the artifact code (RM, HD, MT),
• RR is the RMIM id,
• H is the HMD id,
• MM is the MT id.
etc.
Superset of all HMDs
E01 RMIM
[ RM01000 ]
- Reference Information Model
- Domain Information Model
- Refined Message Info Model
- Hierarchical Message Defn.
- Message Type (message)
E02 RMIM
[ RM02000 ]
RMIM:
Digits 1,2
[ 00 = Super RMIM
01 = E01
02 = E02
etc. ]
etc.
HMD:
etc.
Payor2 MT
[ MT01202 ]
Digit 3
[ 0 = Generic
1 = Pharmacy
2 = Laboratory
etc. ]
Payor1 MT
[ MT01201 ]
Generic
Laboratory MT
[ MT01200]
etc.
Laboratory HMD
[ HD01200 ]
Payor2 MT
[ MT01102 ]
Payor1 MT
[ MT01101 ]
Pharmacy HMD
[ HD01100 ]
Generic
Pharmacy MT
[ MT01100]
etc.
Payor2 MT
[ MT01002 ]
Payor1 MT
[ MT01001 ]
Generic MT
[ MT01000]
Generic HMD
[ HD01000 ]
MT:
Digits 4,5
[ 00 = Generic
01 = Payor1
02 = Payor2
etc. ]
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?
Committee Deliverables
1.
Domain Database



2.
Diagrams



3.
Refined Message Information Models (R-MIM)
Storyboard Interaction Diagrams
Other Diagrams
Design Repository



4.
Application Roles
Interaction Categories
 Storyboards & Examples
 Trigger Events
 Interactions
R-MIM, HMD and Message Type Descriptions
R-MIM
Hierarchical Message Descriptors (HMD)
Message Types
XML Narrative Introductions
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
Domain introduction
Application Roles
RMIM Diagrams
 VISIO diagrams generated using HL7
Stencil developed by Lloyd McKenzie
(HL7 Canada) to document RMIM
designs
 One diagram for each RMIM
developed
Cons traint:
invariant( x) {
x.;
}
At least one occurrence must
have a type_cd of AUT
C hoice
CMET:
Detailed_IHCP
CMET:
Ident_IHCP
General Orders Status Change
RMIM
Implementation suggestion:
If note_txt is present, an
application should display an
indicator, and allow the user to
view the full text on request.
P_responsible_parties
type_cd <= AUT, VRF, SPV or ANT*
tmr: (time of c reation, verific ation,
attestation or annotation)
note_txt:
mode_cd:
signature_cd:
signature_txt:
status_cd <= ACTIVE or COMPLETE
1..*
P_data_entry
type_cd <= ENT
tmr: (time recorded)
0..1
P_call_back_contact
type_cd <= CBC
tmr: (availability time)
0..*
Cons traint:
invariant( x) {
x.;
}
For 'change' orders:
If Order.id is null, patient participation
(with id or name, DOB, and Gender)
and Order.code must be specified.
Otherwise, this information is not
required. If specified, it must
correspond with the specified
Order.id.
Cntrl_msg_interaction
class_cd <= MSGE
mood_cd <= EVN
cd: (Event code)
effective_time:
txt:
id:
priority_cd:
language_cd:
C hoice
CMET:
Detailed_patient
CMET:
Ident_patient
P_patient
type_cd <= PAT
CMET:
Location
P_entering_location
type_cd <= ELOC*
CMET:
Used_device
P_entering_device
type_cd <= ODV
AR_targets
type_cd <= ITGT*
0..1
0..1
0..1
0..*
AR_Reason
type_cd <= RSON
Observ ation
class_cd <= OBS
mood_cd <= INT or EVN
cd:
id:
value: (reason)
txt: (additional information)
1..*
Order
class_cd <= ACT
mood_cd <= ORD
id: SET <II>
(placer number, filler number, etc.)
cd:
confidentiality_cd:
txt:
AR_instantiates 0..1
type_cd <= INST
Confidentiality_cd; txt
gone for tightl y_coupled
AR_encounter
type_cd <= COMP
CMET:
Encounter_ref
0..1
P_responsible_parties
type_cd <= AUT
tmr: (time of c reation)
1..*
Substance_admin_master
class_cd <= SBADM*
mood_cd <= DEF
id: (catalogue #)
C hoice
CMET:
Detailed_IHCP
CMET:
Ident_IHCP
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
Storyboard Interaction Diagram
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
Repository Screenshot (Rosetree)
HMD
Common HMD
Message Types
Converting VISIO to Repository
 Using HL7 menu in VISIO R-MIM
diagrams can be automatically verified
against current RIM and converted
into Rosetree Repository
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.
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.
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?
Publication Format
Publication in two final formats:
1. PDF
 appropriate for printing, submission to
ANSII and off-line viewing
 Each document available as ‘stand alone’
or will be inter-linked *
2. HTML
 Appropriate for viewing online
 Each document can be downloaded
separately *
* Backbone is required
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.
Publication Process
1.
2.
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.
3.
4.
Convert Diagrams
Generate Publication from Databases



5.
Section content (Repository + Domain Db)
Reference Information Model
Vocabulary
Generate other publication documents
Build Master Repository
Master Repository
1.
2.
3.
(DMIM/RMIM/HMD/MT)
Visio
files
Visio
files
Visio
files
Visio
Visiofiles
files
1
Verify
Migrate
repositories
3
Merge
repositories
Post
Verify VISIO diagrams against
repository database contents
Verify repository database is selfconsistent (names, duplicates etc.)
Merge repositories and migrate to
Master repository containing RIM &
Vocabulary
Repository
Repository
Repository
Database
Repository
Database
Repository
Database
Database
Database
2
Verify
Build Master Domain
Master Domain Db
1.
2.
Visio
files
Visio
files
Visio
files
Visio
Visiofiles
files
1
Verify
RepLinker
Importer
3
Post
3.
Verify VISIO & other diagrams
against domain database contents
Verify domain database is selfconsistent (names, duplicates etc.)
Use RepLinker to import domain
databases into blank Master
DomainDb
Domain
Domain
Domain
Database
Domain
Database
Domain
Database
Database
Database
2
Verify
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
Visio
files
Visio
files
Visio
files
Visio
Visiofiles
files
Save-As
Crop
GIF
files
GIF
files
GIF
files
GIF
GIFfiles
files
Generating HTML and PDF
Master Repository
(DMIM/RMIM/HMD/MT)
DTD
XML Extract
XML Document
Base HTML XSL
Base fo (PDF) XSL
Document Specific
HTML XSL
Document Specific
fo (PDF) XSL
Transform
Transform
Formatting Objects(fo) XML File
HTML Files
XEP* Program
PDF Files
Render
*RenderX Corp.
Generating HTML and PDF
MasterMaster
Repository
Repository
– RMIM/HMD/MT
- RIM
DTD
XML Extract
XML Document
Base HTML XSL
Base fo (PDF) XSL
Document Specific
HTML XSL
Document Specific
fo (PDF) XSL
Transform
Transform
Formatting Objects(fo) XML File
HTML Files
XEP* Program
PDF Files
Render
*RenderX Corp.
Generating HTML and PDF
Master
Master
Master
Repository
Repository
Repository
– RMIM/HMD/MT
- Vocabulary
- RIM
DTD
XML Extract
XML Document
Base HTML XSL
Base fo (PDF) XSL
Document Specific
HTML XSL
Document Specific
fo (PDF) XSL
Transform
Transform
Formatting Objects(fo) XML File
HTML Files
XEP* Program
PDF Files
Render
*RenderX Corp.
Generating HTML and PDF
Master
Master
Master
Master
Repository
Repository
Domain
Repository
– RMIM/HMD/MT
-Database
Vocabulary
- RIM
DTD
XML
Narratives
XML Extract
XML Document
Base HTML XSL
Base fo (PDF) XSL
Document Specific
HTML XSL
Document Specific
fo (PDF) XSL
Transform
Transform
Formatting Objects(fo) XML File
HTML Files
XEP* Program
PDF Files
Render
*RenderX Corp.
Generating HTML and PDF
XML
Documents
Master
Master
Master
Master
Repository
Repository
Domain
Repository
– RMIM/HMD/MT
-Database
Vocabulary
- RIM
Data Types 1 and 2
DTDTechnology Spec
XML Implementation
V3 Publication Backbone
XML
V3 Extract
Guide
XML Document
Base HTML XSL
Base fo (PDF) XSL
Document Specific
HTML XSL
Document Specific
fo (PDF) XSL
Transform
Transform
Formatting Objects(fo) XML File
HTML Files
XEP* Program
PDF Files
Render
*RenderX Corp.
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?
HL7 3.0 Core Publication
Structure
V3 Guide
Reference
Information
Model
V3 Backbone
•Welcome
•Introduction
•V3 Principles
•Quick Start
•Getting Started
•Glossary
Literary Expression
RIM Diagram
State Machines
Vocabulary
Implementable
Technology
Specifications
XML
Data Types
Part I
Reference: Content is harmonized
during HL7 meetings or approved by
the HL7 Board. It is not subject to
ballot acceptance
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.
Data Types
Part II
Section
Infrastructure
Management
Sub-sections
Legend:
Section
Health & Clinical
Management
Sub-sections
Section
Administrative
Management
Sub-sections
Reference
Informative
Normative
HL7 3.0 Section Publication
Structure
CMET
R-MIM
Domain
Application
Roles
HMD
Message Type
HMD
Message Type
Sub-sections
R-MIM
Legend:
Interaction
Category
Storyboard
Reference
Informative
Trigger Event
Normative
Interaction
Storyboard
Examples
V3 Backbone
1.
2.
3.
4.
5.
6.
7.
V3 Backbone
•Welcome
•Introduction
•Quick Start
•Getting Started
•Glossary
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
HL7 V3 Guide
 Instruction manual for understanding
the V3 Ballot and Specification
1.
2.
3.
4.
5.
6.
7.
HL7 V3 Guide
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.
Sections
Section
Health & Clinical
Management
Section
Administrative
Management
Section
Infrastructure
Management
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.
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
E-Claims Demonstration
Michael van Campen
E-claims TAG Chair
Technical Architecture Group
HL7 PAFM TC Co-chair (acting)
Responsible for Financial Management
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!
Anticipated Schedule
Salt Lake
October 2001
San Diego
January 2002
Atlanta
April 2002
Baltimore
September 2002
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
Questions ?