HL7 version 3 Quick Reference (v1.3)
Relationship between modelling artefacts
RIM
Data Types
Instantiate
Coding
Systems
D-MIM
Application
Role
The RIM (in UML)
RoleLink
Storyboard
Narrative
Example
Sender
Receiver
R-MIM
Entity
Composite
Model
Document
Paradigm
Triggers
Payload
Message
Type
Control Act
Wrapper
Transmission
Wrapper
References
Trigger
Event
0..1
determinerCode: CS (CODE)
D
id: II (IDENTIFIER)
name: EN (NAME)
code: CE (CODE)
desc: ED (TEXT)
Receiver
Resp.
0..*
Player
0..1
0..*
Scoper
Source
1..1
1..1
Act
Participation
classCode: CS (CODE)
id: II (IDENTIFIER)
code: CE (CODE)
name: EN (NAME)
...
0..*
Target
1..1
Role
classCode: CS (CODE)
Ilustrates
0..*
Source
1..1
Interaction
Body
Message
Type
Document
Header
...
0..*
Target
Storyboard
Diagram
HMD
Message
Type
Service
Paradigm
...
Ilustrates
Serialize
ITS Transform
typeCode: CS (CODE)
0..*
Restrict
ActRelationship
typeCode: CS (CODE)
0..*
1..1
classCode: CS (CODE)
moodCode: CS (CODE)
typeCode: CS (CODE)
time: IVL<TS> (TIME)
...
1..1 id: II (IDENTIFIER)
0..*
...
code: CD (CODE)
text: ED (TEXT)
ef f ectiveTime: IVL<TS> (TIME)
...
LivingSubject
Observation
SubstanceAdministration
birthTime: TS (TIME)
value: ANY
doseQuantity: PQ
...
...
routeCode: CE (CODE)
...
Message Paradigm
Reader’s guide to v3 models
The HDF and the messaging artefacts
Entry Point
Dynamic
Domain
Storyboard;
DAM
anEntity
classCode: <= EntityClass
determinerCode: <= INSTANCE or KIND
id: II [0..1]
name: EN [0..*]
0.1 participatingRole
aRole
classCode: <= RoleClass
id: II [0..1]
code: CE [0..1]
1..1 PlayedBy
Interaction Model
aParticipation
typeCode*: <= ParticipationType
time: IVL<TS>
anActivity
classCode <= ActClass
moodCode <= ActMood
id: II [0..1]
code: CE [0..1]
statusCode: CS [1..1]
effectiveTime: IVL<TS>
anActRelationship
classCode: <= ActRelationshipClass
RIM
D-MIM
Trigger
Events
Static
Message design:
R-MIM; HMD; MT
Receiver
Responsibility
Interaction
0..1 ScopedBy
aCommunicationOrientedClass
CMET (Entity)
E_SomePredefinedEntity
[universal]
(COCT_MT999999)
0..* RelatedTo
anotherActivity
aRecursiveActRelationship
classCode: <= ActRelationshipClass
Concept of the HL7v3 Quick Reference by René Spronk & Virginia Lorenzi.
Download the latest version from www.ringholm.de/download/hl7v3_quick_reference.doc
Acronym
AR
Description
Application Role. Has the capability of
sending/receiving a set of interactions
American National Standards Institute
Acronym
HMD
Description
Hierarchical Message Description.
Serialized version of an R-MIM.
Interaction. A v3 message. Static model
+ trigger event + receiver
responsibilities.
International Standards Organization
V3 Documentation Structure
Introduction
v3 Guide
Foundation
ANSI
IN
RIM
Vocabulary
Data types - Abstract
CCD
Continuation of Care Document. U.S. CDA ISO
Refinement and Constraint
Implementation guide.
Specification
Infrastructure
CDA
Clinical Document Architecture. Specifies ITS
Implementation Technology
Wrappers
a HL7 v3 e-Document model.
Specification. Transformation of
Transport implementation guides
abstract models to (e.g. XML-)
ITS
technology.
XML ITS
CIM
Constrained Information Model. A
LIM
Localized Information Model. A static
Data types – XML specific
(constrained) serializable static model.
model used as a template or profile.
Structures – XML specific
CMET
Common Message Element Type.
MT
Message Type. Serialized (and possibly
Universal Domains
Reusable model snippet.
constrained) version of an HMD.
Domain(n*)
CNE
Coded No Extensions. Coded attribute is
OID
ISO Object Identifier. Unique identifier
D-MIM, Textual walkthrough
strictly bound to pre-defined codes.
mechanism using dotted numbers.
Domain level ST, SN
CWE
Coded With Extensions. Coded attribute
RIM
Reference Information Model. The basis
Topic (n*)
may use non-predefined codes.
for all HL7 derived static models.
Topic-level ST, SN
DAM
Domain Analysis Model. Activity Model,
R-MIM
Refined Message Information Model.
AR, TE
created in the initial phase of the HDF
Contextualized static model.
R-MIM
DIM
Domain Information Model. New term,
SN
Storyboard Narrative. Textual
Interaction
not yet widely in use, for D-MIM
description of a workflow.
CMET
domain
D-MIM
Domain Message Information Model.
ST
Storyboard. Workflow depiction using a
Background documents
Static model with a domain scope.
diagram.
Glossary
Domain
Grouping of all v3 artefacts related to a
TE
Trigger Event. Underlying reason which
Support
Files
closely related set of use cases.
leads to a message being sent.
XML Schema
DSTU
Draft Standard for Trial Use. Standard for
UML
the Universal Modelling Language.
1 or 2 years; to gather experiences
Widely used modelling methodology.
HDF
HL7 Development Framework. Formal
V3
The HL7 version 3 standard family or
UML-based development methodology of
one of its component standards: the
v3 artefacts.
HDF, the RIM, the Data Types, the CDA,
or the set of implementable RIM
derived artefacts.
Published under the Creative Commons - Attribution-Non-commercial license, http://creativecommons.org/licenses/by-nc/2.5/