Professional Documents
Culture Documents
x Messaging
Conformance
Abdul-Malik Shakir
Principal Consultant, Shakir Consulting
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Abdul-Malik Shakir
Principal Consultant, Shakir Consulting, La Verne, CA
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Session Outline
Part I Part II
Background Messaging Workbench
HL7: What, and Why What and Why
Message Profile: Features and Use
Why and When Reports and Examples
Message Profiles: Contacts and Help
What and How Sample Projects
Concepts and Constituents CADHS ELR
Levels and Examples CA SIIS SIP
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Health Level Seven
What and Why
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
An HL7 Messaging Scenario: Why
Program Order Entry
Order Entry Dataset
Module
User Interface
Application
Application
System
System Message Message
Creation Parsing
Transaction
Lab Result
Transaction
Lab Order
A to B B to A
Transformation Transformation
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reaching the Limits of Application Interfaces
Decision Electronic
Lab
Support Health Record
Radiology
Pharmacy
? ?
External Administrative
Order Entry ADT
Systems Systems
?
Enterprise
Systems
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Health Level Seven: Why
120
100
80
Interfaces
60
40
20
0
2 3 4 5 6 7 8 9 10 11 12 13 14 15
Patient
Demographics
(PID)
Patient Visit
(PV1) DATA
Next of KIN
(NK1)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Abstract Message Specification
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
MSH Segment Definition
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
MSH Segment Definition
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 Message Elements
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 v2 Message Elements
Relationships
Message
Specification
One to One One to Many Many to Many
Composite
Segment Group Data Type Code System
Data Type
Data Type
Message Segment Data Element Code System Term
Component
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Sample HL7 v2.x Message
MSH|^~\&|LABGL1||DMCRES||199812300100||ORU^R01|LABGL1199510221838581|P|2.3
|||NE|NE
PID|||6910828^Y^C8||Newman^Alfred^E||19720812|M||W|25 Centscheap Ave^^
Whatmeworry^UT^85201^^P||(555)777-6666|(444)677-7777||M||773789090
OBR||110801^LABGL|387209373^DMCRES|18768-2^CELL COUNTS+DIFFERENTIAL TESTS
(COMPOSITE)^LN|||199812292128||35^ML|||||||
IN2973^Schadow^Gunther^^^^MD^UPIN
||||||||||^Once||||||CA20837^Spinosa^John^^^^MD^UPIN
OBX||NM|4544-3^HEMATOCRIT (AUTOMATED)^LN||45||39-49
||||F|||199812292128||CA20837
OBX||NM|789-8^ERYTHROCYTES COUNT (AUTOMATED)^LN||4.94|10*12/mm3
|4.30-5.90||||F|||199812292128||CA20837
Segments Delimiters
MSH: Message Header | Field
PID: Patient Identification ^ Component
OBR: Observation Request
& Subcomponent
OBX: Observation Result
~ Repetition
\ Escape Character
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profiles
Why and When
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reveal Assumptions
Do you Yes, I do
play play
football? football.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reveal Assumptions
MSH
EVN MSH
PID Do you Yes, I EVN
[PD1] use use PID
[ { NK1 } ] [ NK1 ]
HL7? HL7. OBX
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reduce Ambiguity
MSH
EVN
PID
[PD1]
[ { NK1 } ]
MSH MSH
EVN EVN
PID PID
[PD1] [ NK1 ]
[ { NK1 } ] OBX
MSH
EVN
{ PID }
[PD1]
[ { NK1 } ]
[ { GT1 } ]
[ OBX ]
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Value of Message Profiling
Reveal Assumptions
Reduce Ambiguity
Highlight Conflicts
Consolidate Viewpoints
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profiles
What and How
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profile Defined
Unambiguous specification of a standard HL7
message for use within a particular set of
requirements
Prescribes a set of precise constraints upon one or more
standard messages
Supported by use case analysis and interaction modeling
Measurable
What data will be passed in a message
The format in which the data will be passed
The acknowledgement responsibilities of the sender and
receiver
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profile Defined (cont’d)
Based on HL7, although may further constrain
Static structure and content of each message
The dynamic interactions
Parts of a valid message profile
Use Case Model
Static Definition
Dynamic Definition
Represented as an XML document
Can be registered with HL7
May be reused by other HL7 users
May be used for documentation
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Conceptual Overview
Message Profile = Static Profile + Dynamic Profile
Initiating Message
Response Message
ADT System
Initiating Message
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Static Definition
A specification for a message structure intended to
support the use case
Based on a message defined in HL7 Std
Defined at the message, segment, and field levels
Follows the HL7 rules (chapter 2)
May further constrain
Identifies only those specific elements used in the exchange
Removes all instances of optionality, defining explicitly
Segments, segment groups, fields and components usage rules
Cardinalities
Value sets and coding systems
Implementation notes
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Static Definition Example
HL7 Message Structure Message Profile
MSH MSH
EVN Segments/Segment Groups:
EVN •Usage (Optionality)
PID PID •Cardinality (min, max)
NK1 NK1 NK1 NK1 NK1 ... NK1 NK1 NK1 NK1 NK1
PV1 PV1
...
Fields/Components:
PV2 PV2
- Usage (Optionality)
...
OBX ...
OBX - Cardinality (min, max)
- Value Sets/Coding system
AL1 AL1 - Descriptions
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Dynamic Definition
Defines interaction between the sender and receiver
Acknowledgment mode supported
Conditions under which an accept and/or application level
acknowledgment is expected
Always
Never
Only on success
Only on error
Interaction Model
Defines specific interactions between the applications that support
message profile communication requirements
Includes interaction diagrams that illustrate the sequence of trigger event
and resulting message flows between the sending and receiving
applications
Dynamic can refer one to many static definitions
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Dynamic Interaction
Receiver Responsibility
MSH-15,16
BED1 OFF BE
D 1 OF BED1 OFF
BED 1OFF BE
D 1 OF BE
D 1 OF
BE
D 1 OF
BED 1OFF
BE
D 1OF
F
POTA
SS
I UM3. 5
-5.0
POTASS
IUM3.5-5.0
BED 1OFF
POT
ASS
I UM3.5- 5
.0
OTA
P SS
IUM 3
.5-5.0
BED 1 OFF
BE
D 1OFF
BED1 OF
XU
5/90C
BED 1OFF BE
D 1 OF BE
D 1 OF
Accept Ack
BED 1OFF ED1 OFF
B
BE
D 1 OF
BED 1OFF
BE
D 1OF
F
POTA
SS
I UM3. 5
-5.0
POTASS
IUM3.5-5.0
BED 1OFF
POT
ASS
I UM3.5- 5
.0
OTA
P SS
IUM 3
.5-5.0
BED 1 OFF BE
D 1OFF
BED1 OF
Vectra
XU
5/90C
Clinical Data
Repository
Order Filling Application
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
How it all ties together
1 Use Case Model
Phys ician
1.1 Use Case: Admit/Visit Notification : ADT Sy stem : ADT Notifi cation
Recipient
authorizes Registrar
Pat ient is subject of triggers
ACK ^A01
sends notificat ion receives notific ation
A dmit/ Visit Notific ation
3 Dynamic Definition: ADT/ACK (Event A01)
ADT Sy stem ADT Notificat ion
Recipient 3.1 ADT^A01 Interaction Model
Use Case Model 3.2 ACK^A01
Segment ADT Message Usage Cardinality Chapter 4 Static Definition: - Message Level -
MSH
EVN
Message Header
Event Type
R
R
[1..1]
[1..1]
2
3 ADT/ACK (event A01)
PID Patient Identification R [1..1] 3
[ PD1 ] Additional Demographics X [0..0] 3
[{ ROL }]
[{ NK1 }]
Role
Next of Kin / Associated
X
RE
[0..0]
[0..3]
12
3 4.1 ADT^A01
Parties
[
PV1
PV2 ]
Patient Visit
Patient Visit - Additional
R
RE
[1..1]
[0..1]
3
3
4.2 ACK^A01
Info.
[{ ROL }] Role X [0..0] 12
[{
[{
DB1
OBX
}]
}]
Disability Information
Observation/Result
X
X
[0..0]
[0..0]
3
7
5 Static Defintiion - Segment Level
[{ AL1 }] Allergy Information RE [0..*] 3
[{ DG1 }] Diagnosis Information X [0..0] 6
[
[{
DRG ] Diagnosis Related Group X
X
[0..0]
[0..0]
6 5.1 MSH – Message Header Segment Definition
}]
PR1
[{ ROL
Procedures
Role
X
X
[0..0]
[0..0]
6
12 5.2 EVN - Event Type Segment Definition
}]
[{ GT1 }] Guarantor X [0..0] 6
5.3 PID (Y) - Patient Demographics Segment
[{
IN1
[ IN2 ]
Insurance
Insurance Additional Info.
X
X
X
[0..0]
[0..0]
[0..0]
6
6
Definition
5.4 PD1 – Patient Additional Demographic
Dynamic Definition
[{ IN3 Insurance Additional Info - X [0..0] 6
}] Cert.
[{ ROL Role X [0..0] 12
}]
}]
Segment Definition
[ ACC ]
[ UB1 ]
Accident Information
Universal Bill Information
X
X
[0..0]
[0..0]
6
6 5.5 NK1 - Next of kin Segment Definition
[ UB2 ] Universal Bill 92 Information X [0..0] 6
[ PDA ] Patient Death and Autopsy X [0..0] 3 5.6 PV1 (2) - Admit Visit Info Segment SEQ LEN DT Usage Cardinality TBL# ITEM# ELEMENT NAME
Definition 1
2
4
20
SI
CX
X
RE [1..1]
00104
00105
Set ID - PID
Patient ID
[1..*]
00106
00107
00108
Patient Identifier List
Alternate Patient ID - PID
Patient Name
Definition 9
8
10
1
48
80
IS
XPN
CE
RE
X
X
0001
0005
00111
00112
00113
Sex
Patient Alias
Race
Vocabulary 6.7 Table 0007 – Admission Type Static Definition – Segment Level
6.8 Table 0008 – Acknowledgement Code
6.9 Table 0009 – Ambulatory Status
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profiles
Concepts and Constituents
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Profiling Concepts
Profile Types
HL7 Standard
Constrainable
Implementable
Generic term ‘message element’ used
Segment groups
Segments
Message
Fields
Constituents
Components
Sub-components
Cardinality
Usage
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Profile Types
HL7 Standard Profile
represents a specific HL7 published standard
creation and publication limited to HL7 use
Constrainable
May have optionality - not implementable
Narrower profiles may be defined based on this
Realm Specific (National, Regional, SIGs, etc.)
Organization / Application Specific
Implementation
Further constrained
No optionality
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Cardinality
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Cardinality Examples
Value Description
[0..1] Element may be omitted and it can have at most one Occurrence
[1..n] Element must appear at least once, and may repeat up to n times
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage
The circumstances under which an element
appears in a message
Some elements must always be present
others may never be present
others may only be present in certain
circumstances
Rules governing the expected behavior of
the sending and limited restrictions on the
receiving application with respect to the
element
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage (continued)
R - Required
A conforming sending application
populate all “R” elements with a non-empty value
A conforming receiving application
process (save/print/archive/etc.) or ignore the information conveyed
by required elements
must not raise an error due to the presence of a required element, but
may raise an error due to the absence of a required element
For complete compatibility with HL7, any element designated as
required in a standard HL7 message definition shall also be
required in all HL7 Message Profiles of that standard message
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage (continued)
RE - Required but may be empty
May be missing from the message, but must be sent by the
sending application if there is relevant data
A conforming sending application
must be capable of providing all “RE” element
if it knows the required values for the element, then it must send that
element
if the conforming sending application does not know the required
values, then element will be omitted
A conforming receiving applications
will be expected to process (save/print/archive/etc.) or ignore data
contained in the element
must be able to successfully process the message if the element is
omitted (I.e. no error message should be generated because the
element is missing
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage (continued)
Optional
This code indicates that the Usage for this element has not yet
been defined
May NOT be used in ‘Implementation’ profiles (no-optionality
profiles)
Conformance cannot be tested on an Optional field
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage (continued)
C - Conditional
Predicate associated with this element that identifies the
conditions under which the element must be present
must be testable and based on other values within the message
may be expressed as a mathematical expression or in text and may
utilize operators such as equivalence, logical AND, logical OR and
NOT
The conforming sending and receiving applications shall both
evaluate the predicate
If the predicate is satisfied:
See rules for R (Required)
If the predicate is NOT satisfied:
A conformant sending application must NOT send the element
A conformant receiving application must NOT raise an error if the
condition predicate is false and the element is not present, though it
MAY raise an error if the element IS present
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage (continued)
CE - Conditional but may be empty
This usage also has an associated condition predicate similar to
Conditional (C)
If the predicate is satisfied:
See rules for RE (Required but may be empty)
If the predicate is not satisfied:
The conformant sending application must NOT send the element
The conformant receiving application MAY raise an application error if
the element IS present
X - Not supported
Conformant sending applications will NOT send the element
Conformant receiving applications MAY ignore the element if it IS
present, or may raise an application error
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Optionality / Usage Relationship
Conformance Usage codes are more
specific than HL7 Optionality codes
HL7 Optionality Allowed Conformance Usage Comment
R - Required R
O - Optional R, RE, O*, C, CE, X O is only permitted for
constrainable profiles
W – Withdrawn X
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage / Cardinality Relationship
Both Usage and Cardinality govern the appearance of a
field in a message
Cardinality constrained by the usage code
If Required (R), the minimum and maximum cardinality for the
element shall always be >= 1
If the usage of an element is not Required (R) (i.e. any code other
than ‘R’), the minimum cardinality shall be 0 except in the
following condition:
where an element will not always be present but, when present, must
have a minimum number of repetitions greater than one, this may be
indicated by specifying
• the non-required Usage code
• the minimum cardinality representing the minimum number of repetitions
when the element is present.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage-Cardinality Combinations
Cardinality Usage Interpretation
[1..1] R There will always be exactly 1 repetition present
[1..5] R There will be between 1 and 5 repetitions present
[0..1] R Illegal: Minimum and maximum cardinality must always be at
least 1 for ‘Required’ elements
[0..1] RE The element must be supported, but may not always be present
[0..5] C If the condition predicate is true, there will be between 1 and 5
repetitions. If the predicate is false, there will be 0 repetitions
[3..5] RE If any values for the element are sent, there must be at least 3 and
no more than 5 repetitions. However, the element may be absent
(0 repetitions)
[0..1] CE Under certain circumstances, the element must be supported, but
may not always be present
[0..0] X Not supported
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Usage Within Hierarchical Elements
Messages are constructed using a hierarchy of
elements
At least one lower level element must be present
for the higher level element to be considered to
be present
Adds an implicit conditional constraint on
elements that enforce the presence of an element
Places constraints on what combinations of
usage codes may be used within a hierarchy
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profiles
Levels and Examples
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Level Profile
Segment Definitions
The set of segments and segment groups included within the
message of an HL7 Message Profile shall be defined
Any segments or segment groups that are required by HL7 shall
be included
Segment Usage
Segment Cardinality
Profile does not allow for “empty” segment
HL7 abstract message syntax PLUS
Usage
Cardinality
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Level Profile Example
ADT^A01^ADT_A01 ADT Message Usage Cardinality Chapter
MSH Message Header R [1..1] 2
EVN Event Type R [1..1] 3
PID Patient Identification R [1..1] 3
[ PD1 ] Additional Demographics X [0..0] 3
[{ ROL }] Role X [0..0] 12
[{ NK1 }] Next of Kin / Associated RE [0..3] 3
Parties
PV1 Patient Visit R [1..1] 3
[ PV2 ] Patient Visit - Additional RE [0..1] 3
Info.
[{ ROL }] Role X [0..0] 12
[{ DB1 }] Disability Information X [0..0] 3
[{ OBX }] Observation/Result X [0..0] 7
[{ AL1 }] Allergy Information RE [0..*] 3
[{ DG1 }] Diagnosis Information X [0..0] 6
[ DRG ] Diagnosis Related Group X [0..0] 6
[{ X [0..0]
PR1 Procedures X [0..0] 6
[{ ROL }] Role X [0..0] 12
}]
[{ GT1 }] Guarantor X [0..0] 6
[{ X [0..0]
IN1 Insurance X [0..0] 6
[ IN2 ] Insurance Additional Info. X [0..0] 6
[{ IN3 }] Insurance Additional Info - X [0..0] 6
Cert.
[{ ROL }] Role X [0..0] 12
}]
[ ACC ] Accident Information X [0..0] 6
[ UB1 ] Universal Bill Information X [0..0] 6
[ UB2 ] Universal Bill 92 Information X [0..0] 6
[ PDA ] Patient Death and Autopsy X [0..0] 3
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Level Profile Example
ADT^A01^ADT_A01 ADT Message Usage Cardinality Chapter
MSH Message Header R [1..1] 2
EVN Event Type R [1..1] 3
PID Patient Identification R [1..1] 3
[{ NK1 }] Next of Kin / Associated RE [0..3] 3
Parties
PV1 Patient Visit R [1..1] 3
[ PV2 ] Patient Visit - Additional RE [0..1] 3
Info.
[{ AL1 }] Allergy Information RE [0..*] 3
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Level Profile Example
ADT^A01^ADT_A01 ADT Message Usage Cardinality Chapter
MSH Message Header R [1..1] 2
EVN Event Type R [1..1] 3
PID Patient Identification R [1..1] 3
[ PD1 ] Additional Demographics X [0..0] 3
[{ ROL }] Role X [0..0] 12
[{ NK1 }] Next of Kin / Associated RE [0..10] 3
Parties
PV1 Patient Visit R [1..1] 3
[ PV2 ] Patient Visit - Additional R [1..1] 3
Info.
[{ ROL }] Role X [0..0] 12
[{ DB1 }] Disability Information X [0..0] 3
[{ OBX }] Observation/Result X [0..0] 7
[{ AL1 }] Allergy Information RE [0..*] 3
[{ DG1 }] Diagnosis Information X [0..0] 6
[ DRG ] Diagnosis Related Group X [0..0] 6
[{ X [0..0]
PR1 Procedures X [0..0] 6
[{ ROL }] Role X [0..0] 12
}]
[{ GT1 }] Guarantor X [0..0] 6
[{ RE [0..3]
IN1 Insurance R [1..1] 6
[ IN2 ] Insurance Additional Info. RE [0..1] 6
[{ IN3 }] Insurance Additional Info - X [0..0] 6
Cert.
[{ ROL }] Role X [0..0] 12
}]
[ ACC ] Accident Information RE [0..1] 6
[ UB1 ] Universal Bill Information X [0..0] 6
[ UB2 ] Universal Bill 92 Information X [0..0] 6
[ PDA ] Patient Death and Autopsy X [0..0] 3
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Level Profile Example
ADT^A01^ADT_A01 ADT Message Usage Cardinality Chapter
MSH Message Header R [1..1] 2
EVN Event Type R [1..1] 3
PID Patient Identification R [1..1] 3
[{ NK1 }] Next of Kin / Associated RE [0..10] 3
Parties
PV1 Patient Visit R [1..1] 3
[ PV2 ] Patient Visit - Additional R [1..1] 3
Info.
[{ AL1 }] Allergy Information RE [0..*] 3
[{ RE [0..3]
IN1 Insurance R [1..1] 6
[ IN2 ] Insurance Additional Info. RE [0..1] 6
}]
[ ACC ] Accident Information RE [0..1] 6
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Segment Level Profile
The set of fields of each instance of a segment within the
Message Profile
If a segment occurs multiple times, it may be represented
by different segment profiles
Field Usage
Field Cardinality
Null
Syntax (tabular HL7 segment definitions)
Length (updated)
Usage (new column)
Cardinality (new column)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Segment Level Profile Example (PID)
SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME
1 4 SI O 00104 Set ID - PID
2 20 CX B 00105 Patient ID
3 250 CX R Y 00106 Patient Identifier List
4 20 CX B Y 00107 Alternate Patient ID - PID
5 250 XPN R Y 00108 Patient Name
SEQ LEN DT Usage Cardinality TBL# ITEM# ELEMENT NAME
6 250
1 XPN
4 SI OX Y 00104 Set ID 00109
- PID Mother’s Maiden Name
7 262 20
TS CX ORE [0..1] Y 00105 Patient00110
ID Date/Time of Birth
3 20 CX R [1..*] 00106 Patient Identifier List
8 1 IS O Y 0001 00111 Sex
4 20 CX X 00107 Alternate Patient ID - PID
9 250
5 XPN
48 XPN BR [1..*] 00108 Patient00112
Name Patient Alias
10 6
250 48
CE XPN ORE [0..*] 00109
0005Mother’s Maiden Name
00113 Race
7 26 TS RE [0..*] 00110 Date/Time of Birth
11 250 XAD O Y 00114 Patient Address
8 1 IS RE [0..*] 0001 00111 Sex
12 49 IS XPN
48 BX 0289
00112 Patient00115
Alias County Code
13 10
250 80
XTN CE OX Y 0005 00113 Race 00116 Phone Number - Home
11 106 XAD RE [0..3] 00114 Patient Address
14 250 XTN O Y 00117 Phone Number - Business
12 4 IS X 0289 00115 County Code
15 250
13 CE
40 XTN ORE [0..3] 0296
00116 Phone 00118 Primary Language
Number - Home
16 14
250 40
CE XTN ORE [0..3] 00117
0002Phone 00119
Number - Business
Marital Status
15 60 CE X 0296 00118 Primary Language
17 250 CE O 0006 00120 Religion
16 80 CE X 0002 00119 Marital Status
18 250
17 CX CE
80 OX 00121
0006 00120 Religion Patient Account Number
19 16
18 ST CX
20 BX 00121 Patient00122 SSN
Account Number Number - Patient
19 16 ST RE [0..1] 00122 SSN Number - Patient
20 25 DLN B 00123 Driver's License Number - Patient
20 25 DLN X 00123 Driver's License Number - Patient
21 250
21 CX CX
20 OX Y 00124
00124 Mother's Identifier Mother's Identifier
22 250
22 CE CE
80 OX Y 0189
0189 00125 Ethnic 00125
Group Ethnic Group
23 60 ST RE [0..1] 00126 Birth Place
23 250 ST O 00126 Birth Place
24 1 ID X 0136 00127 Multiple Birth Indicator
24 125 2ID NM OX 0136
00128 00127 Multiple Birth Indicator
Birth Order
25 226 NM
80 CE OX 00128
0171 00129 Citizenship Birth Order
27 60 CE X 0172 00130 Veterans Military Status
26 250 CE O Y 0171 00129 Citizenship
28 80 CE X 0212 00739 Nationality
27 250
29 CE TS
26 OX 0172
00740 Patient00130
Death DateVeterans
and Time Military Status
28 250
30 CE
1 ID BX 0212
0136 00741 Patient00739 Nationality
Death Indicator
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Segment Level Profile Example (PID)
SEQ LEN DT Usage Cardinality TBL# ITEM# ELEMENT NAME
1 4 SI X 00104 Set ID - PID
2 20 CX RE [0..1] 00105 Patient ID
3 20 CX R [1..*] 00106 Patient Identifier List
4 20 CX X 00107 Alternate Patient ID - PID
5 48 XPN R [1..*] 00108 Patient Name
6 48 XPN RE [0..*] 00109 Mother’s Maiden Name
7 26 TS RE [0..*] 00110 Date/Time of Birth
8 1 IS RE [0..*] 0001 00111 Sex
9 48 XPN X 00112 Patient Alias
10 80 CE X 0005 00113 Race
11 106 XAD RE [0..3] 00114 Patient Address
12 4 IS X 0289 00115 County Code
13 40 XTN RE [0..3] 00116 Phone Number - Home
14 40 XTN RE [0..3] 00117 Phone Number - Business
15 60 CE X 0296 00118 Primary Language
16 80 CE X 0002 00119 Marital Status
17 80 CE X 0006 00120 Religion
18 20 CX X 00121 Patient Account Number
19 16 ST RE [0..1] 00122 SSN Number - Patient
20 25 DLN X 00123 Driver's License Number - Patient
21 20 CX X 00124 Mother's Identifier
22 80 CE X 0189 00125 Ethnic Group
23 60 ST RE [0..1] 00126 Birth Place
24 1 ID X 0136 00127 Multiple Birth Indicator
25 2 NM X 00128 Birth Order
26 80 CE X 0171 00129 Citizenship
27 60 CE X 0172 00130 Veterans Military Status
28 80 CE X 0212 00739 Nationality
29 26 TS X 00740 Patient Death Date and Time
30 1 ID X 0136 00741 Patient Death Indicator
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Field Level Profile
Field definitions
Each individual field is completely defined to eliminate any
possible ambiguity
If HL7 2.x field descriptions are not sufficient, a precise semantic
definition shall be specified
Exact allowed value set shall be specified
Coded Values (ID and IS)
HL7 tables (ID) may be extended
User defined (IS) may be redefined and/or extended
Coded Entry (CE, CF, CWE, and CNE)
Composite Data (CM) types
Appendix for 2.3.1 and 2.4 for XML encoding
Deprecated and all CM fields are using new data types as of 2.5
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profile Identifier
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
MSH-21 Message Profile Identifier
Sites may use this field to assert adherence to, or reference, a message
profile. Message profiles contain detailed explanations of grammar, syntax,
and usage for a particular message or set of messages.
Repetition of this field allows more flexibility in creating and naming message
profiles. Using repetition, this field can identify a set of message profiles that
the message conforms to.
the first repetition could reference a vendor's message profile
The second could reference another compatible provider's profile or a later version
of the first vendor profile.
As of v2.5, the HL7 message profile identifiers might be used for
conformance claims.
Prior to v2.5, the field was called Conformance Statement ID. For backward
compatibility, the Conformance Statement ID can be used here.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Compliance and Conformance
Compliance
Messages that adhere to the
rules and conventions for
constructing of a specific version
of a standard are compliant to
that version of the standard.
Compliance Conformance Conformance
Messages that adhere to the
constraints of a precise and
unambiguous specification
called a message profile are
said to be conformant to the
profile.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Conformance Benefits
Consistent Documentation
Reuse of Specification
Lower Cost of Integration
Similar to Version 3
Conformance SIG is developing Implementation guide
Chaos -> order
Site Specific Profiles
Supports specific needs
Required of third-party application vendors
RFP
Simplifies introduction/acquisition of new applications
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Messaging Workbench
What and Why
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
The Messaging Workbench (MWB)
For those who:
Design HL7 2.x messages
Manage specification repositories
Collaborate on varied messaging projects within and outside of
their organizations
Free of charge from HL7 Web site (www.hl7.org)
HL7 -> SIG -> Conformance -> Documents
Encouraged by the Conformance SIG
Open Source Project
Call for participation
It will continue to be supported within the VA for the
foreseeable future
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Design Features (1)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Design Features (2)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Constrainable
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Constrainable (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Implementation
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profile
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Messaging Workbench
Features and Use
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Capture/Analyze Message
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reverse Engineer from Message
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Using Libraries
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Using Libraries (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Using Libraries (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Using Libraries (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Using Libraries (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile using copy/paste
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Copy/Paste (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
New Profile Copy/Paste (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Modifying a Profile – HL7
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Modifying a Profile – Constrainable
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Modifying Profile – Constr (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Modifying Profile – Implementation
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Modifying Profile – Impl (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Diagram Drawing Tool
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Messaging Workbench
Reports and Examples
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Reports (continued)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Producing Profile Reports
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Producing Profile Reports (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Producing Profile Reports (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Producing Profile Reports (cont’d)
Browser View
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Producing Profile Reports (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 Message Profile
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Register Profile with HL7
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Messaging Workbench
Contacts and Help
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
MWB Contacts
The Implementation/Conformance
WorkGroup is interested in your feedback
and suggestions for improvement of the tool
Implementation/Conformance WorkGroup
list server is a good source for general
information about the tool and for making
improvement suggestions
For specific questions you may also contact
Pete Rontey via Email at
peter.rontey@med.va.gov
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Where to Get More Information
MWB On-line help
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Where to Get More Info (cont’d)
• MWB On-line help (cont’d)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Where to Get More Info (cont’)
MWB Updates/Downloads
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Where to Get More Info (cont’d)
Conformance Tools Forum at Yahoo Groups
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
California Department of
Health Services
Electronic Laboratory
Reporting Project
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Inbound Inbound Canonical Outbound Outbound
Message Profile Message Mapping Message Profile Message Mapping Message Profile
Knowledge Knowledge
Object Graph
Management Management
Generation
Service Service
Laboratory
Canonical Laboratory Business
Message Object Additional Data
Message Profile Message Intelligence
Model Sources
Objects Application
CA Public Health
HL7 RIM & ELR Database Laboratory Extract, Business
Logical Data Laboratory
CDC PHLDM Design Model Message Transform, Intelligence
Model Datamart
Respository and Load Application
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Inbound Inbound Canonical Outbound Outbound
Message Profile Message Mapping Message Profile Message Mapping Message Profile
Laboratory
Canonical Laboratory Business
Message Object Additional Data
Message Profile Message Intelligence
Model Sources
Objects Application
Data Persistence
Business Intelligence
Object Relational Object Extract, Business
Map Relational Transform, Intelligence
Mapping and Load Application
CA Public Health
HL7 RIM & ELR Database Laboratory Extract, Business
Logical Data Laboratory
CDC PHLDM Design Model Message Transform, Intelligence
Model Datamart
Respository and Load Application
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Inbound Inbound Canonical Outbound Outbound
Message Profile Message Mapping Message Profile Message Mapping Message Profile
Knowledge Knowledge
Object Graph
Management Management
Generation
Service Service
Laboratory
Canonical Laboratory Business
Message Object Additional Data
Message Profile Message Intelligence
Model Sources
Objects Application
CA Public Health
HL7 RIM & ELR Database Laboratory Extract, Business
Logical Data Laboratory
CDC PHLDM Design Model Message Transform, Intelligence
Model Datamart
Repository and Load Application
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message Profiles
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Message-Level Profile
Which Segments are Supported?
Which Segments are Required?
How are Segments Grouped?
What is the order of Segments
and Segment groups
Which Segments/Segment
Groups are repeatable?
What is the cardinality of
repeating segments/segment
Groups?
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Segment-Level Profile
• Which Fields are Supported?
• Which Fields are Required?
• What is the order of fields within
the segment?
• What is the datatype of each
field?
• Which fields are repeatable?
• What is the cardinality of
repeating fields?
• What maximum field length is
supported?
• What value tables are associated
with the field?
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Field-Level Profile
• Which Field components are
supported?
• Which Field components are
Required?
• What is the order of components
within a field?
• What is the datatype of each field
component?
• Which fields components are
repeatable?
• What is the cardinality of repeating
fields components?
• What maximum length is supported
for field components?
• What value tables are associated with
the field components?
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
California
State Immunization
Information System
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
The California State Immunization
Information System (SIIS) is a
collaboration of
regional immunization registries,
local health departments,
the California Department of Health
Services Immunization Branch, and
a spectrum of key stakeholders
across the state of California.
The goal of SIIS is to ensure that
health care providers have rapid
access to complete and up-to-date
immunization records.
The objective is to eliminate both
missed opportunities to immunize and
unnecessary duplicate immunizations.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Regional and County Registries
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Project Scope
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Problem Statement
The premise behind the project is that, for many reasons, a person’s
immunization history data becomes fragmented over time.
The data are stored and maintained in separate state registries and
immunization provider information systems.
Typical scenarios that lead to this situation are changes in a person’s
primary residence, changes in a person’s primary healthcare provider,
and ad hoc administration of immunizations such as during vacation or
emergencies.
Once a person’s immunization data becomes fragmented across
multiple registry or provider information systems it can be difficult to
ascertain their current immunization status.
This can result in over immunization or under immunization.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Current Processes
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Current Limitations
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP SOLUTION
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 Message Profiling
ad Dynamic View
Health Level Seven CDC / AIRA SIIS SIP Project Team Regional Registry
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
ad Dynamic View
Prepare IZ Implementation
Standard Guide
Lev el Profile
Prepare SIIS SIP logical data model Prepare SIIS SIP Logical
Data Model
Final Segment Lev el
Profile
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Immunization Messaging
Implementation Guide
The Centers for Disease Control and Prevention (CDC) National
Immunization Program (NIP) publishes an implementation guide for
immunization data messaging.
The title of the guide is “Implementation Guide for Immunization Data
Transactions using version 2.3.1 of the Health Level Seven (HL7) Standard
Protocol”.
The intent of the guide is to help familiarize developers of immunization
information systems with HL7 immunization message definitions and
encoding rules and provide a nationally consistent implementation of those
messages.
Changes to the guide are coordinated through the Data Exchange Steering
Committee of the American Immunization Registry Association (AIRA) and its
associated work groups.
The members of AIRA are committed to advancing the exchange of
immunization data using a common protocol.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Immunization Messaging
Implementation Guide
The guide identifies the set of HL7 messages needed to enable information
systems that maintain immunization records to transmit patient-specific
immunization histories electronically to other systems to allow healthcare
providers to have access to these records at the time health care is given.
The use cases detailed in the guide indicate that data transmission will occur
as the result of four activities:
1. a query from one system for a patient’s vaccination record that is held in another
system using the HL7 VXQ message;
2. a response to a query containing multiple patient “matches” to the query, but not
returning vaccination records using the HL7 VXX message;
3. a response to a query containing the vaccination record using the HL7 VXR
message; and
4. an unsolicited update to a vaccination record using the HL7 VXU message.
In addition to the messages used for the four primary activities the guide
also includes specifications for transmission confirmation and exception
notification messages; ACK and QCK.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Preliminary Segment Level Profile
Message Tree Seq ETyp DTyp Usage Min Max Table Len Reference
PID 011 Segment R 1 1
Set ID - PID 001 Field SI RE 0 1 4 3.4.2.1
Patient ID 002 Field CX RE 0 1 33 3.4.2.2
Patient Identifier List 003 Field CX R 1 0 250 3.4.2.3
Alternate Patient ID - PID 004 Field CX RE 0 1 33 3.4.2.4
Patient Name 005 Field XPN R 1 0 250 3.4.2.5
Mother's Maiden Name 006 Field XPN RE 0 1 250 6.5.7.40
Date/Time Of Birth 007 Field TS RE 0 1 26 15.4.6.6
Administrative Sex 008 Field IS RE 0 1 0001 1 15.4.6.5
Patient Alias 009 Field XPN RE 0 1 250 3.4.2.9
Race 010 Field CE RE 0 1 0005 250 15.4.6.27
Patient Address 011 Field XAD RE 0 1 250 3.4.2.11
County Code 012 Field IS RE 0 1 0289 4 3.4.2.12
Phone Number - Home 013 Field XTN RE 0 1 250 3.4.2.13
Phone Number - Business 014 Field XTN RE 0 1 250 3.4.2.14
Primary Language 015 Field CE RE 0 1 0296 250 6.5.7.34
Patient Account Number 018 Field CX RE 0 1 250 3.4.2.18
SSN Number - Patient 019 Field ST RE 0 1 16 3.4.2.19
Mother's Identifier 021 Field CX RE 0 1 250 3.4.2.21
Ethnic Group 022 Field CE RE 0 1 0189 250 15.4.6.28
Birth Place 023 Field ST RE 0 1 250 3.4.2.23
Multiple Birth Indicator 024 Field ID RE 0 1 0136 1 3.4.2.24
Birth Order 025 Field NM RE 0 1 2 3.4.2.25
Citizenship 026 Field CE RE 0 2 0171 250 6.5.7.33
Veterans Military Status 027 Field CE RE 0 1 0172 250 3.4.2.27
Patient Death Date and Time 029 Field TS RE 0 1 26 3.4.2.29
Patient Death Indicator 030 Field ID RE 0 1 0136 1 3.4.2.30
Last Update Date/Time 033 Field TS RE 0 1 26 3.4.2.33
Production Class Code 038 Field CE RE 0 1 0429 250 3.4.2.38
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Conceptual Data Model
PersonPostalAddress
streetOrMailingAddress: char(120)
streetName: char(50) Person PersonTelecommunicationAddress
dwellingNumber: char(12) surname: char(50) telecommunicationUseCode: char(3)
city: char(50) givenName: char(30) areaCityCode: numeric(5)
stateOrProvince: char(50) secondAndFurtherGivenNamesOrInitialsThereof: char(30) phoneNumber: numeric(9)
0..* 1..* 1..* 0..*
zipOrPostalCode: char(12) suffix: char(20) extension: numeric(5)
addressType: char(3) anyText: char(199)
countyParishCode: char(20)
countryCode: char(3)
1 1 1 1
0..* 0..*
PersonIdentifier
PersonAlternateName
id: char(15)
typeCode: char(1)
idType: char(6)
surname: char(50)
namespaceId: char(20)
givenName: char(30)
secondAndFurtherGivenNamesOrInitialsThereof: char(30)
suffix: char(20)
0..1
Patient
dateTimeOfBirth: timestamp
birthState: char(60) Facility
0..* multipleBirthIndicator: char(1)
administrativeSex: char(1) identifier: char(20)
PatientRelationship
birthOrder: numeric(2) name: char(50)
identifier: char(20) deathDateTime: timestamp assigningAuthorityId: char(20)
text: char(199) deathIndicator: char(1) namespaceId: char(20)
contactRoleIdentifier: char(20) lastUpdateDateTime: timestamp streetAddress: char(120)
contactRoleText: char(199) 1..* 1 lastUpdateFacility: char(20) 0..* 1 city: char(50)
livingArrangement: char(2) PublicityCodeID: char(20) stateOrProvince: char(50)
publicityCodeEffectiveDate: datetime zipOrPostalCode: char(12)
publicityCodeText: char(199) country: char(3)
protectionIndicator: char(1) addressType: char(3)
protectionIndicatorEffectiveDate: datetime
immunizationRegistryStatus: char(1)
immunizationRegistryStatusEffectiveDate: datetime
1
1
1..*
0..*
PatientRace
PatientLanguageAbility
1..*
identifier: char(20)
identifier: char(20)
text: char(199) PatientEthnicGroup text: char(199)
identifier: char(20) preferenceIndicator: char(1)
text: char(199)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Regional System to Segment Profile Mapping
Allowable
Supported?
Source values
Mapping
Element Name Source Table Source Column(s) Data type (attach
Comments
and length reference if
necessary)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Regional System to Segment Profile Mapping
Profile Usage
VAXTRACK
COMMENT
Imperial
BARR
CVIIS
INNC
RIDE
SDIR
LINK
CCIR
SFT
Path Element Name
PID PID
PID.1 SetID-PID Y Y N Y Y N Y Y Y N Y
PID.3 PatientIdentifierList
PID.3.1 ID Y Y N Y Y Y Y Y Y Y Y
PID.3.4 assigningauthority
PID.3.4.1 namespaceID Y Y N Y Y Y Y Y Y N Y
PID.5 PatientName
PID.5.1 familyname
PID.5.1.1 surname Y Y Y Y Y Y Y Y Y Y Y
PID.5.2 givenname Y Y Y Y Y Y Y Y Y Y Y
PID.5.3 secondandfurthergivennamesorinitialsthereof Y Y Y Y Y Y Y Y Y Y Y
PID.5.4 suffix(e.g.,JRorIII) Y Y Y Y Y Y Y Y Y N Y
PID.6 Mother'sMaidenName
PID.6.1 familyname
PID.6.1.1 surname Y Y Y Y Y Y Y Y Y Y Y
PID.7 Date/TimeOfBirth
PID.7.1 Date/Time Y Y Y Y Y Y Y Y Y Y Y
PID.8 AdministrativeSex Y Y Y Y Y Y Y Y Y Y Y
PID.9 PatientAlias
PID.9.1 familyname
PID.9.1.1 surname N N Y N Y Y Y/Y Y Y Y Y
PID.9.2 givenname N N Y N Y Y Y/Y Y Y Y Y
PID.9.3 secondandfurthergivennamesorinitialsthereof N N Y N Y N Y/Y Y Y Y Y
PID.9.4 suffix(e.g.,JRorIII) N N Y N Y N Y/Y N Y N Y
PID.10 Race
PID.10.1 identifier Y Y Y Y Y Y Y Y Y Y Y
PID.10.2 text Y N Y Y Y N Y Y Y Y Y
PID.10.3 nameofcodingsystem Y Y Y Y Y N Y Y Y N Y
PID.11 PatientAddress
PID.11.1 streetaddress(SAD)
PID.11.1.1 streetormailingaddress Y Y Y Y Y Y Y Y Y Y Y
PID.11.1.2 streetname N N N N N N N N N Y N
PID.11.1.3 dwellingnumber N N N N N N N N N Y N
PID.11.3 city Y Y Y Y Y Y Y Y Y Y Y
PID.11.4 stateorprovince Y Y Y Y Y Y Y Y Y Y Y
PID.11.5 ziporpostalcode Y Y Y Y Y Y Y Y Y Y Y
PID.11.7 addresstype Y Y Y Y Y N Y Y Y Y Y
PID.11.9 county/parishcode Y Y Y Y Y Y Y Y Y Y Y
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Final Segment Level Profile
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Logical Data Model
PersonPostalAddress
*PK idNumber: int
*FK personIdNumber: int PersonTelecommunicationAddress
Person
addressLine1Text: char(120) *PK idNumber: int
addressLine2Text: char(120) *PK idNumber: int *FK personIdNumber: int
cityName: char(50) (personIdNumber = idNumber) surname: char(50) telecommunicationUseCode: char(3)
stateCode: char(50) givenName: char(30) (personIdNumber = idNumber) areaCode: numeric(5)
postalCode: char(12) 0..* 1 middleName: char(30) 1 0..* * phoneNumber: numeric(9)
addressTypeCode: char(3) nameSuffix: char(20) extensionNumber: numeric(5)
countyCode: char(20) 1 concatenatedTelecomNumber: char(199)
PK
1
FK + PK_Person(int) FK
+ FK_PersonPostalAddress_Person(int) (personIdNumber = idNumber) + FK_PersonTelecommunicationAddress_Person(int)
1
PK 1
+ PK_PersonPostalAddress(int)
(personIdNumber = idNumber)
PersonAlternateName
PersonIdentifier
*PK idNumber: int 0..*
*FK personIdNumber: int *PK idNumber: int
* typeCode: char(1) FK organizationIdNumber: int
* surname: char(50) * idCode: char(15)
(administeringProvideridNumber = idNumber)
givenName: char(30) *FK personIdNumber: int
middleName: char(30) idTypeCode: char(6)
nameSuffix: char(20) (patientIdNumber = idNumber) * idAssigningAuthority: char(20)
0..*
* statusCode: char(2)
FK
FK
+ FK_PersonAlternateName_Person(int)
+ FK_PersonIdentifier_Organization(int)
+ FK_PersonIdentifier_Person(int)
VaccineAdministration 0..*
0..*
FK administeringProvideridNumber: int
*FK patientIdNumber: int Patient
*PK idNumber: int
*PK idNumber: int
*FK FacilityIdNumber: int 0..*
FK facilityIdNumber: int
* doseSequenceNumber: numeric(4) PatientRelationship
* birthDate: datetime
* substanceIdCode: char(20)
birthStateCode: char(60) *PK idNumber: int
* startDateTime: datetime
multipleBirthIndicator: char(1) *FK patientIdNumber: int
* endDateTime: datetime
(patientIdNumber = * sexCode: char(1) * typeCode: char(20)
* substanceAdministeredAmount: numeric(20)
idNumber) deathIndicator: char(1) *FK patientIdNumber: int
* routeIdCode: char(20) (patientIdNumber =
* raceCode: char(20) *FK personIdNumber: int
* substanceUnitOfMeasureCode: char(20) 0..* 1 idNumber)
* ethnicityCode: char(20) * effectiveDate: datetime
* siteIdCode: char(20) 1 1..*
* allowableReminderTypeCode: char(20)
substanceLotNumber: char(20) FK
* primaryLanguageCode: char(20) (organizationIdNumber = idNumber)
* substanceDosageFormIdCode: char(20)
recordSharingConsentIndicator: char(1) + FK_PatientRelationship_Patient(int)
* substanceManufacturerIdCode: char(20)
immunizationRegistryStatusCode: char(1) + FK_PatientRelationship_Person(int)
* systemEntryDateTime: datetime
PK
FK + PK_PatientRelationship(int)
FK
+ FK_Patient_Facility(int)
+ FK_VaccineAdministration_Facility(int)
PK
+ FK_VaccineAdministration_Patient(int) 0..*
+ FK_VaccineAdministration_Person(int) + PK_Patient(int)
PK 0..*
+ PK_VaccineAdministration(int) (FacilityIdNumber = idNumber)
normally receives
1 care at
(vaccineAdministrationIdNumber = idNumber)
Facility
1
*PK idNumber: int 1
FK providerOrganizationIdNumber: int
Organization
addressLine1Text: char(120)
addressLine2Text: char(120) *PK idNumber: int
0..*
cityName: char(50) idCode: char(20)
TreatmentRefusal statePostalCode: char(50) (providerOrganizationIdNumber * assigningAuthorityIdCode: char(20)
postalCode: char(12) = idNumber) * name: char(50)
*PK reasonIdCode: char(20) countryCode: char(3) 0..* 0..1
*pfK vaccineAdministrationIdNumber: int addressTypeCode: char(3) PK
+ PK_ProvderOrganization(int)
FK FK
+ FK_TreatmentRefusal_VaccineAdministration(int) 0..1
+ FK_Facility_ProviderOrganization(int)
PK PK
+ PK_TreatmentRefusal(char, int) + PK_Facility(int)
1
(identifierAssigningAuthority = idNumber)
0..*
FacilityAlternateIdentifier
*PK facilityAlternateId: char(20)
*pfK FacilityIdNumber: int
FK identifierAssigningAuthority: int
identifierTypeCode: bigint
FK 0..*
+ FK_FacilityAlternateIdentifier_Facility(int)
+ FK_FacilityAlternateIdentifier_Organization(int)
PK
+ PK_FacilityAlternateIdentifier(char, int)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message Level Profiles
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 Message Profile Dynamic Definition
The dynamic definition describes the supported use cases, interactions, and
acknowledgement requirements.
Use Case Model
The use case portion of the message profile dynamic definition documents the scope
and requirements for an HL7 message profile or set of message profiles. The use case
model documents the purpose for each message exchange; defines the actors, including
the sending and receiving applications; and document the situations in which the
exchange of a particular HL7 message profile is required
Interaction Model
The Interaction Model illustrates the sequence of trigger events and resulting message
flows between 2 or more systems. It may be in literal or graphical form. Graphical form
should be a UML activity diagram.
Acknowledgement Requirements
The specific HL7 acknowledgments required and/or allowed for use with the specified
static definition of the HL7 message profile is defined. Specifically, the dynamic definition
identifies whether accept and application level acknowledgments are allowed or required.
For any one static definition there may be one or more dynamic definitions. The
dynamic definition defines the conditions under which accept and application level
acknowledgments are expected. Allowed conditions include: Always, Never, Only on
success, and Only on error.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
HL7 Message Profile Static Definition
The static definition describes usage rules, cardinalities, and code systems.
Usage Rules
Usage refers to the circumstances under which an element appears in a message instance.
Some elements must always be present, others may never be present, and others may only
be present in certain circumstances. HL7 has defined a set of codes to clearly identify the
rules governing the presence of a particular element. These usage codes expand/clarify the
optionality codes defined in the HL7 standard.
Cardinality
Cardinality identifies the minimum and maximum number of repetitions for a particular element
(Segment Group, Segment or Field). Cardinalities are expressed as a minimum-maximum pair
of non-negative integers. A conformant application must always send at least the minimum
number of repetitions, and may never send more than the maximum number of repetitions.
Vocabulary Specification
Vocabulary specifications declare an organized set of code systems and code system terms.
Code system terms are coded concepts including concept codes, concept names, and
concept relationships. Code system terms are collected into value sets declared as code
tables associated with segment fields and data type components. The static definition
declares the value sets for tables associated with coded message elements. Some of the
value sets are HL7 defined, third party defined, or user defined.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Use Case Diagram
ud Use Case Model
1.0 Immunization
3.0 Vaccine
Vaccine Record Update History Query
Record Update Prov ider Organization
Immunization History Request
Query Response
Update Confirmation
Update Confirmation
2.0 Patient
Demographic
Update
SIIS Registry
Administration
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Activity Model
ad InteractionActiv ityModel
Requesting Registry System SIIS SIP Immunization Information Exchange System Responding Registry System
3
[Valid Message]
2
[Invalid Message]
4
[Desired Record Not Present]
4.3 Route Response
5.2 Select Desired Record «message» Message [No Matching Record]
M.09 Multiple Matching «message»
Record Message (VXX) 3.2.1 Return "No Matching
M.04 No Matching Record" Response
Record Response (QCK)
«datastore» 6
D.01 Immunization
Registry «message»
3.2.3 Return Requested [Single Matching Record]
M.06 Requested Immunization Data
Immunization Data (VXR)
5
«message»
4.4 Notify System
[Invalid Message] M.07 Response Message Administrator
Error (ACK)
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIP SIP Interaction Model
sd Interactions
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Acknowledgement Requirements
Message Source Destination Acknowledgment
• Vaccination Record Query (VXQ) Requester IIES Only on error
• General Acknowledgement (ACK) IIES Requester Never
• Vaccination Record Query (VXQ) IIES Responder Never
• Query Acknowledgement (QCK) Responder IIES Only on error
• General Acknowledgement (ACK) IIES Responder Never
• Query Acknowledgement (QCK) IIES Requester Never
• Vaccination Query Response (VXX) Responder IIES Only on error
• General Acknowledgement (ACK) IIES Responder Never
• Vaccination Query Response (VXX) IIES Requester Never
• Vaccination Query Response (VXR) Responder IIES Only on error
• General Acknowledgement (ACK) IIES Responder Never
• Vaccination Query Response (VXR) IIES Requester Never
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message
Profile Static
Definitions
The static definition portion of
the message profile declares
the usage and cardinality
constraints for the constituent
message elements of the SIIS
SIP HL7 messages.
There is a static definition for
each message type (VXQ, VXX,
VXR, QCK, and ACK).
Each static definition includes a
message level, segment level,
and field level definition.
The static definition also
includes a supported elements
definition.
The supported elements
definition is a field level
definition containing supported
message elements only.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message
Profile Static
Definitions
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message
Profile Static
Definitions
The static definition portion of
the message profile declares
the usage and cardinality
constraints for the constituent
message elements of the SIIS
SIP HL7 messages.
There is a static definition for
each message type (VXQ, VXX,
VXR, QCK, and ACK).
Each static definition includes a
message level, segment level,
and field level definition.
The static definition also
includes a supported elements
definition.
The supported elements
definition is a field level
definition containing supported
message elements only.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message Profile
Vocabulary Specification
The Health Level Seven (HL7)
message profile vocabulary
specification is a companion
document to the California State
Immunization Information System
System Interface Project HL7
message profiles.
The specification contains the value
sets for supported coded message
elements identified in the profile.
The values presented in this
specification are the primary code
values to be used for coded
message elements in the SIIS SIP
message profile.
Fields with a data type of CE may
include an equivalent code drawn
from an alternate coding system.
However, the values included in this
specification must be used as the
primary code.
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP Message Profile
Vocabulary Specification
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Application Testing
sd Dynamic View
User Interface Query Initiating Registry Mess ages Query Responding Registry
VXX: Multiple Record Detail Display VXX: Multiple Matches [Multiple Matching Records]
Response
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
act 2.0 Immunization Query Response
[No Re cords]
[Multiple Records]
Send VXX
ActivityFinal
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Test Themes and Scenarios
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Test Scenarios
Valid Message Syntax, Content, and Flow
This set of tests is intended to ensure that the systems produce the
appropriate flow of messages, with the proper content, and in the proper
syntax. These tests should not result in anything being written to the error
log.
VXQ, QCK
This scenario is a query for a patient that is known to have no match in the remote
system. The remote system is expected to respond with a QCK.
The test data should include patients with varying ranges of matching confidence.
VXQ, VXR
This scenario is a query for a patient that is known to match a single patient in the
remote system. The remote system is expected to respond with a VXR.
The test data should include patients with varying ranges of matching confidence.
A subset of patients should have locked records to test the “locked record” alerting
process
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Test Scenarios
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
SIIS SIP HL7 Message Profile Links
http://www.ca-siis.org/images/docs/SIIS_SIP_HL7_MessageProfile_V1-1.pdf
http://www.ca-siis.org/images/docs/SIIS_SIP_HL7_Message_Profile_Vocabulary_Specification_V1-0.pdf
http://www.ca-siis.org/images/docs/SIIS_SIP_LogicalDataModel_v1-0.pdf
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Questions
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.
Thank You
Office: (909) 596-6790 Mobile: (626) 644-4491 Office: (626) 256-4673 Mobile: (626) 644-4491
Email: AbdulMalik@ShakirConsulting.com Email: ashakir@coh.org
© 2010 Health Level Seven ® International. All Rights Reserved. HL7 and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.