DRAFT
Version 3 Publication Outline
Catalog of Version 3 Documents .................................................................................................. 3
General Introduction .................................................................................................................... 3
Catalog ......................................................................................................................................... 4
Message Development Framework .............................................................................................. 5
General Introduction .................................................................................................................... 5
Glossary Of Version 3 Terms And Acronyms ............................................................................. 5
Principles Of Version 3................................................................................................................ 5
Managing Message Development ................................................................................................ 5
Use Case Model ........................................................................................................................... 5
Information Model ....................................................................................................................... 5
Associating Vocabulary Domains With Attributes, Elements And Fields .................................. 5
Interaction Model......................................................................................................................... 5
Conformance Claims And Organizational Practices ................................................................... 5
Creating Message Specifications ................................................................................................. 5
Developing HL7 Models Using UML Rational Rose................................................................. 5
Example Model For MDF............................................................................................................ 5
Specification Of The HL7 MDF Components ............................................................................. 5
Reference Information Model ...................................................................................................... 6
General Introduction .................................................................................................................... 6
A.
Scope ............................................................................................................................. 6
B.
Dependencies ................................................................................................................ 6
Graphical Expression ................................................................................................................... 6
A.
General Introduction ..................................................................................................... 6
B.
Information Model ........................................................................................................ 6
Literary Expression ...................................................................................................................... 6
A.
General Introduction ..................................................................................................... 6
B.
Literary Representation ................................................................................................. 6
HL7 Vocabulary Domains ............................................................................................................ 7
General Introduction .................................................................................................................... 7
Domain ........................................................................................................................................ 7
A.
General Introduction ..................................................................................................... 7
B.
Concept enumeration..................................................................................................... 7
Version 3 General Information .................................................................................................... 8
General Introduction .................................................................................................................... 8
Glossary ....................................................................................................................................... 8
Message Types............................................................................................................................. 8
A.
Message Element Metatypes ......................................................................................... 8
B.
Data Types..................................................................................................................... 8
Communications Models ............................................................................................................. 8
Security ........................................................................................................................................ 8
Specifications for an Implementable Technology Specification ................................................. 9
Version 3 Message Set ................................................................................................................. 10
General Introduction .................................................................................................................. 10
Dependencies. ............................................................................................................................ 10
Thoughts on a Publication Format for V3 Messaging
1
January 10, 2001
DRAFT
Domain Model ........................................................................................................................... 10
Domain Definition: X .................................................................................................................. 11
General Introduction .................................................................................................................. 11
A.
Scope ........................................................................................................................... 11
B.
Dependencies .............................................................................................................. 11
C.
Actors .......................................................................................................................... 11
D.
Application roles ......................................................................................................... 11
E.
State Transition Diagram(s) ........................................................................................ 11
1. General Introduction ................................................................................................... 11
2. Literary Representation ............................................................................................... 11
3. Graphical Representation ............................................................................................ 11
Storyboards ................................................................................................................................ 11
A.
General Introduction ................................................................................................... 11
B.
Storyboard: XXX ........................................................................................................ 11
1. General Introduction ................................................................................................... 11
2. Literary Representation ............................................................................................... 11
3. Graphical Representation ............................................................................................ 11
Trigger Events............................................................................................................................ 12
A.
General Introduction ................................................................................................... 12
B.
Trigger Event: XXX .................................................................................................... 12
1. General Introduction ................................................................................................... 12
2. Graphical Representation ............................................................................................ 12
3. Interactions .................................................................................................................. 12
Message Design: XXX .............................................................................................................. 12
A.
General Information .................................................................................................... 12
B.
R-MIM:XXX ............................................................................................................... 12
1. UML Diagrams or Gunther Visio Representation....................................................... 13
2. HMD:XXX .................................................................................................................. 13
Implementable Technology Specification.................................................................................. 14
General Introduction .................................................................................................................. 14
ITS: XML .................................................................................................................................. 14
Thoughts on a Publication Format for V3 Messaging
2
January 10, 2001
DRAFT
Catalog of Version 3 Documents
A listing of the current version of all documents that are required to have a complete set of the version 3
standard.
Format: Single document, not normative.
Dependency: republished whenever any other document is published.
General Introduction
Welcome to the HL7 V3 Catalog. Use this catalog as your guide to the next generation of HL7
Standards. This page is a comprehensive guide to the HL7 V3 Standard. Each document link below
will provide you with the information you need to understand, build, sell or buy HL7 V3 compliant
messages with ease and confidence.
Intended Audience
The HL7 V3 Catalog has something for everyone interested in learning about the HL7 V3 Standard.
Look for special tips located though out these pages to help pinpoint the documents (and even the
chapters within those documents) that help you gather the HL7 V3 knowledge base you need to
succeed in health industry computing.
Information Sources
Message Development Framework - The Message Development Framework (MDF) is the
cornerstone of the HL7 V3 Methodology. This document has something to offer every user. Use
this document to understand the why's, what's and how's of HL7 V3.
Tip
New HL7 Users
Review the introductory chapters to help you understand the principles surrounding
HL7 V3. Once you understand the concepts the rest of the MDF will provide you
details regarding the complete development lifecycle of an HL7 V3 message.
Managers, Project
Managers, Product
Managers, and
Marketing
You need to understand the background and general mechanics of the HL7 V3
Methodology. You may not be interested in all the details of creating an HL7 V3
message. Concentrate on the first few introductory chapters, as well as
Conformance Claims and Organizational Practices. Take a few minutes and review
the Creating Message Specifications chapter. You don't need to worry about all the
details, but it will help you understand how the pieces of the methodology all fit
together.
Interface Analysts
and Programmers
Review this document to get an understanding of how the HL7 V3 methodology fits
together. Concentrate your efforts on learning the V3 Terms and Acronyms and on
the Creating Message Specifications chapter.
HL7 Standards
Developers
If you plan to get involved in the creation of HL7 Standards by attending the HL7
Working Group meetings, be sure to read this document thoroughly. This the HL7
Standards creation process followed at the HL7 meetings.
Thoughts on a Publication Format for V3 Messaging
3
January 10, 2001
DRAFT
Reference Information Model - The Reference Information Model (RIM) is the foundation of
the HL7 V3 Methodology. The RIM is a coherent, share information model that is the source for the
data content of all HL7 messages. HL7 is the only Standards Development Organization (SDO) to
have a single, unified model encompassing all the elements of each of its working groups. The RIM
is available in two forms: a graphical expression or a literary expression. The RIM graphical
expression displays all the classes, attributes, and relationships in Unified Modeling Language
(UML) notation. The RIM graphical expression is supported within Rational Rose CASE tool. The
RIM literary expression displays the same information as the graphical expression in a textual
representation.
Tip
Experienced
Structured or
Object Data
Modeler
Review the RIM graphical model. (Do you need Rose to do this?) Refer to MDF
Chapter 5 - Information Model for educational information regarding HL7
Information Models.
Description of the document and its contents; ordering information.
Maintenance method: formatted section.
Catalog
Actual listing of documents, versions, publication dates, prices.
Maintenance method: structured section.
Thoughts on a Publication Format for V3 Messaging
4
January 10, 2001
DRAFT
Message Development Framework
This document already exists and is included here for completeness only.
General Introduction
Glossary Of Version 3 Terms And Acronyms
Principles Of Version 3
Managing Message Development
Use Case Model
Information Model
Associating Vocabulary Domains With Attributes, Elements And Fields
Interaction Model
Conformance Claims And Organizational Practices
Creating Message Specifications
Developing HL7 Models Using UML Rational Rose
Example Model For MDF
Specification Of The HL7 MDF Components
Thoughts on a Publication Format for V3 Messaging
5
January 10, 2001
DRAFT
Reference Information Model
General Introduction
General introduction to the RIM including historical information etc.
Maintenance method: formatted section.
A.
Scope
Maintenance method: formatted section.
B.
Dependencies
Identification of other HL7 documents that must be used in order to apply this document, and the
range of version numbers that may be used.
Maintenance method: structured section.
Graphical Expression
There are substantial publishing challenges here.
A.
General Introduction
Maintenance method: formatted section.
B.
Information Model
Maintenance method: structured section.
Literary Expression
A.
General Introduction
Maintenance method: formatted section.
B.
Literary Representation
Maintenance method: structured section.
Thoughts on a Publication Format for V3 Messaging
6
January 10, 2001
DRAFT
HL7 Vocabulary Domains
Multiple documents in this category, as determined by the Vocabulary TC.
Normative, where HL7 has the authority to define the concepts involved.
General Introduction
Maintenance method: formatted section.
Domain
One or more of these sections will appear with the Related Domains Section. Some sections will
enumerate values, other will describe how the specific subsets of concepts may be obtained from
other organizations.
A.
General Introduction
Maintenance method: formatted section.
B.
Concept enumeration
When present, this material may be used as an example; normative definition of HL7 domains are
published separately.
Maintenance method: structured section.
Thoughts on a Publication Format for V3 Messaging
7
January 10, 2001
DRAFT
Version 3 General Information
Information that does not vary from one message set to the next.
Format: Single document, contains normative sections.
Dependency: republish whenever changes are required to support changes in standard message definitions.
Maintain prior versions in the catalog as long as any currently valid message type is dependent on this
version.
General Introduction
History, purpose, process, what are the other documents, how are they developed and how to read
them.
Maintenance method: formatted section.
Glossary
Maintenance method: Structured section
Message Types
Non-ITS-specific description of the elements of a message type.
Maintenance method: formatted section.
A.
Message Element Metatypes
Description of the metatypes of a message.
Examples.
B.
Data Types
Description of the accepted data element types . It includes those aspects of message security,
integrity, and privacy that are appropriately defined at the data type level.
Communications Models
One or more object models that define the entities involved in communications and communications
modes in an ITS-independent manner. It includes those aspects of message security, integrity, and
privacy that are appropriately defined at the message level.
Maintenance method: formatted section.
Security
General recap of security requirements, including aspects that are not covered in other sections.
Maintenance method: formatted section.
Thoughts on a Publication Format for V3 Messaging
8
January 10, 2001
DRAFT
Specifications for an Implementable Technology Specification
General enumeration of the topics that must be covered in a complete ITS.
Maintenance method: formatted section.
Not normative.
Thoughts on a Publication Format for V3 Messaging
9
January 10, 2001
DRAFT
Version 3 Message Set
This is the primary Version 3 Publication and includes all the information necessary to implement the
standard including use cases, interactions, application roles and message definitions.
Because this document is generated on request the use may select to generate any appropriate section of the
document.
General Introduction
Maintenance method: formatted section.
Dependencies.
Identification of other HL7 documents that must be used in order to apply this document, and the
range of version numbers that may be used.
Maintenance method: structured section.
Domain Model
This section will list the domains available within HL7 and will include a hyperlink to the Domain
Definition section.
Domains will replace the HL7 V2.x model of chapters and will be more specific sub-categories of
the HL7 scope. Example domains include Pharmacy, Patient Care, Patient Administration, Finance
Model 1 (USA) , Finance Model 2 (Canada) etc.
Maintenance method: structured section
Thoughts on a Publication Format for V3 Messaging
10
January 10, 2001
DRAFT
Domain Definition: X
This section will repeat for each domain identified in the domain list in the introduction.
General Introduction
A.
Scope
Maintenance method: formatted section.
B.
Dependencies
Maintenance method: formatted section
C.
Actors
Maintenance method: formatted section
D.
Application roles
Maintenance Method: structured section.
E.
State Transition Diagram(s)
1. General Introduction
Maintenance method: formatted section.
2. Literary Representation
Maintenance method: formatted section.
3. Graphical Representation
Maintenance method: structured section.
Storyboards
This section will provide graphical and literary representations of the message flow for this domain.
The purpose of this section is to unambiguously define the usage of the trigger events and
interactions between systems. Hyperlinks to specific trigger events within the domain from the
diagrams will be desirable.
A.
General Introduction
Maintenance method: formatted section.
B.
Storyboard: XXX
1. General Introduction
Maintenance method: formatted section.
2. Literary Representation
Maintenance method: formatted section.
3. Graphical Representation
Maintenance method: structured section.
Thoughts on a Publication Format for V3 Messaging
11
January 10, 2001
DRAFT
Trigger Events
A.
General Introduction
This will provide general information of the organization of the trigger events. Section may
include table listing trigger events with hyper link to trigger even sections below.
Maintenance method: formatted section.
B.
Trigger Event: XXX
A section will exist for each trigger event in the domain and will be hyper linked to the message
flow and state transition models above.
1. General Introduction
Maintenance method: formatted section.
Non normative.
2. Graphical Representation
Maintenance method: structured section.
May include lightly formatted subsections with normative comments.
3. Interactions
A table will exist for each interaction associated with the trigger event.
Trigger Event
XXX: New Order Request
Interaction:
New Physician Order Request
Description:
Initial request for a new order from the order placer (Physician) to the
order filler (laboratory)
Sending Application Role:
Laboratory Order Placer
Receiving Application Role:
Laboratory Results Creator
Receiver Responsibilities:
Determine if order is acceptable and acknowledge with acceptance
or rejection.
Assign Filler identification if order is acceptable.
Message Type:
Insert link to HMD
Maintenance method: structured section.
May include lightly formatted subsections with normative comments.
Message Design: XXX
This section repeats for each message design referenced in this domain
A.
General Information
This section contains a brief description of message design.
B.
R-MIM:XXX
This section repeats for each RMIM for this message design.
Diagram will preferably include links to the location in the HMD where it is used.
Thoughts on a Publication Format for V3 Messaging
12
January 10, 2001
DRAFT
1. UML Diagrams or Gunther Visio Representation
2. HMD:XXX
This section repeats for each HMD for this RMIM
Tabular Representation of HMD allowing for the selection of the
required message type to display with the common HMD content.
Message type is hyper-linked to Interaction definitions.
Thoughts on a Publication Format for V3 Messaging
13
January 10, 2001
DRAFT
Implementable Technology Specification
Each Implementable Technology Specification will be published in a separate document.
General Introduction
Maintenance method: formatted section.
Not normative.
ITS: XML
One or more of these sections will appear with the Related Domains Section.
These sections will vary widely from one ITS to another, but they will certainly be required to cover:

implementation of message element types

implementation of data types

implementation of the Communications Models described in the Version 3 General
Information document.
Thoughts on a Publication Format for V3 Messaging
14
January 10, 2001