HL7 Blood Banks
Content
V26_IG_BBDONAT_R1_INFORM_2012JAN
HL7 Version 2.6 Implementation Guide:
Blood Bank Donation Services (US Realm), Release 1
January, 2012
Based on the HL7 v2.6 Interoperability Standard
(with pre-adoptions from HL7 v2.8)
HL7 Informative Document
Sponsored by:
Orders and Observations Work Group
Copyright © 2012 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is
strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are registered trademarks of
Health Level Seven International. Reg. U.S. Pat & TM Off.
IMPORTANT NOTES:
HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from
HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license,
please visit http://www.HL7.org/implement/standards/index.cfm.
If you are the individual that obtained the license for this HL7 Standard, specification or other
freely licensed work (in each and every instance "Specified Material"), the following describes the
permitted uses of the Material.
A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to
the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified
Material to develop and sell products and services that implement, but do not directly incorporate, the
Specified Material in whole or in part without paying license fees to HL7.
INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional
items of Special Material in whole or part, into products and services, or to enjoy additional authorizations
granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL
MEMBERS of HL7.
B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are
authorized, without additional charge, on a perpetual (except as provided for in the full license terms
governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal
purposes only) and share this Material with your employees and consultants for study purposes, and (b)
utilize the Material for the purpose of developing, making, having made, using, marketing, importing,
offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all
cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual
property rights of third parties (which may include members of HL7). No other license, sublicense, or
other rights of any kind are granted under this Agreement.
C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are
authorized, without additional charge, to read and use the Specified Material for evaluating whether to
implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell
products and services that implement, but do not directly incorporate, the Specified Material in whole or in
part.
NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into
products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL
MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7.
Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.
Page 2
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
Acknowledgements
Chapter Chair:
Chapter Chair:
Chapter Chair:
Chapter Chair:
Chapter Chair:
Project chair and Principal
Author:
Project Chair and Coordinator:
Hans Buitendijk
Siemens Medical Solutions Health Services Corporation
Patrick Loyd
Gordon Point Informatics Ltd.
Austin Kreisler
SAIC - Science Applications International Corp
Ken McCaslin
Quest Diagostics, Incorporated
Rob Hausam
OntoReason
Patrick Loyd
Gordon Point Informatics Ltd.
Jonathan Harber
Blood Systems, Inc.
Thanks to the Project Team of experts who met over the course of 2009 & 2010 to produce this guide and
upgrades to the v2.8 HL7 Standard for Blood Donation Services. The Project Team is listed below.
Name
Jonathan Harber*
Rodeina Davis*
Melinda Bryant
Amit Bhagat
Shri Potdar
Patrick Loyd*
Robert Kapler
Pat Distler
Patti Larson*
Ruth Harkin
Peggy Dunn
Goudar Shankar
Jeff Wurst
Sue McBride
Philip Abrams
Suzanne Nagami*
David Eide*
Joe Foster
Rick Stone
Troy Campbell
Bob Diol
Organization
Blood Systems, Inc.
Blood Center of Wisconsin
ITSynergistics
Blood Center of Wisconsin
Mediware
GPI
ABC
ICCBBA
Haemonetics
NY Blood Center
Puget Sound Blood Center
Carter BloodCare
BBCS
MAK-System
Talisman
Kaiser Permanente
Group Health Cooperative
Fenwal
Healthcare-ID
Florida Blood Services
Blood Center of Wisconsin
* Denotes HL7 OO Work Group Member
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 3
© 2012 Health Level Seven International. All rights reserved.
TABLE OF CONTENTS
1
2
3
4
5
INTRODUCTION ............................................................................................................................................ 7
1.1
Purpose................................................................................................................................................... 7
1.2
Audience ................................................................................................................................................. 7
1.3
Scope ...................................................................................................................................................... 7
1.4
Assumptions ........................................................................................................................................... 7
1.5
Conventions ............................................................................................................................................ 8
1.6
Open Issues ............................................................................................................................................ 9
MESSAGING INFRASTRUCTURE .............................................................................................................. 13
2.1
Delimiters .............................................................................................................................................. 13
2.2
Null Values ............................................................................................................................................ 14
2.3
Lengths ................................................................................................................................................. 14
2.4
Snapshot processing ............................................................................................................................ 14
2.5
Use Of Escape Sequences In Text Fields ............................................................................................ 15
2.6
Acknowledgements ............................................................................................................................... 15
2.7
Field Lengths ........................................................................................................................................ 15
MESSAGE PROFILE – Blood BANK DONATION PROCESS MESSAGING .............................................. 16
3.1
Usage Notes for Donation Service (Blood Bank) .................................................................................. 16
3.2
Activity Diagram .................................................................................................................................... 16
3.3
Actors .................................................................................................................................................... 18
3.4
Dynamic Definition ................................................................................................................................ 19
3.5
Interactions ........................................................................................................................................... 20
MESSAGES ................................................................................................................................................. 24
4.1
DBC - Create Donor Record Message (Event O41) ............................................................................. 26
4.2
DBU - Update Donor Record Message (Event O42) ............................................................................ 27
4.3
QBP - Get Donor Record Candidates (Event Q33)............................................................................... 28
4.4
RSP - Get Donor Record Candidates Response (Event K33) .............................................................. 29
4.5
QBP - Get Donor Record (Event Q34).................................................................................................. 30
4.6
RSP - Get Donor Record Response (Event K34) ................................................................................. 31
4.7
DRG - Donor Registration (Event O43) ................................................................................................ 33
4.8
DER - Donor Eligibility Request (Event O44)........................................................................................ 34
4.9
DEO - Donor Eligibility Observations (Event O45) ................................................................................ 35
4.10
DEL - Donor Eligibility (Event O46) .................................................................................................. 37
4.11
DRC - Donor Request to Collect (Event O47) .................................................................................. 38
4.12
DPR - Donation Procedure (Event O48)........................................................................................... 39
4.13
ACK – Acknowledgement ................................................................................................................. 41
SEGMENT AND FIELD DESCRIPTIONS .................................................................................................... 42
5.1
Segment Attribute Table Abbreviations ................................................................................................ 42
5.2
Segment Usage Definitions .................................................................................................................. 43
5.3
MSH – Message Header Segment ....................................................................................................... 44
5.4
MSA – Acknowledgement Segment ..................................................................................................... 46
5.5
ERR – Error Segment ........................................................................................................................... 47
5.6
PID – Patient Identification Segment .................................................................................................... 48
5.7
PD1 – Patient Additional Demographic................................................................................................. 50
5.8
PV1 – Patient Visit Information ............................................................................................................. 51
5.9
OBR – Observation Request Segment ................................................................................................. 53
5.10
OBX – Observation Result Segment (Questionnaire Responses and Mini-Physical) ...................... 56
Page 4
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
5.11
OBX – Observation Result Segment (Donor) ................................................................................... 58
5.12
OBX - Observation Identifiers (Donor) .............................................................................................. 59
5.13
OBX – Observation Result Segment (Donation and Adverse Events) ............................................. 62
5.14
OBX - Observation Identifiers (donation and Adverse Events) ......................................................... 63
5.15
AL1 – Patient Allergy Information Segment ...................................................................................... 65
5.16
NTE – Notes and Comments Segment ............................................................................................ 66
5.17
DON - Blood Bank Donation Segment ............................................................................................. 67
5.18
BUI – Blood Unit Information Segment ............................................................................................. 69
5.19
RCP – Response Control Parameter Segment ................................................................................ 70
5.20
QPD – Query Parameter Definition Segment – For Event Q33 ........................................................ 71
5.21
QPD – Query Parameter Definition Segment – For Event Q34 ........................................................ 73
5.22
QAK – Query Acknowledgement Segment....................................................................................... 73
6
CODE SYSTEMS AND VALUE SETS ......................................................................................................... 74
6.1
Code Table Abbreviations..................................................................................................................... 75
6.2
User-Defined Table HL70001 – Administrative Sex.............................................................................. 75
6.3
User-Defined Table HL70003 – Event Type ......................................................................................... 76
6.4
User-Defined Table HL70005 – Race ................................................................................................... 76
6.5
HL7 Table HL70008 – Acknowledgement Code ................................................................................... 77
6.6
HL7 Table HL70076 – Message Type .................................................................................................. 77
6.7
HL7 Table HL70103 – Processing ID ................................................................................................... 77
6.8
HL7 Table HL70125 – Value Type........................................................................................................ 78
6.9
HL7 Table HL70136 - Yes/No Indicator ................................................................................................ 79
6.10
HL7 Table HL70155 – Accept/Application Acknowledgment Conditions .......................................... 79
6.11
User-Defined Table HL70189 – Ethnic Group .................................................................................. 80
6.12
User-Defined Table HL70190 - Address type ................................................................................... 80
6.13
HL7 Table HL70191 – Type Of Referenced Data ............................................................................. 80
6.14
HL7 Table HL70200 - Name Type .................................................................................................... 81
6.15
HL7 Table HL70201 - Telecommunication use code ........................................................................ 81
6.16
HL7 Table HL70202 - Telecommunication Equipment Type code ................................................... 81
6.17
HL7 Table HL70203 – Identifier Type ............................................................................................... 82
6.18
External Table HL70291 – Sub Type Of Referenced Data ............................................................... 83
6.19
HL7 Table HL70299 – Encoding....................................................................................................... 83
6.20
User-Defined Table HL70300 – Namespace ID ............................................................................... 83
6.21
User-Defined Table HL70305 – Person Location Type .................................................................... 84
6.22
HL7 Table HL70354 – Message Structure ....................................................................................... 84
6.23
HL7 Table HL70357 – Message Error Condition Codes................................................................... 85
6.24
Hl7 Table HL70396 – Coding System .............................................................................................. 85
6.25
User-Defined Table HL70471 – Query Name................................................................................... 86
6.26
HL7 Table HL70516 – Error Severity................................................................................................ 86
6.27
User-Defined Table HL70559 – Duration Units ................................................................................ 86
6.28
User-Defined Table HL70560 – Blood Procedure Type ................................................................... 87
6.29
User-Defined Table HL70561 – Process Interruption ....................................................................... 87
6.30
User-Defined Table HL70562 – Process Interruption Reason.......................................................... 88
6.31
User-Defined Table HL70564 – Phlebotomy Issue........................................................................... 88
6.32
User-Defined Table HL70563 – Phlebotomy Status ......................................................................... 89
6.33
User-Defined Table HL70565 – Arm Stuck ...................................................................................... 89
6.34
User-Defined Table HL70566 – Blood Unit Type ............................................................................. 89
6.35
User-Defined Table HL70567 – Weight Units................................................................................... 90
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 5
© 2012 Health Level Seven International. All rights reserved.
6.36
User-Defined Table HL70568 – Volume Units.................................................................................. 90
6.37
User-Defined Table HL70569 – Temperature Units ......................................................................... 91
6.38
HL7 Table HL70834 – MIME Type ................................................................................................... 91
7
Data Types ................................................................................................................................................... 92
7.1
Data Types Summary ........................................................................................................................... 92
7.2
Data Type Table Abbreviations............................................................................................................. 93
7.3
CNE – Coded No Exceptions................................................................................................................ 95
7.4
CNN – Composite ID Number and Name Simplified............................................................................. 96
7.5
CQ – Composite Quantity with Units .................................................................................................... 97
7.6
CWE – Coded with Exceptions ............................................................................................................. 97
7.7
CX – Extended Composite ID with Check Digit .................................................................................... 98
7.8
DTM – Date/Time.................................................................................................................................. 99
7.9
ED – Encapsulated Data....................................................................................................................... 99
7.10
EI – Entity Identifier......................................................................................................................... 100
7.11
FN – Family Name .......................................................................................................................... 100
7.12
FT – Formatted Text Data .............................................................................................................. 101
7.13
HD – Hierarchic Designator ............................................................................................................ 101
7.14
ID – Coded Value for HL7-Defined Tables ..................................................................................... 102
7.15
IS – Coded Value for User-Defined Tables .................................................................................... 102
7.16
MSG – Message Type .................................................................................................................... 102
7.17
NM – Numeric ................................................................................................................................. 103
7.18
PT – Processing Type .................................................................................................................... 103
7.19
RP – Reference Pointer .................................................................................................................. 103
7.20
SAD – Street Address..................................................................................................................... 104
7.21
SI – Sequence ID............................................................................................................................ 105
7.22
SN – Structured Numeric ................................................................................................................ 105
7.23
ST – String Data ............................................................................................................................. 106
7.24
TX – Text Data................................................................................................................................ 106
7.25
VID – Version Identifier ................................................................................................................... 106
7.26
XAD – Extended Address ............................................................................................................... 107
7.27
XCN – Extended Composite ID Number and Name for Persons.................................................... 107
7.28
XON – Extended Composite Name and Identification Number for Organizations .......................... 109
7.29
XPN – Extended Person Name ...................................................................................................... 109
7.30
XTN – Extended Telecommunication Number ............................................................................... 110
Page 6
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
1 INTRODUCTION
1.1 PURPOSE
The HL7 Blood Bank Donation Services Implementation Guide – U.S. Realm is a messaging specification
intended to standardize the electronic transmission of information between system application
components in a Blood Bank setting. While this is U.S. Realm specific, there are no constraints that are
U.S. specific; rather the project team did not include sufficient International stakeholder representation to
assert the outcome and this Implementation Guide is Universal in nature.
This Implementation Guide is specific to the interoperability to support activities related to the registration,
screening for eligibility, donation, and collection of blood from a human. The goal of this specification is to
provide an applicable specification that can be adopted as an industry standard, thereby obviating the
need for individual vendors to define anew the specifications of each Donation Service interface required.
1.2 AUDIENCE
The standards defined in this guide are intended for use by clinical data exchange systems found in the
Blood Donation community groups listed below:
•
Blood Centers in the United States of America - Any service center that performs the collection of
blood.
•
Physician’s Offices – Any care practice, clinic, hospital, individual physician, or department that
orders directed or autologous (self) donations.
1.3 SCOPE
This specification focuses exclusively on the electronic transfer of information between system application
components used to support activities for the collection and donation of blood. This Implementation
Guide does not include:
•
definition for maintaining a registry of providers who can ‘order’ blood donations.
•
definition for communication between automated lab testing devices and Lab Information
Systems.
•
definition for communicating shipping information.
Although this Implementation Guide does not include the definitions immediately foregoing in this
paragraph, reuse of the information in this document to aid activities designed to automate those
definitions is not precluded.
The remainder of this document specifies the dynamic and static aspects of this Implementation Guide.
Although this document describes the elements of HL7 messages and messaging interactions as they
relate to this specification, it does not constitute an introduction to HL7. Readers unfamiliar with HL7
should first review the HL7 2.x standard (especially Chapters 4 and 7), available to HL7 members or for
purchase at www.hl7.org.
1.4 ASSUMPTIONS
This document assumes that users have a need to electronically exchange blood donation services
information. It also assumes that the user is familiar with the HL7 v2.6 standard.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 7
© 2012 Health Level Seven International. All rights reserved.
1.5 CONVENTIONS
This specification is based on the HL7 version 2.6 messaging standard. Because the v2.6 HL7 Standard
does not contain relevant elements to communicate blood donation information, two segments (DON –
Blood Donation Segment & BUI – Blood Unit Information) and all the message types are pre-adopted
from the HL7 v2.8 Standard.
Note that the HL7 v2.8 Standard is still in ballot along with this document and, therefore, there is some risk of change. However,
stakeholders interested in blood donation messaging based on HL7 v2.x were invited to participate with the project team to
minimize risk of change during balloting and reconciliation.
The specification defines message profiles for relevant HL7 message types. A message profile is an
unambiguous specification of an HL7 message type intended for a particular use case, as defined in
Section 2.12 of the HL7 v2.6 standard.
A message profile defines both the dynamic aspects of information interchange (i.e., the systems that
participate in such interchanges and the real-world events that trigger the interchanges) as well as the
static aspects of messaging (i.e., the structure and contents of the electronic messages that are
exchanged).
•
The rules outlined in HL7 2.6, Chapter 2, section 2.12, Conformance Using Message Profiles,
were used to document the use case for, and constraints applied to, the messages described in
this guide.
•
Data types have been described separately from the fields that use the data types. For details
regarding data type field lengths, please refer to section 2.3, Lengths, in this document.
Page 8
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
1.6 OPEN ISSUES
1
P. Loyd
11/8
Is this IG US Realm or Universal?
> Believe US Realm; Universal can use it, but
International stakeholders were not vetted.
Closed
2
P. Loyd
11/8
How much detail for data types?
>We believe the amount of detail in this guide is
appropriate for an IG. It is expected that vendors and
other stakeholders directly using this guide
would/could gain access to the base HL7 v2.6
Standard.
Closed
3
P. Loyd
11/8
Confirm methodology; no unlimited (*) cardinalities
>Author used the 10, 100, 1000, 10000 method
> Medications – upper limit of 25
>Donor-obs – 10 is fine
Adverse Reaction obs- 10 is too little based on
hierarchy (PEL, updated to 100)
> All NTEs updated to 1..100
> Donor Candidates response max limit updated to
1000
Closed
4
P. Loyd
11/8
Query Parameters
>FN (Given Names), LN, DOB, Admin Sex for
Candidates
>For Donor Record, use only donor id
Closed
5
P. Loyd
11/8
Should there be a group around donation. Under what
circumstances is there more than one DON? Check
the minutes to see if we have that point documented
(cause we need it).
>More than one stick, then more than one DON
PEL> fixed cardinality of group vs DON segment for
DPC and RSP
Closed
6
P. Loyd
11/8
Section 2.5 – Leave the notes to balloters from the IG
where some of the materials were sourced?
>No, remove them
Closed
7
P. Loyd
11/8
Confirmation and/or rejection interactions
>Need this ability – forward thinking
PEL> update graphic, ensure IG has all the right
pieces/parts for ack’ing and nack’ing
PEL> Determined to use original acknowledgement
mode (and not enhanced mode).
Closed
8
P. Loyd
11/8
Why are create/update separate Donor BoR?
>Like them separate (which is OK)
Closed
9
P. Loyd
11/8
Confirm mapping ConditionText to TQ1
Who is the administrator of the questionnaire: donor or
staff, if staff – indicate in OBR 10.1
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 9
© 2012 Health Level Seven International. All rights reserved.
> Map to OBX Responsible Observer, use ‘donor’
value or the staff person’s ID when appropriate
10
P. Loyd
11/8
HL7 tables need further constraining: 0008, 0125,
0155, 0357, 0516
PEL> 0008, 0155, 0357, 0516 (done)
JH, PL> value type 0125 (from min-physical and
questionnaires). What types of values do we expect?
Team> Review value types included in this profile
Closed. The
team reviewed
these data
types and has
agreed that
these types will
be sufficient to
address all
required use
cases
11
P. Loyd
11/8
Data types incomplete
Closed
12
P. Loyd
11/8
Confirm mapping Medication – RXA
PEL> Mapped into donor-level OBXs
Closed
13
P. Loyd
11/8
Add IG-specific language from minutes
Closed
14
P. Loyd
11/8
AL1-3, data type is CWE
PEL> determine to make CWE but not recommend a
code system for this IG.
Closed
15
P. Loyd
11/8
Need a profileID
PEL> One is recommended
Closed
16
P. Loyd
11/8
User-defined tables need further constraining or
values: Sex 0001,
Race 0005,
ethnic group 0189,
address type 0190 (only support home, business),
organization name types 0204 (not supported),
language 0296 (not supported)
Closed
17
P. Loyd
11/8
Create donor-level OBX
Closed
18
P. Loyd
11/8
Create donation-level OBX
Closed
19
P. Loyd
11/8
Create adverse event-level OBX
Closed
20
P. Loyd
11/9
Do we need ED and RP data type? Do we support
either a reference pointer to data (for example, a pdf
file) or are we ready to embed the .pdf in an ED?
More specific, but duplicate of #10, table 0125.
Closed
21
P. Loyd
11/9
Should the mappable data elements be RE or O?
Team> RE
Closed
22
P. Loyd
11/9
Namespace methodology was chosen (for now) for
identifiers
Closed
23
P. Loyd
11/9
Team to check the lengths of strings (for example, last
name is 999 characters, at the moment)
Closed
Page 10
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
PEL> All places where the limit was 999 has been
restricted. Needs review by team.
24
P. Loyd
11/9
What’s the strategy for optional vs. RE (see #21)
Closed
25
P. Loyd
11/9
Use of UCUM
PEL> UCUM is standard. Just wanted to initially point
this out.
Closed
26
P. Loyd
11/9
Use of ISO 3166-1 for country codes
PEL> ISO is standard. Just wanted to initially point
this out.
Closed
27
P. Loyd
11/9
Check mapping 3.8, 3.9
PEL> Moved both to new fields in DON. Will need to
change OO proposal to reflect this update.
Closed
28
P. Loyd
12/6
Length (query parameter) for patient id, 20 characters
lastname, 50 characters
firstname, 50 characters
Include time for DOB? No, date only
Closed
29
P. Loyd
12/6
Support for multiples and use/type codes:
Telephone (and use code) 0201, 0202 (home, office,
cell only) up to 3
Address (and use code) 0190, up to 2, home, work
Name (and use code) 0200 (PEL look 1.5-1.12)
PEL> Nickname, Maiden Name in standard. Need
more info re: previous name (open a new issue below)
Race 0005 , (includes all races which does include
indigenous tribe designations)
language 0296, (no one supports)
ethnicgroup 0189, (Hispanic, non-hispanic designation
only)
identifiers 0203 (need survey)donor number, national
id, legacy id 1, legacy id 2 (limit of 4);
Select the max’es; field lengths and usage
Closed
30
P. Loyd
12/13
Add code tables to support ED data types
Closed
31
P. Loyd
12/30
Need more information on previous name. The HL7
standard supports this with effective date ranges for
any and all names and doesn’t support a ‘soft’ concept
like ‘previous’.
JH> Will survey vendors
PEL> Selected ‘B’ and document such from the
mapping document
Closed
32
P. Loyd
12/30
Change to naming of table 0001 – Administrative Sex
to Gender does not conform to the HL7 standard
(which might confuse folks)
Closed
33
P. Loyd
12/30
Mapping for usual collection location (PV1) and
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 11
© 2012 Health Level Seven International. All rights reserved.
collection facility (PDA) seem incorrect. Review with
team at next meeting
34
Page 12
P. Loyd
1/15/2011
What’s the difference between DON 28 and DON 33?
Closed
Jonathan
Presented Use
Cases to
Patrick for
inclusion.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
2 MESSAGING INFRASTRUCTURE
2.1 DELIMITERS
This profile supports the use of the normal HL7 delimiters. It is recommended, but not required, that
implementers be able to send messages using the standard HL7 delimiters. Receivers must, however,
be capable of receiving any legal delimiters that are sent in a particular message instance.
This table is adopted from the HL7 Version v2.6 Standard which offers information regarding Best
Practice. Note that this implementation guide includes additional constraints and explanations for some of
the entries.
TABLE 2-1 – DELIMITERS
Delimiter
Suggested
Encoding
Value
Character
Segment
Terminator
<cr>
-
Field Separator
|
-
Component
Separator
^
1
Repetition
Separator
~
2
Escape Character
\
3
Position
Description
Terminates a segment record. This value cannot
be changed by implementers.
Additional constraints and Explanation:
The <cr> denotes the ASCII-013 carriage return
character. There is a common misunderstanding
that a line feed character, or carriage return
followed by a line feed character, is allowed also.
Neither of these 2 methods are allowed by HL7 or
this profile as part of the segment terminator.
Only the ASCII-013 carriage return is allowed.
Separates two adjacent data fields within a
segment. It also separates the segment ID from
the first data field in each segment.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-124, the vertical bar (|) character, as the
field separator.
Separates adjacent components of data fields
where allowed.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-094, the caret (^) character, as the
component separator.
Separates multiple occurrences of a field where
allowed.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-126, the tilde character (~), as the
repetition separator.
Escape character for use with any field
represented by an ST, TX or FT data type, or for
use with the data (fourth) component of the ED
data type. If no escape characters are used in a
message, this character may be omitted.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 13
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-1 – DELIMITERS
Delimiter
Subcomponent
Separator
Suggested
Encoding
Value
&
Character
Position
4
Description
However, it must be present if subcomponents
are used in the message. Best practice is to
always include this character.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-091, the backslash (\) character, as the
escape character.
Separates adjacent subcomponents of data fields
where allowed. If there are no subcomponents,
this character may be omitted. Best practice is to
always include this character.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-038, the ampersand (&) character, as the
subcomponent separator.
2.2 NULL VALUES
In HL7, a null value is indicated by paired double quotes (|""|) for a field. A null value indicates that the
receiver of the message should delete the corresponding piece of information from its data store. For this
implementation guide, null values within components and subcomponents are meaningless. For example
|lastname^firstname^""^^^^L| would be interpreted exactly as |lastname^firstname^^^^^L|. The
components and subcomponents of a data type constitute a snapshot of the data. The set of data
represented by the data type is handled as a complete set; therefore, using the null value to indicate a
missing component or subcomponent is unnecessary.
2.3 LENGTHS
In HL7 Version 2.5, HL7 assigned lengths to the components of data types, but did not standardize the
lengths of the fields that use those data types. This guide employs the following rules for lengths:
•
Only lengths of atomic data types are documented. This rule applies to both complex data types
and fields in segments.
•
The lengths of atomic data types are based upon either the 2.5.1 length, the 2.6 length, or a
length the project team felt was needed to meet the use case.
•
Lengths of optional and unsupported segment fields and data type components are not
documented in this guide. The lengths of optional and unsupported fields and data type
components are outside the scope of this document.
Note: In HL7 Version 2.5.1, the length of 65536 has a special meaning: For HL7, "If the maximum length needs to
convey the notion of a Very Large Number, the number 65536 should be displayed to alert the user."
In this implementation guide, fields or components with length 65536 should be understood as having no prescribed
length. Receivers should be prepared to accept any size chunk of data carried in the field or component.
2.4 SNAPSHOT PROCESSING
HL7 distinguishes between two methods of update: the "snapshot" and the "action code/unique identifier"
modes. Both modes apply to repeating segments and repeating segment groups. For repeating fields,
Page 14
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
only snapshot processing applies. For the purpose of this guide, only snapshot processing is supported
for segments, segment groups and fields.
2.4.1 REPEATING SEGMENTS
HL7 defines snapshot processing for segments as follows:
In the "snapshot" mode, the information contained in the set of repeating segments or segment groups from the incoming
message replaces the corresponding information in the receiving application. This is equivalent to a deletion of the prior
information followed by the addition of the newly supplied information. In this mode, everything (all repeating segments
and segment groups) must be sent with every subsequent message in the series of messages. There is no other way to
indicate which ones changed and which ones did not.
To specify "delete all of the segments in this repeating group" in the snapshot mode, send a single segment with "delete
data" (indicated by a value of "") in all fields.. This actively signals the receiver that there is information that needs to be
deleted. If no segment were sent, this would equate to "no information." No information should not signal the receiver to
take an action. There would be risk that the receiver might misinterpret the sender's intent. 1
2.4.2 REPEATING FIELDS
Snapshot processing for repeating fields requires sending a full list of repetitions for each transaction. If
the intent is to delete an element, the element is left off the list. This is analogous to the snapshot mode
for repeating segments and segment groups. To delete the whole list, transmit the field once with a "Null"
in the first component.
Repetitions of fields shall not have empty repetitions followed by repetitions containing data, except
where the HL7 standard clearly reserves certain repetitions for specific purposes. For instance PID-5,
Patient Name is a repeating field, the first repetition of which is reserved by HL7 for the legal name. In
the case where a name is known for the patient, but is not the legal name, format the name field as
follows: |~lastname^firstname^mi^^^^A|.
2.5 USE OF ESCAPE SEQUENCES IN TEXT FIELDS
Senders and receivers using this profile shall handle escape sequence processing as described in HL7
Version 2.6, Chapter 2, section 2.7.4 (Special Characters) and section 2.7.5 (Hexadecimal).
Implementers may support escape sequences described in sections 2.7.2 (Escape sequences supporting
multiple character sets), 2.7.3 (Highlighting), 2.7.6 (Formatted Text) and 2.7.7 (Local).
2.6 ACKNOWLEDGEMENTS
Senders and receivers using this profile shall use original mode acknowledgement processing which
defines acknowledgements upon successful or unsuccessful processing of a message by a receiver.
Note that the interaction diagram does not show the acknowledgements.
2.7 FIELD LENGTHS
After lengthy discussion, the authors have concluded that there is no satisfactory way to calculate
maximum length for complex data types with embedded optional components that would be of benefit to
the user. Therefore, lengths are specified only for fields associated with “atomic” data types.
1
Taken from HL7 v2.6 Standard, Chapter 2, section 2.10.4.1.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 15
© 2012 Health Level Seven International. All rights reserved.
3 MESSAGE PROFILE – BLOOD BANK DONATION PROCESS
MESSAGING
The following message profile definitions support communications between systems components often
deployed in a blood donation/collection center.
3.1 USAGE NOTES FOR DONATION SERVICE (BLOOD BANK)
The Blood Bank Donation Service messages and segments were developed using a different
methodology than the similar Transfusion Service (BLOOD BANK) already present in this standard (HL7
v2.6 Standard). Each of the segments defined for the Transfusion Service groups together all the
‘transfusion’ information in one segment, each. The Donation Service was developed breaking out the
blood product ‘donated’ from the donation event itself. This is a more sustainable and interoperable
approach. Future changes to the Transfusion Service should uptake this style.
3.2 ACTIVITY DIAGRAM
The donation service messages have been developed to facilitate communications between typical
system components in a blood bank donation service facility. Frequently different components of blood
banking systems (e.g. registration, questionnaire) are bundled together in one system produced by one
vendor. However since there is no standard for that bundling, in any particular implementation any of the
named system components can be implemented on another system and therefore communications to that
component is necessary. The typical components are illustrated in the graphic on the next page.
Additionally, the graphic also depicts a flow of information through those systems during a donation
process. Note that the interaction diagram does not show the acknowledgements; however, return
acknowledgements are allowed for any non-query message interaction (a QAK acknowledgement is
required for queries; see RSP messages).
Page 16
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 17
© 2012 Health Level Seven International. All rights reserved.
3.3 ACTORS
As mentioned previously, many of the existing systems used in the donation collection process conduct
all these actions in a single bundled system. Extension of the systems on this page is presented in this
format because there is no standard for that bundling, in any particular implementation any of the named
system components can be implemented on another system and therefore communications to that
component is necessary.
3.3.1 ORDERING PROVIDER
For Directed and Autologous Donations, this is the Healthcare Provider requesting a blood
donation.
3.3.2 REGISTRATION SYSTEM
All donors are registered in this system.
3.3.3 DONOR BOOK OF RECORD SYSTEM
This is the source-of-truth for every donor, whether evaluated and deferred, rejected, or not
deferred.
3.3.4 MINI-PHYSICAL SYSTEM
The mini-physical examination conducted on all potential donors is documented using this
system.
3.3.5 QUESTIONNAIRE SYSTEM
Each potential donor must fill out a questionnaire which asks about previous medical history
and risk factors using this documentation system.
3.3.6 DONATION SYSTEM
The phlebotomists and other healthcare professionals use this system to document the blood
donation procedure.
3.3.7 DEVICE INTERFACES
Interface to devices used during the mini-physical, donation, and shipping systems.
3.3.8 PROVIDER MASTER
This system keeps the master list of providers.
3.3.9 SHIPPING SYSTEM
This system is used to document the shipping manifest from information received from the
actual donations.
Page 18
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
3.4 DYNAMIC DEFINITION
TABLE 3-1 – DYNAMIC DEFINITION
Item
Profile ID
HL7 Version
Accept Acknowledgement
Application Acknowledgement
Acknowledgement Mode
Profile Type
Message Types
Encoding
Value
USBBDon
2.6
AL – Always
Refer to HL7 Table 0155 – Accept/application Acknowledgment conditions for valid values.
Immediate
Realm Constrainable Profile
See Section 3.5 - Interactions
A
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 19
© 2012 Health Level Seven International. All rights reserved.
3.5
INTERACTIONS
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
Query for Donor
Candidates (Q33)
Description
Query request candidate
donor information
2
Donor Candidate Query
Response (K33)
Query response candidate
donor information
3
Query for Donor Record
(Q34)
Donor Record Query
Response (K34)
Query request donor record
5
Create Donor Record
(O41)
Create donor record
5
Update Donor Record
(O42)
Update donor book of
record
6
Registration (O43)
Register donor for potential
donation
6
Registration (O43)
Register donor for potential
donation
7
Donor Eligibility Request
(O44)
7
Donor Eligibility Request
Request to conduct Predonation Tests and
Physical Exams. May also
include the questions to
ask.
Request to conduct Pre-
1
4
Query response donor
record
Page 20
© 2012 Health Level Seven International. All rights reserved.
Message
QBP - Get Donor
Record
Candidates
(Event Q33)
RSP - Get Donor
Record Candidates
Response (Event K33)
QBP - Get Donor
Record (Event Q34)
RSP - Get Donor
Record
Response
(Event K34)
DBC – Create Donor
Record Message
(Event O41)
DBU - Update Donor
Record Message
(Event O42)
DRG - Donor
Registration (Event
O43)
DRG - Donor
Registration (Event
O43)
DER - Donor Eligibility
Request (Event O44)
Sending Actor
Donor Registration
System
Receiving Actor
Donor Book of Record
System
Donor Book of Record
System
Donor Registration System
Donor Registration
System
Donor Book of Record
System
Donor Book of Record
System
Donor Registration System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donation System
Donor Registration
System
Electronic Medical
Questionnaire System
DER - Donor Eligibility
Donor Registration
Mini-Physical System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No.
(O44)
Event
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
9
Eligibility (O46)
9
Eligibility (O46)
Description
donation Tests and
Physical Exams. May also
include the questions to
ask.
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Communication of the
eligibility assessment for
this donation event (also
used in the case of a
deferral as well as a
successful eligibility
assessment)
Communication of the
eligibility assessment for
this donation event (also
used in the case of a
deferral as well as a
Message
Request (Event O44)
Sending Actor
System
Receiving Actor
DEO - Donor Eligibility
Observations (Event
O45)
Electronic Medical
Questionnaire System
Donor Registration System
DEO - Donor Eligibility
Observations (Event
O45)
Mini-Physical System
Donor Registration System
DEO - Donor Eligibility
Observations (Event
O45)
Electronic Medical
Questionnaire System
Donor Book of Record
System
DEO - Donor Eligibility
Observations (Event
O45)
Mini-Physical System
Donor Book of Record
System
DEL – Donor Eligibility
(EVENT O46)
Donor Registration
System
Donor Book of Record
System
DEL – Donor Eligibility
(EVENT O46)
Donor Book of Record
System
Donor Registration System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 21
© 2012 Health Level Seven International. All rights reserved.
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
10
Request to Collect (O47)
10
Request to Collect (O47)
11
Donation (O48)
11
Donation (O48)
12
Products Collected
12
Products Collected
12
Products Collected
13
Shipment Manifest
14
Donation Request
Description
successful eligibility
assessment)
Donor / Medical Screener
has completed the
questionnaire portion of the
medical history
Donor / Medical Screener
has completed the
questionnaire portion of the
medical history
Messages may transmit the
answers back, or may
simply indicate that donor
is Not Deferred (yet)
Messages may transmit the
answers back, or may
simply indicate that donor
is Not Deferred (yet)
Communication of blood
unit information for units
collected
Communication of blood
unit information for units
collected
Communication of blood
unit information for units
collected
Shipping manifest for blood
units collected
For directed and
autologous donations, the
request from an ordering
Page 22
© 2012 Health Level Seven International. All rights reserved.
Message
Sending Actor
Receiving Actor
DRC – Donor Request
to Collect (EVENT
O47)
Donor Registration
System
Donation System
DRC – Donor Request
to Collect (EVENT
O47)
Donor Book of Record
System
Donation System
DPR – Donation
Procedure (EVENT
O48)
Donation System
Donor Registration System
DPR – Donation
Procedure (EVENT
O48)
Donation System
Donor Book of Record
System
Not in scope
Donation System
Shipping System
Not in scope
Donor Registration
System
Shipping System
Not in scope
Donor Book of Record
System
Shipping System
Not in scope
Shipping System
Receiving System
Not in scope
Order Management Ordering Provider
Donor Registration System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
14
Donation Request
15
Device Interfaces
15
Device Interfaces
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
17
O41, O42, O43, O44, O45,
O46, O47, O48
Description
provider
For directed and
autologous donations, the
request from an ordering
provider
Communication between
lab testing devices
Communication between
lab testing devices
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Acknowledgements
Message
Receiving Actor
Not in scope
Order Management Ordering Provider
Donor Book of Record
System
Not in scope
Devices
Not in scope
Devices
Electronic Medical
Questionnaire System
Mini-Physical System
Not in scope
Provider Master
Donor Registration System
Not in scope
Provider Master
Not in scope
Provider Master
Donor Book of Record
System
Donation System
Not in scope
Provider Master
Not in scope
Provider Master
Electronic Medical
Questionnaire System
Mini-Physical System
ACK
Varies
Varies
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Sending Actor
Page 23
© 2012 Health Level Seven International. All rights reserved.
4 MESSAGES
The following sections detail the structure of each message, including segment name, usage, cardinality,
and description. The table below details the abbreviated terms used in the message tables, as well as
the definitions associated with those abbreviations.
TABLE 4 -1 – MESSAGE ATTRIBUTES
Abbreviation
Segment
Name
Usage
Cardinality
Section
Description
Definition
Three-character code for the segment and the abstract syntax (e.g., the square and curly braces).
• [ XXX ]
Optional
• { XXX }
Repeating
• XXX Required
•
[{ XXX }] Optional and Repeating
Note that for segment groups there is no segment code present, but the square and curly braces
will still be present.
Name of the segment or segment group element.
Use of the segment for this guide. Indicates if the segment is required, optional, or conditional in a
message. Legal values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• X – Not used.
Minimum and maximum number of times the element may appear.
• [0..0] Element never present.
• [0..1] Element may be omitted and can have, at most, one occurrence.
• [1..1] Element must have exactly one occurrence.
• [0..n] Element may be omitted or may repeat up to n times.
• [1..n] Element must appear at least once, and may repeat up to n times.
• [0..*] Element may be omitted or repeat an unlimited number of times.
• [1..*] Element must appear at least once, and may repeat unlimited number of times.
• [m..n] Element must appear at least m, and at most, n times.
The part of this guide that describes the segment.
A short description of the use of the segment.
Note: In the tables throughout this document, Yellow = This Implementation Guide does not support the
use of this item.
Page 24
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
TABLE 4 -1 – MESSAGE USAGE DEFINITIONS
Value
R
Required
Description
RE
Required but may be empty
X
Not supported
Comment
A conforming sending application shall populate all “R” elements with a nonempty value. Conforming receiving application shall process
(save/print/archive/etc.) or ignore the information conveyed by required
elements. A conforming receiving application shall 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.
Any element designated as required in a standard HL7 message definition
shall also be required in all HL7 message profiles based on that standard
message.
The element may be missing from the message, but shall be sent by the
sending application if there is relevant data to report. A conforming sending
application shall be capable of providing all "RE" elements. If the conforming
sending application knows the required values for the element, then it shall
send that element. If the conforming sending application does not know the
required values, then that element will be omitted.
Receiving applications will be expected to process (save/print/archive/etc.)
or ignore data contained in the element, but shall be able to successfully
process the message if the element is omitted (no error message should be
generated because the element is missing).
For conformant sending applications, the element shall not be sent.
Conformant receiving applications shall ignore the element if it is sent.
However, the receiving application will not raise an application error if it
receives the element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 25
© 2012 Health Level Seven International. All rights reserved.
4.1 DBC - CREATE DONOR RECORD MESSAGE (EVENT O41)
The Create Donor Record messages contain information to create a new donor book of record.
TABLE 4-2 – DBC^O41 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message. This includes
identification of message delimiters, sender, receiver, message type,
timestamp, etc.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
PID
PATIENT - Donor Begin
Patient Identification – Donor
Identification
R
[1..1]
5.6
[PD1]
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor. The subject must be a person
(no animals).
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
[
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
PATIENT – Donor End
Page 26
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.2 DBU - UPDATE DONOR RECORD MESSAGE (EVENT O42)
The Update Donor Record messages contain information to update an existing donor book of record.
TABLE 4-3 – DBU^O42 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
[
PID
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
PATIENT – Donor End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 27
© 2012 Health Level Seven International. All rights reserved.
4.3 QBP - GET DONOR RECORD CANDIDATES (EVENT Q33)
This query/response is designed for interaction between a registration system and the system which contains the Donor Book of Record. The query consists of
query parameters which assist in determining if the Donor already has a record in the Donor Book or Record system. The query parameters are minimal and
number of elements returned in the query response for each candidate is minimal.
TABLE 4-4 – QBP QUERY INFORMATION
Query Statement ID:
Q33
Query Type:
Query by Parameter
Query Name:
GetDonorRecordCandidates
Query Trigger:
QBP^Q33^QBP_Q33
Query Mode:
Immediate
Response Trigger:
RSP^K33^RSP_K33
Query Characteristics
Purpose:
Query is used to find if a donor record exists on the Donor
Book of Record system. A few, basic, demographic
paramters are provided. The return are a set of records
which meet the parameter criteria. The intent is to ‘select’
one of the returned candidate records, then run the Get
Donor Record query to return the detail for that specific
donor.
Returns minimal information for set of donor records
TABLE 4-5 – QBP^Q33 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
QPD
Query Parameter Definition Segment
R
[1..1]
5.16
For communicating query parameters
RCP
Response Control Parameters
R
[1..1]
5.15
For communicating response control parameters
Page 28
© 2012 Health Level Seven International. All rights reserved.
Usage
R
Cardinality
[1..1]
Section
5.3
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.4 RSP - GET DONOR RECORD CANDIDATES RESPONSE (EVENT K33)
TABLE 4-6 – RSP^K33 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
MSA
Message Acknowledgement
R
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
The message scknowledgement segment acknowledges a specific
message (by id)
Any errors during processing
QAK
Query Acknowldgement
R
[1..1]
5.18
Query acknowledgement
QPD
Query Paremeter Definition
R
[1..1]
5.16
Return the query parameters used for selection in this return set.
PATIENT - Donor Begin
Patient Identification – Donor
Identification
PATIENT – Donor End
R
[1..1000]
R
[1..1]
[
PID
]
Usage
R
Cardinality
[1..1]
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Page 29
© 2012 Health Level Seven International. All rights reserved.
4.5 QBP - GET DONOR RECORD (EVENT Q34)
This query/response is designed for interaction between a viewing system and the system which contains the Donor Book of Record. The query consists of query
parameters, and the response of the demographics for that donor.
TABLE 4-7 – QBP QUERY INFORMATION
Query Statement ID:
Q34
Query Type:
Query by Parameter
Query Name:
GetDonorRecord
Query Trigger:
QBP^Q34^QBP_Q34
Query Mode:
Immediate
Response Trigger:
RSP^K34^RSP_K34
Query Characteristics
Uses donor id to find a specific donor record and return it.
Purpose:
Returns demographic information and donations for a donor
TABLE 4-8 – QBP^Q34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
Usage
R
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
QPD
Query Parameter Definition Segment
R
[1..1]
5.17
For communicating query parameters
RCP
Response Control Parameters
R
[1..1]
5.15
For communicating response control parameters
Page 30
© 2012 Health Level Seven International. All rights reserved.
Cardinality
[1..1]
Section
5.3
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.6 RSP - GET DONOR RECORD RESPONSE (EVENT K34)
TABLE 4-9 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
MSA
Message Acknowledgement
R
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
The message scknowledgement segment acknowledges a specific
message (by id)
Any errors during processing
QAK
Query Acknowldgement
R
[1..1]
5.18
Query acknowledgement
QPD
Query Paremeter Definition
R
[1..1]
5.16
Return the query parameters used for selection in this return set.
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
VISIT Donor Registration Begin
Patient Visit – Donor Registration
RE
[0..1000]
R
[1..1]
5.8
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
RE
[0..1000]
[
PID
[{
PV1
[{NTE}]
}]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
[{
Donation Begin
[{DON}]
Donation
RE
[0..1]
5.13
Donation procedure
[{OBX}]
Donation Adverse Reaction
Observations
RE
[0..100]
5.10
Adverse Reaction Observations during the Donation procedure.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 31
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-9 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
[{NTE}]
}]
Name
Notes and Comments for Donation
Usage
RE
Cardinality
[0..100]
Section
5.12
Description
Donation procedure notes and comments
Donation End
Page 32
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.7 DRG - DONOR REGISTRATION (EVENT O43)
The Donor Registration messages contain information to register a donor for a donation.
TABLE 4-10 – DRG^O43 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
Donor Registration-level notes and comments
PATIENT – Donor End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 33
© 2012 Health Level Seven International. All rights reserved.
4.8 DER - DONOR ELIGIBILITY REQUEST (EVENT O44)
The Donor Registration messages contain minimal information about a donor registration.
TABLE 4-11 – DER^O44 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Donor Registration
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
R
[1..100]
Observations Request
R
[1..1]
5.9
Each order group is a question or an indication to perform a miniphysical.
The question or mini-physical request
Notes and Comments for OBR
RE
[0..100]
5.12
Any notes about the question or mini-physical
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
{
ORDER_OBSERVATION Begin
OBR
[{NTE}]
}
ORDER_OBSERVATION End
Page 34
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.9 DEO - DONOR ELIGIBILITY OBSERVATIONS (EVENT O45)
Communicate both mini-physical observations and questions and answers from a donor questionnaire. Note that this message type is a specific sub-set of
the full OUL (Unsolicited Lab Result) Message. The intent is to provide for a smaller message for implementation by blood banking donation
service systems which does not contain all the information necessary for a full laboratory result. This message type should be used only when
specimen information can safely be ignored (measure of HgB via test kit with no actual specimen drawn rather a skin prick is used by the device).
If a lab result can only be safely and appropriately understood if that result contains full information (e.g. specimen), then the OUL message type
should be used and not this DEO – Donor Eligibility Observation message type.
TABLE 4-12 – DEO^O45 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
PATIENT - Donor Begin
Patient Identification – Donor
Identification
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
R
[1..1]
RE
[0..1]
R
[1..1]
5.8
RE
[0..100]
5.12
Donor Registration-level notes and comments
R
[1..100]
Observations Request
R
[1..1]
5.9
Each order group is a question & answer pair or mini-physical
assessment.
The question or mini-physical observation requests
Notes and Comments for OBR
RE
[0..100]
5.12
Any notes about the question or mini-physical observation requests
R
[1..1]
OBX
OBSERVATION Begin
Observations
R
[1..1]
5.10
The answer or mini-physical observation
[{NTE}]
Notes and Comments
RE
[0..100]
5.12
Notes or comments about the answer or mini-physical assessment
[
PID
[
PV1
[{NTE}]
]
]
Notes and Comments for Donor
Registration
VISIT Donor Registration End
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
The visit group may be empty in this message type.
PATIENT – Donor End
{
ORDER_OBSERVATION Begin
OBR
[{NTE}]
[{
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
The answer group or mini-physical assessment
Page 35
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-12 – DEO^O45 ABSTRACT MESSAGE SYNTAX
Segment
}]
}
Name
Usage
Cardinality
Section
Description
OBSERVATION End
ORDER_ OBSERVATION End
Page 36
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.10 DEL - DONOR ELIGIBILITY (EVENT O46)
Use this segment to communicate a donor’s eligibility to donate.
TABLE 4-13 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
[DON]
PATIENT – Donor End
Donation
RE
[0..1]
5.13
Donation procedure
[{NTE}]
Notes and Comments for Donation
RE
[0..100]
5.12
Donation procedure notes and comments
[
PID
[
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
VISIT Donor Registration End
]
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 37
© 2012 Health Level Seven International. All rights reserved.
4.11 DRC - DONOR REQUEST TO COLLECT (EVENT O47)
Used to communicate to a collection system that the donor is eligible and collection can begin.
TABLE 4-14 – DRC^O47 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Donor Registration
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
ORDER_OBSERVATION Begin
Observation Request
R
[1..1]
R
[1..1]
5.9
The request to collect
Notes and Comments for Request
RE
[0..100]
5.12
Any notes about the request to collect
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
{
OBR
[{NTE}]
}
Request to collect group
ORDER_OBSERVATION End
Page 38
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.12 DPR - DONATION PROCEDURE (EVENT O48)
This segment contains information from the blood unit collection procedure from the donor. The Donation Segment is repeating. If there is more than one stick,
there will be a separate DON segment for each stick.
TABLE 4-15 – DPR^O48 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
PID
PATIENT - Donor Begin
Patient Identification – Donor Identification
R
[1..1]
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
[{NTE}]
Notes and Comments for Donor Registration
RE
[0..100]
5.12
ORDER_OBSERVATION Begin
Observations Request
R
[1..100]
R
[1..1]
5.9
The request to collect
Notes and Comments for Request
RE
[0..100]
5.12
Any notes about the request to collect
RE
[0..10]
[
[
Name
]
VISIT Donor Registration End
]
PATIENT – Donor End
{
OBR
[{NTE}]
[{
Donation Begin
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
The visit group may be empty in this message type.
Donor Registration-level notes and comments
Request to collect group
One donation group per stick
[{DON}]
Donation
R
[1..1]
5.13
Donation procedure
[{OBX}]
Donation Observations and Adverse Events
RE
[0..100]
5.10
Donation observations
[{NTE}]
Notes and Comments for Donation
RE
[0..10]
5.12
Donation procedure notes and comments
[{
R
[1..10]
[{BUI}]
Blood Unit Begin
Blood Unit Information
R
[1..1]
5.14
Blood Unit Information
[{NTE}]
Notes and Comments for Blood Unit
RE
[0..100]
5.12
Blood Unit Information notes and comments
}]
Blood Unit End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Group must contain at least one blood unit segment
Page 39
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-15 – DPR^O48 ABSTRACT MESSAGE SYNTAX
Segment
}]
Name
Usage
Cardinality
Section
Description
Donation End
Page 40
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.13 ACK – ACKNOWLEDGEMENT
TABLE 4-16 – ACK^XXX^ACK ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
Usage
R
Cardinality
Section
Description
[1..1]
5.3
The Message Header (MSH) segment contains information
describing how to parse and process the message.
[0..0]
Not Supported
[{SFT}]
Software Segment
X
MSA
Message Acknowledgement
R
[1..1]
5.4
Message Acknowledgement
[{ ERR }]
Error
C
[0..100]
5.5
Required when MSA-1 is not "AA" or "CA."
Note: XXX above is replaced with the appropriate event code (O41, O42, etc.)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 41
© 2012 Health Level Seven International. All rights reserved.
5 SEGMENT AND FIELD DESCRIPTIONS
This messaging guide provides notes for supported fields. The following format is used in this document for listing and defining message
segments and fields. First, the message segment’s use is defined, and a segment attribute table listing all fields defined in the segment is shown.
5.1
SEGMENT ATTRIBUTE TABLE ABBREVIATIONS
The following sections detail the structure of each segment attribute, including field length, data type, usage, cardinality, value set and description.
The table below details the abbreviated terms used in the segment attribute tables, as well as the definitions associated with those abbreviations.
TABLE 5-1 – SEGMENT ATTRIBUTES
Seq
Abbreviation
Len
DT
Usage
Definition
Sequence of the elements as numbered in the HL7 segment.
Maximum length of the element. Lengths are provided only for atomic data types.
Lengths should be considered recommendations, not absolutes. The receiver can truncate fields, components, and sub-components that are longer
than the recommended length. The receiver should continue to process a message even when a field, component, or sub-component length exceeds
the maximum recommended length identified in this specification.
Data type used by this profile for HL7 element.
Usage of the field for this profile. Indicates if the field, component, or subcomponent is required, optional, or conditional in the corresponding
segment, field, or component. Legal values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• O – Optional. May optionally be populated.
• C – Conditional. Populated under specified conditions.
• CE – Conditional, but can be empty.
• X – Not used for this profile.
Note: A required field in an optional segment does not mean the segment must be present in the message. Rather, if the segment
is present, the required fields within that segment must be populated. This convention applies to required components of optional
fields. If the field is populated, then the required components must be populated. The convention applies to required subcomponents of optional components, as well. If a component is populated, then the required sub-components of that component
must be populated.
Page 42
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-1 – SEGMENT ATTRIBUTES
Abbreviation
Cardinality
Value Set
Note: Where a table constraint is indicated, or where HL7 Version 2.6 standards are adopted, the constrained or specified HL7
table is included below the segment table.
HL7 Element Name
Description/Comments
5.2
Definition
Indicator of the minimum and maximum number of times the element may appear.
• [0..0] Element never present.
• [0..1] Element may be omitted and it can have at most one occurrence.
• [1..1] Element must have exactly one occurrence.
• [0..n] Element may be omitted or may repeat up to n times.
• [1..n] Element must appear at least once, and may repeat up to n times.
• [0..*] Element may be omitted or repeat for an unlimited number of times.
• [1..*] Element must appear at least once, and may repeat unlimited number of times.
• [m..n] Element must appear at least m, and at most, n times.
The set of coded values to be used with the field.
HL7 descriptor of the element in the segment.
Context and usage for the element.
SEGMENT USAGE DEFINITIONS
TABLE 5 -2 – SEGMENT USAGE DEFINITIONS
R
Value
RE
Required
Description
Required but may be empty
Comment
A conforming sending application shall populate all “R” elements with a non-empty value. Conforming receiving
application shall process the information conveyed by required elements. A conforming receiving application must not
raise an error due to the presence of a required element, but must raise an error due to the absence of a required
element.
Any element designated as required in a standard HL7 message definition shall also be required in all HL7 message
profiles of that standard message.
The element 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" elements. If the conforming sending application
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 that element will be omitted.
Receiving applications will be expected to process (save/print/archive/etc.) data contained in the element, but must be
able to successfully process the message if the element is omitted (no error message should be generated because the
element is missing).
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 43
© 2012 Health Level Seven International. All rights reserved.
TABLE 5 -2 – SEGMENT USAGE DEFINITIONS
O
Optional
C
Conditional
X
Not supported
5.3
Sending applications may populate this field, but they are not required to do so per this specification. If the sending
application populates the field, the value must conform to all specifications for the field in the HL7 v2.6 standard.
Sending applications should not expect conformant receiving applications to process data sent in this field.
Receiving applications may process data received in this field, but they are not required to do so per this specification.
Receiving applications should not expect the field to be populated by conformant sending applications.
This usage has an associated condition predicate, which can be evaluated based on the values of other data elements in
the same message.
If the predicate is satisfied:
A conformant sending application must always send the element. A conformant receiving application must process or
ignore data in the element. It may raise an error if the element is not present.
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 condition
predicate is false and the element IS present.
For conformant sending applications, the element will not be sent. Conformant receiving applications may ignore the
element if it is sent, or may raise an application error.
MSH – MESSAGE HEADER SEGMENT
The Message Header Segment (MSH) contains information describing how to parse and process the message. This includes identification of
message delimiters, sender, receiver, message type, timestamp, etc.
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Usage
R
Cardinality
[1..1]
ST
R
[1..1]
3
HD
RE
[0..1]
4
HD
R
[1..1]
1
Seq
2
1
4
Len
DT
ST
Page 44
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Description/Comments
Field Separator
Character to be used as the field separator for the rest of the
message.
Literal value: ‘|’ [ASCII (124)].
Encoding Characters
Four characters, always appearing in the same order: |^~\&|.
Literal value: ‘^~\&’.
Sending Application
Field that may be used to identify the sending application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the sending application instance.
Sending Facility
Field that uniquely identifies the facility that sends the message. If
populated, it will contain an OID that represents the sending facility.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
5
Seq
Len
DT
HD
Usage
RE
Cardinality
[0..1]
6
HD
RE
[0..1]
7
DTM
R
[1..1]
8
9
10
ST
MSG
ST
X
R
R
[0..0]
[1..1]
[1..1]
11
PT
R
[1..1]
12
VID
R
[1..1]
13
14
15
NM
ST
ID
X
X
X
[0..0]
[0..0]
[0..0]
ID
CE
[0..1]
17
18
19
ID
ID
CWE
X
X
X
[0..0]
[0..0]
[0..0]
20
ID
X
[0..0]
16
25
2
Value Set
HL70155
HL7 Element Name
Description/Comments
Receiving Application
Field that may be used to identify the receiving application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the receiving application instance.
Receiving Facility
Field that uniquely identifies the facility that is to receive the
message. If populated, it will contain an OID that represents the
receiving facility.
Date/Time Of Message
Field containing the date/time the message was created by the
sending system. Format: YYYYMMDDHHMMSS[.S[S[S[S]]]]+/ZZZZ. Note that the time zone offset is required, and the minimum
granularity is to the second, although more precise time stamps are
allowed.
Security
Not supported
Message Type
See table for each message type.
Message Control ID
String that uniquely identifies the message instance from the
sending application.
Processing ID
Field that may be used to indicate the intent for processing the
message, such as "Testing," "Development," or "Production." For
this message, the field will be fixed to the value ”P”.
Version ID
HL7 version number used to interpret format and content of the
message. For this message, the version ID will always be 2.5.1
Sequence Number
Not supported
Continuation Pointer
Not supported
Accept Acknowledgment Not supported
Type
Application
Condition Rule: Shall be populated with a value from HL7 table
Acknowledgment Type
0155 for the Response message.
Country Code
Not supported
Character Set
Not supported
Principal Language Of
Not supported
Message
Alternate Character Set Not supported
Handling Scheme
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 45
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Seq
21
5.4
Len
DT
EI
Usage
R
Cardinality
[1..10]
Value Set
HL7 Element Name
Description/Comments
Message Profile Identifier Field used to reference or assert adherence to a message profile.
Message profiles contain detailed explanations of grammar, syntax,
and usage for a particular message or set of messages. This field is
allowed to repeat. The profile ID for the profile defined in this guide
should appear as a Repeat. Other profile IDs may appear in the
field, as well, in cases where more constrained profiles are created
from this profile. An OID for this profile is available once it is
assigned. The OID appearing as the literal value is an example OID
only.
Literal Value: USBBDon^^2.16.840.1.113883.19.9.7^ISO
MSA – ACKNOWLEDGEMENT SEGMENT
The Message Response Segment (MSA) contains the information sent as acknowledgment to the order message received by a Laboratory
Information System.
TABLE 5-4 – ACKNOWLEDGEMENT SEGMENT (MSA)
Usage
R
Cardinality
[1..1]
ST
R
[1..1]
3
4
ST
NM
X
X
[0..0]
[0..0]
5
ID
X
[0..0]
6
CWE
X
[0..0]
1
Seq
2
2
Len
25
DT
ID
Page 46
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL70008
HL7 Element Name
Description/Comments
Acknowledgment Code Acknowledgment code indicating receipt of message. (Refer to HL7
Table 0008 - Acknowledgment code for valid values.)
Message Control ID
Identifier that enables the sending system to associate this response
with the message for which it is intended. This value will be the
MSH.10 message control ID from the message being acknowledged.
Text Message
Not Supported
Expected Sequence
Not Supported
Number
Delayed
Not Supported
Acknowledgment Type
Error Condition
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.5
ERR – ERROR SEGMENT
The ERR segment is used to add error comments to acknowledgment messages.
TABLE 5-5 – ERROR SEGMENT (ERR)
1
2
3
4
Seq
Len
1
5
6
7
65536
8
9
10
11
12
DT
ELD
ERL
CWE
ID
Usage
X
X
R
R
Cardinality
[0..0]
[0..0]
[1..1]
[1..1]
CWE
ST
X
X
[0..0]
[0..0]
TX
R
[1..1]
TX
IS
CWE
CWE
XTN
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL70357
HL70516
HL7 Element Name
Error Code and Location
Error Location
HL7 Error Code
Severity
Application Error Code
Application Error
Parameter
Diagnostic Information
Not Supported
Not Supported
Identifies the HL7 (communications) error code.
Identifies the severity of an application error. Knowing if something is
Error, Warning or Information is intrinsic to how an application
handles the content.
Not Supported
Not Supported
Information that may be used by help desk or other support
personnel to diagnose a problem.
User Message
Not supported
Inform Person Indicator Not supported
Override Type
Not supported
Override Reason Code
Not supported
Help Desk Contact Point Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Page 47
© 2012 Health Level Seven International. All rights reserved.
5.6
PID – PATIENT IDENTIFICATION SEGMENT
The Patient Identification Segment (PID) is used to provide basic demographics regarding the donor. The subject must be a person (no animals).
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID – PID
2
3
CX
CX
X
R
[0..0]
[1..4]
Patient ID
Patient Identifier List
4
5
CX
XPN
X
R
[0..0]
[1..4]
Alternate Patient ID – PID
Patient Name – Donor Name
6
XPN
RE
[0..1]
Mother’s Maiden Name
Page 48
© 2012 Health Level Seven International. All rights reserved.
Description/Comments
For the first repeat of the PID segment, the sequence
number shall be one (1), for the second repeat, the
sequence number shall be two (2), etc.
Not supported
Field used to convey all types of patient/person
identifiers. This includes social security numbers,
driver’s license numbers, medical record numbers, etc.
The following donor identifiers are supported in this IG:
a. Donor #
b. National ID (SSN etc.)
c. Legacy ID # (Donor # from a previous blood bank
system)
d. Legacy ID # 2nd (Donor # from a previous blood
bank system)
Not supported
Donor name or aliases. When the name of the donor is
not known, a value must still be placed in this field since
the field is required. In that case, HL7 recommends the
following: |~^^^^^^U|. The "U" for the name type code
in the second name indicates that it is unspecified.
Since there may be no name components populated,
this means there is no legal name, nor is there an alias.
This guide will interpret this sequence to mean there is
no donor name.
The following donor names are supported in this IG:
Donor Name
Nickname
Maiden Name
Previous Name????
May be included for identification purposes. Name type
code is constrained to the value "M."
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
DT
TS
Usage
RE
Cardinality
[0..1]
Value Set
IS
XPN
CWE
RE
X
RE
[0..1]
[0..0]
[0..1]
HL70001
11
XAD
RE
[0..2]
Patient Address
12
13
IS
XTN
X
RE
[0..0]
[0..2]
County Code
Phone Number – Home
14
15
16
17
18
19
20
21
22
23
24
25
26
27
XTN
CWE
CWE
CWE
CX
ST
DLN
CX
CWE
ST
ID
NM
CWE
CWE
RE
X
X
X
X
X
X
X
RE
X
X
X
X
RE
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
Phone Number – Business
Primary Language
Marital Status
Religion
Patient Account Number
SSN Number – Patient
Driver’s License Number – Patient
Mother’s Identifier
Ethnic Group
Birth Place
Multiple Birth Indicator
Birth Order
Citizenship
Veterans Military Status
28
29
30
31
32
33
CWE
TS
ID
ID
IS
TS
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
7
Seq
8
9
10
Len
20
HL70005
HL70189
HL70172
HL7 Element Name
Date/Time of Birth
Administrative Sex
Patient Alias
Race
Nationality
Patient Death Date and Time
Patient Death Indicator
Identity Unknown Indicator
Identity Reliability Code
Last Update Date/Time
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Donor’s date of birth. The time component is not
supported in this IG.
Donor’s gender.
Not supported
One or more codes that broadly refer to the donor’s
race(s).
Donor’s addresses. This IG supports only two
addresses: home and work/business
Not supported
This IG supports only two ‘personal’ phone numbers;
Home and Mobile.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Field is meant for military status (active, retired, etc).
Empty field = non-military donor
“A”ctive only = military donor on active duty. Field
should either contain an “A” or be null.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 49
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
Seq
34
35
36
37
38
39
5.7
Len
DT
HD
CWE
CWE
ST
CWE
CWE
Usage
X
X
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL7 Element Name
Last Update Facility
Species Code
Breed Code
Strain
Species Code
Tribal Citizenship
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
PD1 – PATIENT ADDITIONAL DEMOGRAPHIC
This segment contains additional donor demographic information.
TABLE 5-7 – PATIENT ADDITIONAL DEMOGRAPHIC (PD1)
Seq
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Len
DT
IS
IS
XON
XCN
IS
IS
IS
IS
ID
CX
CWE
ID
Usage
X
X
RE
X
X
X
X
X
X
X
X
RE
Cardinality
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
DT
XON
CWE
IS
DT
DT
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Page 50
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL70136
HL7 Element Name
Living Dependency
Living Arrangement
Patient Primary Facility – Usual Collection Location
Patient Primary Care Provider Name & ID No.
Student Indicator
Handicap
Living Will Code
Organ Donor Code
Separate Bill
Duplicate Patient
Publicity Code
Protection Indicator – Notifiable Donor
Protection Indicator Effective Date
Place of Worship
Advance Directive Code
Immunization Registry Status
Immunization Registry Status Effective Date
Publicity Code Effective Date
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
“Y” Donor is notifiable
“N” Not notifiable
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-7 – PATIENT ADDITIONAL DEMOGRAPHIC (PD1)
Seq
19
20
21
22
Len
5.8
DT
IS
IS
IS
DT
Usage
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL7 Element Name
Military Branch
Military Rank/Grade
Military Status
Advance Directive Last Verified Date
Description/Comments
Not supported
Not supported
Not supported
Not supported
PV1 – PATIENT VISIT INFORMATION
This segment contains basic inpatient or outpatient encounter information.
TABLE 5-8 – PATIENT VISIT INFORMATION (PV1)
Seq
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Len
4
20
20
DT
SI
IS
PL
CWE
CX
PL
XCN
XCN
XCN
IS
PL
IS
IS
IS
IS
IS
XCN
IS
CX
FC
Usage
X
R
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
X
Cardinality
[0..0]
[1..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
Value Set
HL70004
HL7 Element Name
Set ID - PV1
Patient Class
Assigned Patient Location
Admission Type
Preadmit Number
Prior Patient Location
Attending Doctor
Referring Doctor
Consulting Doctor
Hospital Service
Temporary Location
Preadmit Test Indicator
Re-admission Indicator
Admit Source
Ambulatory Status
VIP Indicator
Admitting Doctor
Patient Type
Visit Number
Financial Class
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Not supported
Use a fixed value of “N” for “Not applicable”.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Number assigned for each donation ‘visit’ or registration.
Not supported
Page 51
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-8 – PATIENT VISIT INFORMATION (PV1)
Seq
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Len
DT
IS
IS
IS
IS
DT
NM
NM
IS
IS
DT
IS
NM
NM
IS
DT
IS
DLD
CWE
IS
IS
IS
PL
PL
DTM
TS
NM
NM
NM
NM
CX
IS
XCN
Usage
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
X
X
X
X
X
RE
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
Page 52
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Charge Price Indicator
Courtesy Code
Credit Rating
Contract Code
Contract Effective Date
Contract Amount
Contract Period
Interest Code
Transfer to Bad Debt Code
Transfer to Bad Debt Date
Bad Debt Agency Code
Bad Debt Transfer Amount
Bad Debt Recovery Amount
Delete Account Indicator
Delete Account Date
Discharge Disposition
Discharged to Location
Diet Type
Servicing Facility
Bed Status
Account Status
Pending Location
Prior Temporary Location
Admit Date/Time
Discharge Date/Time
Current Patient Balance
Total Charges
Total Adjustments
Total Payments
Alternate Visit ID – Drive ID
Visit Indicator
Other Healthcare Provider
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Date and time donor registered
Not supported
Not supported
Not supported
Not supported
Not supported
Donation Drive Identifier
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.9 OBR – OBSERVATION REQUEST SEGMENT
The Observation Request Segment (OBR) is used to capture information about:
1. The donation service requested to be performed
2. Questions in a questionnaire (the answers are in an associated OBX)
3. Assessments being performed for a mini-physical
the donation service to be performed, the questions .
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID - OBR
2
EI
RE
[0..1]
Placer Order Number
3
EI
R
[1..1]
Filler Order Number
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Sequence number of one of multiple OBRs under one
PID. For the first order transmitted, the Set ID shall be 1;
for the second OBR, this element is valued 2; and so on.
This identifier is assigned by the placer of the order. This
identifier distinguishes the placer’s order from all other
orders created by the placer where an order is
interpreted to be the testing identified in a single OBR
segment. Normally, it is a type of system identifier
assigned by the placer software application.
The Placer Order Number and the Filler Order Number
are essentially foreign keys exchanged between
applications for uniquely identifying orders and the
associated results across applications.
Order number associated with the Filling Application.
This number is assigned to the test by the organization
performing the test. The Filler Order Number identifies
this order as distinct from all other orders being
processed by this filler where an order is interpreted to
be the testing identified in a single OBR segment..
Normally, this is a type of system identifier assigned by
the filler software application.
The Filler Order Number, along with the Placer Order
Number, are essentially foreign keys exchanged between
applications for uniquely identifying orders and the
associated results across applications.
In messages containing multiple OBRs, each OBR must
be identified by a unique Filler Order Number.
Page 53
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
DT
CWE
Usage
R
Cardinality
[1..1]
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
ID
TS
TS
TS
CQ
XCN
ID
CWE
ST
TS
SPS
XCN
XTN
ST
ST
ST
ST
DTM
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
Priority – OBR
Requested Date/Time
Observation Date/Time
Observation End Date/Time
Collection Volume
Collector Identifier
Specimen Action Code
Danger Code
Relevant Clinical Information
Specimen Received Date/Time
Specimen Source
Ordering Provider
Order Callback Phone Number
Placer Field 1
Placer Field 2
Filler Field 1
Filler Field 2
Results Rpt/Status Chng - Date/Time
23
24
25
26
27
28
29
30
31
32
MOC
ID
ID
PRL
TQ
XCN
EIP
ID
CWE
NDL
X
X
X
X
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..*]
[0..0]
Charge to Practice
Diagnostic Serv Sect ID
Result Status
Parent Result
Quantity/Timing
Result Copies To
Parent
Transportation Mode
Reason for Study
Principal Result Interpreter
4
Seq
Len
Page 54
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Universal Service Identifier
Description/Comments
Identifier code for the requested observation/test/
battery/donation. This IG does not recommend a specific
coding system at this time.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
For requests or the sending of questionnaire questions,
this field is empty. For answers, mini-physical
observations and assessments, this field contains the
same information as OBX-14.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
DT
NDL
NDL
NDL
TS
NM
CWE
CWE
CWE
ID
ID
CWE
CWE
CWE
CWE
Usage
X
O
X
X
X
X
X
X
X
X
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
47
48
CWE
CWE
X
X
[0..0]
[0..0]
49
50
IS
CWE
X
X
[0..0]
[0..0]
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Seq
Len
Value Set
HL7 Element Name
Assistant Result Interpreter
Technician
Transcriptionist
Scheduled Date/Time
Number of Sample Containers
Transport Logistics of Collected Sample
Collector's Comment
Transport Arrangement Responsibility
Transport Arranged
Escort Required
Planned Patient Transport Comment
Procedure Code
Procedure Code Modifier
Placer Supplemental Service
Information
Filler Supplemental Service Information
Medically Necessary Duplicate
Procedure Reason
Result Handling
Parent Universal Service Identifier
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 55
© 2012 Health Level Seven International. All rights reserved.
5.10 OBX – OBSERVATION RESULT SEGMENT (QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for mini-physical
observations and assessments and questionnaire answers. For sending lab results using this segment, see Section 4.9 – DEO – Donor Eligibility
Observation message type for more information.
TABLE 5-10 –OBSERVATION/RESULT SEGMENT (OBX) - QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
HL7 Element Name
Set ID – OBX
2
3
3
ID
CWE
R
R
[1..1]
[1..1]
4
10
ST
C
[0..1]
Observation Sub-ID
5
Var
R
[1..1]
Observation Value
6
CWE
CE
[0..1]
Units
7
8
9
10
11
ST
IS
NM
ID
ID
X
X
X
X
R
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Page 56
© 2012 Health Level Seven International. All rights reserved.
HL70085
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR. Where possible
for lab results, the LOINC code system is recommended.
Required if there is more than one OBX with the same OBX-3
(Observation Identifier) associated with the same OBR.
Normally, this field is populated with a number, but text values
may also be used.
Field that documents each specific value (answer, assessment,
etc.)
Required if the results have units. UCUM® is an HL7-approved
code system, and shall be used for units as described in the
appropriate HITSP Interoperability Specification. If a numeric
value has no units of measure, the CWE data type allows an
"NA" (Not Applicable) from HL70353 as the Identifier
component.
Conditional statement: If the data type in OBX 2 is "NM" or "SN,"
this field is required.
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 –OBSERVATION/RESULT SEGMENT (OBX) - QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL
Seq
12
Len
DT
TS
Usage
X
Cardinality
[0..0]
13
14
ST
DTM
X
RE
[0..0]
[0..1]
15
16
CWE
XCN
X
RE
[0..0]
[0..1]
17
18
19
20
21
CWE
EI
TS
CWE
EI
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
22
23
CNE
XON
X
X
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Description/Comments
Effective Date of Reference
Not supported
Range
User-Defined Access Checks Not supported
Date/Time of the Observation Date and time of the observation (for one example, time the
question was answered)
Producer’s Reference
Not supported
Responsible Observer
For questions and answers, the staff person conducting the
interview. Use the value of “donor” to indicate that the donor
filled out the questionnaire without staff assistance.
Observation Method
Not supported
Equipment Instance Identifier Not supported
Date/Time of the Analysis
Not supported
Observation Site
Not supported
Observation Instance
Not supported
Identifier
Mood Code
Not supported
Performing Organization
Not supported
Name
Performing Organization
Not supported
Address
Performing Organization
Not supported
Medical Director
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 57
© 2012 Health Level Seven International. All rights reserved.
5.11 OBX – OBSERVATION RESULT SEGMENT (DONOR)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used to donor-level
observations.
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX) - DONOR
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
ID
CWE
R
R
[1..1]
[1..1]
HL70125
4
5
ST
Var
X
R
[0..0]
[1..1]
Observation Sub-ID
Observation Value
6
7
8
9
10
11
12
CWE
ST
IS
NM
ID
ID
TS
R
X
X
X
X
R
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
[0..0]
13
14
15
16
17
18
19
20
21
ST
DTM
CWE
XCN
CWE
EI
TS
CWE
EI
X
RE
X
RE
X
X
X
X
X
[0..0]
[0..1]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Units
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Effective Date of Reference
Range
User-Defined Access Checks
Date/Time of the Observation
Producer’s Reference
Responsible Observer
Observation Method
Equipment Instance Identifier
Date/Time of the Analysis
Observation Site
Observation Instance
Identifier
1
Seq
2
3
4
3
Len
Page 58
© 2012 Health Level Seven International. All rights reserved.
HL70085
HL7 Element Name
Set ID – OBX
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR.
Not supported
Field that documents each specific value (answer, assessment,
etc.)
Not supported
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
Not supported
Not supported
Date and time of the observation
Not supported
The staff person gathering the information from the donor.
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX) - DONOR
Seq
22
23
Len
DT
CNE
XON
Usage
X
X
Cardinality
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Mood Code
Performing Organization
Name
Performing Organization
Address
Performing Organization
Medical Director
Not supported
Not supported
Description/Comments
Not supported
Not supported
5.12 OBX - OBSERVATION IDENTIFIERS (DONOR)
The following observation identifiers are used in OBX-3 to communicate the type of donor observation associated with the donation procedure.
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
882-1
DEGRE
OCCUP
JTITL
EMPLY
EMPPH
NODO
FIRDO
NOLDO
AWARD
AWADE
YRDO
UPROC
DPROC
LASDD
LASDF
DMED
Description
Blood Type Indicator ABORH
Academic Degree
Occupation
Job Title
Employer
Employer's Phone #
# of Legacy Donations
First Donation Date
# of Lifetime Donations
Award Code
Award Description
Total Yearly Donations
Usual Procedure Type
Undesired Procedure Type
Last Donation Date
Last Donation Facility (Location)
Donor has recently taken a substance
OBX-2 DT
CNE
ST
ST
ST
ST
TN
NM
DT
NM
ST
ST
NM
CWE
CWE
DT
ST
ID
Comment
From LOINC (LN) Code System where possible.
Y/N
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 59
© 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
Description
(drug) on the list of products which
automatically cause a donation deferral.
OBX-2 DT
DMEDN
Medication which caused a donation
deferral
CWE
DMEDC
Condition for which the deferral
medication is being taken
CWE
DMEDO
DMEDD
OMED
Is Medication which caused a donation
deferral ongoing
Date of last dose of deferral medication
Is the donor taking any non-deferral
medications?
ID
DTM
ID
OMEDN
Any other medications (not on the
deferral list) which the donor is taking
CWE
OMEDC
Condition for which the other
medication is being taken
CWE
OMEDO
Is other medication ongoing
ID
Page 60
© 2012 Health Level Seven International. All rights reserved.
Comment
See document at link below for the list of medication which cause
a blood donation deferral:
http://www.aabb.org/resources/donation/questionnaires/Document
s/dhq/v1-3/MedicationDeferralListv1.3.pdf
http://www.fda.gov/downloads/BiologicsBloodVaccines/BloodBlood
Products/ApprovedProducts/LicensedProductsBLAs/BloodDonorS
creening/UCM213553.pdf
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded medications as
coding improves interoperability.
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded conditions as
coding improves interoperability.
Y/N
Y/N
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded medications as
coding improves interoperability.
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded conditions as
coding improves interoperability.
Y/N
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
OMEDD
Description
Date of last dose of other medication
OBX-2 DT
DTM
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 61
© 2012 Health Level Seven International. All rights reserved.
5.13 OBX – OBSERVATION RESULT SEGMENT (DONATION AND ADVERSE EVENTS)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for donation-level
observations, and donation procedure adverse events.
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
HL7 Element Name
Set ID – OBX
2
3
3
ID
CWE
R
R
[1..1]
[1..1]
4
10
ST
C
[0..1]
Observation Sub-ID
5
6
Var
CWE
R
CE
[0..1]
[0..1]
Observation Value
Units
7
8
9
10
11
12
ST
IS
NM
ID
ID
TS
X
X
X
X
R
X
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
[0..0]
13
ST
X
[0..0]
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Effective Date of Reference
Range
User-Defined Access Checks Not supported
Page 62
© 2012 Health Level Seven International. All rights reserved.
HL70085
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR.
Required if there is more than one OBX with the same OBX-3
(Observation Identifier) associated with the same OBR.
Normally, this field is populated with a number, but text values
may also be used. See section below regarding using OBX-4
for adverse reaction observations.
Field that documents each specific value
Required if the results have units. UCUM® is an HL7-approved
code system, and shall be used for units as described in the
appropriate HITSP Interoperability Specification. If a numeric
value has no units of measure, the CWE data type allows an
"NA" (Not Applicable) from HL70353 as the Identifier
component.
Conditional statement: If the data type in OBX 2 is "NM" or "SN,"
this field is required.
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX)
Seq
14
15
16
Len
DT
DTM
CWE
XCN
Usage
RE
X
RE
Cardinality
[0..1]
[0..0]
[0..1]
17
18
19
20
21
CWE
EI
TS
CWE
EI
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
22
23
CNE
XON
X
X
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Description/Comments
Date/Time of the Observation Date and time of the adverse event or deferral assessment.
Producer’s Reference
Not supported
Responsible Observer
For adverse events, the staff member observing the reaction or
problem. For deferral, the staff member making the final
assessment for deferral.
Observation Method
Not supported
Equipment Instance Identifier Not supported
Date/Time of the Analysis
Not supported
Observation Site
Not supported
Observation Instance
Not supported
Identifier
Mood Code
Not supported
Performing Organization
Not supported
Name
Performing Organization
Not supported
Address
Performing Organization
Not supported
Medical Director
5.14 OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
The following observation identifiers are used in OBX-3 to communicate the type of donation observation or adverse event observation associated
with the donation procedure.
OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
IMPLEMENTATION GUIDE TABLE DON0003 – DONATION OBSERVATION CODES
Value
ASOC
DEFF
DFBD
DFED
DFCD
Description
Association
Deferral
Deferral Begin Date
Deferral End Date
Deferral Cancel Date
OBX-2
DT
ST
ST
DT
DT
DT
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 63
© 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
IMPLEMENTATION GUIDE TABLE DON0003 – DONATION OBSERVATION CODES
Value
Description
OBX-2
DEFO
DEFC
Deferral Override
Deferral Code
DT
ST
ST
LOST
Loss Type
ST
LOSA
SDA
SERA
Loss Amount
Special Donation Attributes
Serological Attribute (Antigen Antibody)
NM
ST
ST
RCT
Reaction Type
ST
RCC
Reaction Category
ST
RSS
Reaction Signs and Symptoms
ST
Comment
Question (QTN)
Vital Code (VCD)
Test (TST)
Red Cell Actual (RCA)
Red Cell 12 (RC12)
Red Cell Predicted (RCP)
Plasma Actual (PLA)
Plasma 12 (PL12)
Plasma Predicted (PLP)
When the OBX is Loss amount, Loss units are populated in OBX-6
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
5.14.1 ADVERSE EVENTS
Adverse events are communicated using OBX segments immediately following the DON segment (representing/communicating the
donation procedure) during which the adverse event(s) occurred. The adverse event table has three-levels of hierarchy, Type (top-most),
Category (middle), and Signs and Symptoms (most detailed). Within each Type, there are one or more Categories, and within each
Category, there are one or more signs and symptoms. To communicate this, use a hierarchical OBX segments using the Sub-ID (OBX-4)
to indicate the hierarchy of each specific OBX-segment.
Page 64
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
The sub-id changes for each Reaction Type being communicated (so, 1, 2, etc.). For each category within a type, add a period ‘.’ and
another digit to represent the different categories (so 1.1, 1.2, etc.). For each category, communicate each sign/symptom by adding a
period and a last digit to the sub-id (so, 1.1.1, 1.1.2, etc.).
Example:
OBX||CE|RCT^Reaction Type^DON0003|1|Vasovagal^Vasovagal^UBNRCSS||||F
OBX||CE|RCC^Reaction Category^DON0003|1.1|LOC, any duration (uncomplicated)^LOC, any duration (uncomplicated)^UBNRCSS||||F
OBX||CE|RSS^Reaction Signs and Symptoms^DON0003|1.1.1|Pallor, pale skin or lips ^Pallor, pale skin or lips^UBNRCSS||||F
OBX||CE|RSS^Reaction Signs and Symptoms^DON0003|1.1.2|Rapid pulse^Rapid pulse^UBNRCSS||||F
5.15
AL1 – PATIENT ALLERGY INFORMATION SEGMENT
The AL1 segment contains patient allergy information of various types. Most of this information will be derived from user-defined tables. Each
AL1 segment describes a single patient allergy.
TABLE 5-11 – PATIENT ALLERGY INFORMATION SEGMENT (AL1)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID - AL1
2
3
705
CWE
CWE
X
R
[0..0]
[1..1]
Allergen Type Code
Allergen
Code/Mnemonic/Description
4
5
6
705
15
8
CWE
ST
DT
X
X
X
[0..0]
[0..0]
[0..0]
Allergy Severity Code
Allergy Reaction Code
Identification Date
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Sequence of AL1s should there be more than one of the
same type.
Not Supported
This IG does not recommend a specific coding system at this
time. It is expected many implementers will choose to only
populate the originalText component of the CWE data type;
however, the IG project team recommends moving towards
coded allergens as coding improves interoperability.
Not Supported
Not Supported
Not Supported
Page 65
© 2012 Health Level Seven International. All rights reserved.
5.16
NTE – NOTES AND COMMENTS SEGMENT
The NTE segment defined here is commonly used for sending notes and comments. Each NTE follows the segment to which that note or
comment pertains (see Message Types section above).
TABLE 5-12 – NOTES AND COMMENTS SEGMENT (NTE)
1
Seq
2
3
4
5
6
7
8
Len
4
65536
24
24
DT
SI
Usage
RE
Cardinality
[0..1]
ID
FT
CWE
XCN
DTM
DTM
DTM
X
R
X
X
RE
RE
X
[0..0]
[1..1]
[0..0]
[0..0]
[0..1]
[0..1]
[0..0]
Page 66
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Set ID - NTE
Source of Comment
Comment
Comment Type
Entered By
Entered Date/Time
Effective Start Date
Expiration Date
Description/Comments
Sequence of NTEs should there be more than one of the same
type.
Not Supported
Not Supported
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.17 DON - BLOOD BANK DONATION SEGMENT
The intent of this segment is to describe the actual donation procedure.
TABLE 5-13 – DONATION SEGMENT (DON)
DT
EI
CNE
Usage
C
C
Cardinality
[1..1]
[1..1]
3
4
5
6
7
8
9
10
DTM
DTM
NM
CNE
CNE
CNE
ID
CNE
RE
RE
RE
RE
RE
RE
R
C
[1..1]
[1..1]
[1..1]
[1..1]
[1..10]
[1..10]
[1..1]
[1..10]
11
12
13
14
15
16
17
18
19
20
21
22
23
24
DTM
CNE
CNE
CNE
ID
XCN
DTM
XON
DTM
XCN
CNE
CNE
XCN
XCN
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
[1..1]
[1..1]
[1..1]
[1..100]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
1
2
Seq
Len
Value Set
HL70559
HL70560
HL70560
HL70136
HL70560
HL70561
HL70562
HL70564
HL70136
HL70563
HL70565
HL7 Element Name
Donation Identification Number
Donation Type
Phlebotomy Start Date/Time
Phlebotomy End Date/Time
Donation Duration
Donation Duration Units
Intended Procedure Type
Actual Procedure Type
Donor Eligibility Flag
Donor Eligibility Procedure Type
Donor Eligibility Date
Process Interruption
Process Interruption Reason
Phlebotomy Issue
Intended Recipient Blood Relative
Intended Recipient Name and ID
Intended Recipient DOB
Intended Recipient Facility
Intended Recipient Procedure Date
Intended Recipient Ordering Provider
Phlebotomy Status
Arm Stick
Bleed Start Phlebotomist
Bleed End Phlebotomist
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
See component mapping table below
The accepted values for this element are the table column
headers in the table listed in the ISBT 128 Standard
Technical Specification Table 5, Data Structure 002.
The element is populated with the procedure type or types
for which a donor is eligible when the donor is found to be
eligible for donation.
Page 67
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-13 – DONATION SEGMENT (DON)
Seq
25
26
27
28
Len
75
25
DT
ST
ST
ID
XCN
Usage
RE
RE
RE
R
Cardinality
[1..1]
[1..1]
[1..1]
[1..1]
Value Set
29
30
31
32
DTM
NM
EI
XCN
R
RE
RE
R
[1..1]
[1..1]
[1..100]
[1..1]
33
XCN
RE
[1..1]
Donation Material Review Staff
34
XON
R
[1..1]
Collection Facility
HL70136
HL7 Element Name
Aphaeresis Type Machine
Aphaeresis Machine Serial Number
Donor Reaction
Final Review Staff ID
Final Review Date/Time
Number of Tubes Collected
Donation Sample Identifier
Donation Accept Staff
Description/Comments
This is the name of the person who reviews all the
documents to ensure that all processes have been
completed and all blanks are completed correctly
This is the person who ultimately accepted or deferred the
donor. This may be the same person as DON-28 or DON33, but also may be different in the case where the
accepting or deferring Staff is acting at the direction of the
person in DON -28 or DON-33.
This is a person who may be a point of escalation if the
interviewer is unsure of whether to accept or defer the
donor or if the answers to the questions require escalation
(i.e. to a Supervisor, Medical Director, etc.). This may be
the same person as DON-28, but may also be different.
DONATION IDENTIFIER (DON-1) COMPONENT MAPPING
Business Element
Donation Identification Number
(leave null)
Use FID (facility identifier) from ISBT.
ISBT or Codabar
Page 68
© 2012 Health Level Seven International. All rights reserved.
Component
Entity Identifier
Namespace ID
Universal ID
Universal ID Type
ST
IS
ST
ID
Data Type
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.18 BUI – BLOOD UNIT INFORMATION SEGMENT
The intent of this segment is to describe the information associated with a blood unit, one example of which is one or more blood unit(s) resulting
from a donation.
TABLE 5-14 – BLOOD UNIT SEGMENT (BUI)
DT
Usage
Cardinality
SI
O
[1..1]
Set ID – BUI
2
EI
R
[1..1]
Blood Unit Identifier
The definition will be or assigned to the particular blood unit(s)
resulting from a donation. The Blood Unit Identifier field consists of
three components: DIN, the labeling standard used to identify the
blood unit and if known, the specific product code for the blood unit
to further identify type of unit (s) collected. If the donation results in
two different unit types (as specified in BUI-3), the unit can be
uniquely identified by the combination of the Blood Unit Identifier
and the Blood Unit Type. If multiple bags of the same Blood Unit
Type are collected, the product code (either a standard product code
or a locally assigned product code) is used to uniquely identify each
unit.
3
CNE
R
[1..1]
Blood Unit Type
need specific instructions on collections vs. shipping
4
NM
R
[1..1]
5
CNE
R
[1..1]
6
NM
R
[1..1]
7
CNE
R
[1..1]
8
ST
O
[1..1]
9
ST
O
[1..1]
10
XON
RE
[1..1]
1
Seq
Len
Value Set
HL70566
HL7 Element Name
Blood Unit Weight
HL70567
Weight Units
Blood Unit Volume
HL70568
Volume Units
Container Catalog Number
NM
R
[1..1]
12
CNE
R
[1..1]
The Container Manufacturer should be the Manufacturer Identifier
Code specified in Table 18 (RT016) in the ISBT 128 Technical
Specification
Transport Temperature
HL70569
Transport Temperature Units
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Systems should use Manufacturer and Catalogue Number from the
ISBT-128 Manufacturers Data File to determine container type.
Container Lot Number
Container Manufacturer
11
Description/Comments
Page 69
© 2012 Health Level Seven International. All rights reserved.
5.19
RCP – RESPONSE CONTROL PARAMETER SEGMENT
The RCP segment is used to restrict the amount of data that should be returned in response to query.
TABLE 5-15 – RESPONSE CONTROL PARAMETERS SEGMENT (RCP)
Usage
Cardinality
ID
X
[0..0]
CQ
R
[1..1]
3
CNE
X
4
DTM
5
1
Seq
Len
DT
Value Set
HL7 Element Name
Description/Comments
Query Priority
Not Supported
Quantity Limited Request
Fixed to a value of “RD” for record.
[0..0]
Response Modality
Not Supported
X
[0..0]
ID
X
[0..0]
Execution and Delivery Time Not Supported
Not Supported
Modify Indicator
6
SRT
X
[0..0]
Sort-by Field
Not Supported
7
ID
X
[0..0]
Segment group inclusion
Not Supported
2
10
Page 70
© 2012 Health Level Seven International. All rights reserved.
HL70126
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.20
QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q33
The QPD segment defines the parameters of the query.
TABLE 5-16 – QBP^Q33 INPUT PARAMETERS
Name
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL Segment
Field
Search
0471
Name
1
MessageQueryName
60
CWE
R
N
N/A
2
QueryTag
32
ST
R
N
N/A
3
DonorLastName
S
Y
50
ST
RE
N
N/A
PID.5
4
DonorFirstName
S
Y
50
ST
RE
N
N/A
PID.5
5
DonorDOB
DTM
RE
N
N/A
PID.7
6
DonorSex
IS
RE
N
N/A
0001
Service
Identifier
PID.8
Code
Element
Name
PID-5 Patient
Name
PID-5 Patient
Name
PID-7
Date/Time of
Birth
PID-8 Sex
TABLE 5-17 – INPUT PARAMETER ATTRIBUTES
Abbreviation
Field Seq
Name
Definition
The ordinal number of the element being discussed. Sequence 1 is always Message Query
Name, and sequence 2 is always Query Tag. Sequence 3 and above are reserved for user
parameters.
The user-defined name for the element as will be used in the query. Example:
MedicationDispensed. When Name is derived from an actual HL7 element (segment and field),
the segment field name and element name appear in the columns headed by those names.
When Name is not derived from an actual HL7 element (segment and field), the source system
defines the values they expect in this field.
For Query Profiles published in the HL7 Standard, the Input Parameter Specification table
includes the Query Profile ID in parentheses in the upper left-hand cell. This allows the table to
be imported automatically into the HL7 database.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 71
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-17 – INPUT PARAMETER ATTRIBUTES
Abbreviation
Key/Search
Sort
Length
Type
Opt
Repeat
Match Operator
TBL
Segment Field Name
Service Identifier Code
Element Name
Definition
This field identifies which element is the key and which elements are searchable. The key field
is designated by a value of 'K'. A value of 'S' designates fields upon which an indexed search
can be performed by the source. 'L' designates non-indexed fields. (Note that searching on a
non-indexed field requires the Server to perform a linear scan of the data base.) If this column
is left blank, the field may not be searched.
Valued as "Y" if the output of the query can be sorted on this field. This column should only be
valued in Virtual Tables that are used as output specifications.
The maximum field length that will be transmitted by the source.
The data type of this user parameter. The values available for this field are described in
Chapter 2, section 2.16 of this standard. Data types QIP and QSC are available for transmitting
complex user parameters.
Defines whether the field is required ('R'), optional ('O'), conditionally required ('C'), or required
for backward compatibility ('B').
Valued as 'Y' if the field may repeat (i.e., be multiply valued).
The relational operator that will be applied against the value that the querying system specifies
for this field. Note: These are defined by HL7 Table 0209 – Relational Operator, a component of
the QSC data type
Identifies the HL7 table from which the values are derived.
Identifies the HL7 segment and field from which the new definition is derived. This field will be
blank if the Name is NOT derived from an actual HL7 segment and field.
A value of data type CWE that contains the applicable LOINC code, if it exists, or the applicable
HL7 code, if it exists, if no Segment Field Name has been identified. If a Segment Field Name
has been identified, this field is not populated.
The name of the element identified by Segment Field Name. This may also be a user-defined
'Z'-element.
Page 72
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.21
QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q34
The QPD segment defines the parameters of the query.
TABLE 5-16 – QBP^Q34 INPUT PARAMETERS
Name
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL
Search
1
MessageQueryName
60
CWE
R
N
N/A
2
QueryTag
32
ST
R
N
N/A
3
DonorIdentifier
20
ST
RE
N
N/A
5.22
0471
Segment
Field
Name
PID.3
Service
Identifier
Element Name
Code
PID-3 Patient
Identifier List
QAK – QUERY ACKNOWLEDGEMENT SEGMENT
The QAK segment contains information sent with responses to a query.
TABLE 5-17 – QUERY ACKNOWLEDGEMENT SEGMENT (QAK)
Seq
Len
1
DT
Usage
Cardinality
Value Set
HL7 Element Name
ST
X
[0..0]
Query Tag
Query Response Status
2
2
ID
RE
[0..1]
3
250
CWE
RE
[0..1]
4
10
NM
RE
[0..1]
Hit Count Total
5
10
NM
RE
[0..1]
This payload
6
10
NM
RE
[0..1]
Hits remaining
HL70471
Not Supported
Message Query Name
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Page 73
© 2012 Health Level Seven International. All rights reserved.
6 CODE SYSTEMS AND VALUE SETS
Successful message implementation requires that transmitted messages (message instances) contain valid values for coded fields. It is
important to note that code sets are relatively dynamic and subject to change between publications of these implementation guides.
Every code value passed in a message instance is drawn from a code system that has a globally unique identifier, such as an OID. In
general, the coded values allowed in a field (a) may be drawn from more than one code system, and (b) may be a subset of the codes
from a given coding system. Combining (a) and (b) makes it possible for the allowed code value to be a combination of multiple subsets
drawn from multiple coding systems. In most cases, only some of the codes defined in a code system are legal for use in a particular
message.
The subsets of the codes that are legal for a particular field are identified by an HL7 construct known as a Value Set. A value set is a
collection of coded values drawn from code systems. Value sets serve to identify the specific set of coded values for the message from
the universe of coded values across all coding systems. The actual content of any Value Set is subject to continual change, and the set of
Value Sets may also change to reflect current needs.
The segment tables in previous sections identify the Value Set or Coding System used for each supported field containing a coded value.
Fields that use the data type CNE or CWE require that messages include the code, (drawn from HL7 0396) that uniquely defines the
coding system, as well as the coded value itself. Some of these pre-coordinated value sets must be updated, or new ones created, as
new needs are identified.
Value Sets are identified by a unique identifier also, but this identifier is not transmitted in the message. The identifier or code for the
coding system from which the value is derived is sent in the message. However, the value set identifier is useful and important when
vocabulary items are modified or replaced.
Page 74
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.1
CODE TABLE ABBREVIATIONS
The following sections detail the structure of each code table, including field value, description, usage, and comments. The table below details the
abbreviated terms used in the code tables, as well as the definitions associated with those abbreviations.
TABLE 5-1 – SEGMENT ATTRIBUTES
Value
Len
Abbreviation
Usage
Definition
The actual code value to be send in conformant messages.
Description of the code.
Usage of the field for this profile. Indicates if the field, component, or subcomponent is required, optional, or conditional in the corresponding
segment, field, or component. Legal values are:
• R – Required. Must always be populated.
• O – Optional. May optionally be populated.
• X – Not used for this profile.
Note: Codes present in the HL7-defined tables may have been constrained for use in the Implementation Guide. In those cases
where the full list of codes from an HL7 table is not supported, those codes not supported are dropped from the list in this IG (as
opposed to marking them as “X”. As always, User-defined tables contain only relevant codes to be used for this IG.
Comment
Any comments specific to usage of the specific code.
6.2 USER-DEFINED TABLE HL70001 – ADMINISTRATIVE SEX
USER-DEFINED TABLE HL70001 – ADMINISTRATIVE SEX
Value
F
M
O
U
A
N
Description
Female
Male
Other
Unknown
Ambiguous
Not applicable
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Usage
R
R
R
R
R
R
Comment
Page 75
© 2012 Health Level Seven International. All rights reserved.
6.3 USER-DEFINED TABLE HL70003 – EVENT TYPE
USER-DEFINED TABLE HL70003 – EVENT TYPE
Value
K33
K34
O41
O42
O43
O44
O45
O46
O47
O48
Q33
Q34
Description
RSP – Donor Record Candidates
RSP – Donor Record
DBC – Donor Record Create
DBU – Donor Record Update
DRG – Donor Registration
DER – Donor Eligibility Request
DEO – Donor Eligibility Observations
DEL – Donor Eligibility
DRC – Donor Request to Collect
DPR – Donation Procedure
QBP – Donor Record Candidates
QBP – Donor Record
Usage
R
R
R
R
R
R
R
R
R
R
R
R
Comment
Usage
Comment
6.4 USER-DEFINED TABLE HL70005 – RACE
USER-DEFINED TABLE HL70005 – RACE
Value
1002-5
2028-9
2054-5
2076-8
2106-3
2131-1
Description
American Indian or Alaska Native
Asian
Black or African American
Native Hawaiian or Other Pacific Islander
White
Other Race
Page 76
© 2012 Health Level Seven International. All rights reserved.
R
R
R
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.5 HL7 TABLE HL70008 – ACKNOWLEDGEMENT CODE
HL7 TABLE HL70008 – ACKNOWLEDGEMENT CODE
Value
AA
AE
AR
Description
Original mode: Application Accept - Enhanced mode: Application acknowledgment: Accept
Original mode: Application Error - Enhanced mode: Application acknowledgment: Error
Original mode: Application Reject - Enhanced mode: Application acknowledgment: Reject
Usage
R
R
R
Comment
Usage
R
R
R
R
R
R
R
R
R
R
R
Comment
Usage
R
Comment
6.6 HL7 TABLE HL70076 – MESSAGE TYPE
HL7 TABLE HL70076 – MESSAGE TYPE
Value
ACK
QBP
RSP
DBC
DBU
DRG
DER
DEO
DEL
DRC
DPR
General acknowledgment message
Query by parameter
Segment pattern response
Donor Record Create
Donor Record Update
Donor Registration
Donor Eligibility Request
Donor Eligibility Observations
Donor Eligibility
Donor Request to Collect
Donation Procedure
Description
6.7 HL7 TABLE HL70103 – PROCESSING ID
HL7 TABLE HL70103 – PROCESSING ID
Value
D
Debugging
Description
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 77
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70103 – PROCESSING ID
Value
P
T
Description
Production
Training
Usage
R
R
Comment
6.8 HL7 TABLE HL70125 – VALUE TYPE
HL7 TABLE HL70125 – VALUE TYPE
Value
CE
Description
Coded Entry
Usage
R
CWE
Coded with Exceptions
R
DT
ED
Date
Encapsulated Data
R
R
FT
Formatted Text (Display)
R
NM
Numeric
R
RP
Reference Pointer
R
Page 78
© 2012 Health Level Seven International. All rights reserved.
Comment
Data type to be used where it is important to communicate the coding system
with the coded result being reported.
Data type to be used where it is important to communicate the coding system
and coding system version with the coded result being reported.. Pre-adopted
from Version 2.6
Field using the NM data type to carry a date value.
Field using the ED data type to allow communication of images, sound clips,
XML documents, html markup, etc.
Field using the FT data type to carry a text result value this is intended for
display. The text may contain formatting escape sequences as described in the
data types section. Numeric results and numeric results with units of measure
should not be reported as text. These should be reported as NM or SN numeric
results, with the units of measure in OBX-6.
Field using the NM data type to carry a numeric result value. The only nonnumeric characters allowed in this field are a leading plus (+) or minus (-) sign.
The structured numeric (SN) data type should be used for conveying inequalities,
ranges, ratios, etc. The units for the numeric value should be reported in OBX-6.
Field using the RP data type to allow communication of pointers to images,
sound clips, XML documents, html markup, etc. The RP data type is used when
the object being pointed to is too large to transmit directly.
This specification defines the mechanism for exchanging pointers to objects, but
it does not address the details of applications actually accessing and retrieving
the objects over a network.
The most common scheme for passing a pointer is to use a Universal Resource
Identifier (see http://ietf.org/rfc/rfc2396.txt for detailed definition). The general
format of a URI is in the form: <scheme>://<authority><path>?<query>. The
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
HL7 TABLE HL70125 – VALUE TYPE
Value
Description
Usage
SN
Structured Numeric
R
ST
String Data
R
TN
TS
TX
Telephone Number
Time Stamp (Date & Time)
Text Data (Display)
R
R
R
Comment
scheme and authority portions appear in the Application ID component, Universal
ID subcomponent. The path and query portion of the URI appear in the Pointer
component of the RP data type.
Field using the SN data type to carry a structured numeric result value.
Structured numeric include intervals (^0^-^1), ratios (^1^/^2 or ^1^:^2),
inequalities (<^10), or categorical results (2^+). The units for the structured
numeric value should be reported in OBX-6.
Field using the ST data type to carry a short text result value. Numeric results
and numeric results with units of measure should not be reported as text. These
should be reported as NM or SN numeric results, with the units of measure in
OBX-6.
Field using the TN date type to carry a phone number.
Field using the TX data type to carry a text result value this is intended for
display. Numeric results and numeric results with units of measure should not be
reported as text. These should be reported as NM or SN numeric results, with
the units of measure in OBX-6.
6.9 HL7 TABLE HL70136 - YES/NO INDICATOR
HL7 TABLE HL70136 – YES/NO INDICATOR
Y
N
Value
Yes
No
Description
Usage
R
R
Comment
6.10 HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
Value
AL
NE
ER
Description
Always
Never
Error/reject conditions only
Usage
R
O
O
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 79
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
Value
SU
Description
Successful completion only
Usage
O
Comment
6.11 USER-DEFINED TABLE HL70189 – ETHNIC GROUP
USER-DEFINED TABLE HL70189 - ETHNIC GROUP
H
N
U
Value
Description
Hispanic or Latino
Not Hispanic or Latino
Unknown
Usage
R
R
R
Comment
6.12 USER-DEFINED TABLE HL70190 - ADDRESS TYPE
USER-DEFINED TABLE HL70190 - ADDRESS TYPE
H
Value
O
Home
Description
Office/Business
Usage
R
R
Comment
Refers to a residence or domicile, literally the place where the subject
resides the majority of the time. Generally speaking most people will
have a home address and it will represent their primary address. Home
address is mutually exclusive of permanent address.
Refers to a work address specific to the subject.
6.13 HL7 TABLE HL70191 – TYPE OF REFERENCED DATA
HL7 TABLE HL70191 – TYPE OF REFERENCED DATA
Value
AP
AU
IM
multipart
TEXT
Description
Other application data, typically uninterpreted binary data (HL7 V2.3 and later)
Audio data (HL7 V2.3 and later)
Image data (HL7 V2.3 and later)
MIME multipart package
Machine readable text document (HL7 V2.3.1 and later)
Page 80
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.14 HL7 TABLE HL70200 - NAME TYPE
HL7 TABLE HL70200 - NAME TYPE
B
L
M
N
Value
Description
Name at Birth
Legal Name
Maiden Name
Nickname /”Call me” Name/Street Name
Usage
R
R
R
R
For Previous Name
For Donor Name
For Maiden Name
For Nickname
Comment
6.15 HL7 TABLE HL70201 - TELECOMMUNICATION USE CODE
TABLE 5-3 – HL7 TABLE HL70201 - TELECOMMUNICATION USE CODE
Value
PRN
WPN
PRS
Description
Primary Residence Number
Work Number
Personal
Usage
R
R
R
Comment
Used for home phone
Used for work phone
Not tied to a location or role – Used for mobile or cellular
phone
6.16 HL7 TABLE HL70202 - TELECOMMUNICATION EQUIPMENT TYPE CODE
HL7 TABLE HL70202 - TELECOMMUNICATION EQUIPMENT TYPE CODE
Value
PH
CP
Description
Telephone
Cellular or Mobile Phone
Usage
R
R
Comment
Used for home phone and work phone
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 81
© 2012 Health Level Seven International. All rights reserved.
6.17 HL7 TABLE HL70203 – IDENTIFIER TYPE
HL7 TABLE HL70203 – IDENTIFIER TYPE
Value
BCT
Description
Birth Certificate
CZ
Citizenship Card
R
DL
DR
HC
MI
Driver’s license number
Donor Registration Number
Health Card Number
Military ID number
R
R
R
R
MR
Medical record number
R
NI
National unique individual identifier
R
NNxxx
R
PI
National Person Identifier where the xxx is the
ISO table 3166 3-character (alphabetic) country
code
Patient internal identifier
PN
Person number
R
PPN
Passport number
R
SS
Social Security number
O
Page 82
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
Comment
A number associated with a document identifying the event of
a person’s birth.
A number assigned by a person’s country of residence to
identify a person’s citizenship.
A number assigned to an individual who has had military duty,
but is not currently on active duty. The number is assigned by
the DOD or Veterans’ Affairs (VA).
An identifier that is unique to a patient within a set of medical
records, not necessarily unique within an application.
Class: Insurance
In the US, the Assigning Authority for this value is typically
CMS, but it may be used by all providers and insurance
companies in HIPAA related transactions.
A number that is unique to a patient within an Assigning
Authority.
A number that is unique to a living subject within an Assigning
Authority.
A unique number assigned to the document affirming that a
person is a citizen of the country. In the US this number is
issued only by the State Department.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.18 EXTERNAL TABLE HL70291 – SUB TYPE OF REFERENCED DATA
EXTERNAL TABLE HL70291 - SUB TYPE OF REFERENCED DATA
Value
Description
Usage
R
Comment
Table 0291 comprises the values of MIME media subtypes established
in accordance with RFC 2046 (http://ietf.org/rfc/rfc2046.txt) and
registered with the Internet Assigned Numbers Authority
(http://www.iana.org/numbers.html). Note that the MIME media subtype
values are case-insensitive, in accordance with RFC 2045.
6.19 HL7 TABLE HL70299 – ENCODING
HL7 TABLE HL70299 - ENCODING
A
Value
Hex
Base64
Description
No encoding - data are displayable ASCII
characters.
Hexadecimal encoding - consecutive pairs of
hexadecimal digits represent consecutive single
octets.
Encoding as defined by MIME (Multipurpose Internet
Mail Extensions) standard RFC 1521. Four
consecutive ASCII characters represent three
consecutive octets of binary data. Base64 utilizes a
65-character subset of US-ASCII, consisting of both
the upper and lower case alphabetic characters,
digits "0" through “9”, “+", “/", and “=”.
Usage
R
Comment
R
R
The Request For Comment (RFC) 1521 standard is
available at: http://www.ietf.org/rfc/rfc1521.txt
6.20 USER-DEFINED TABLE HL70300 – NAMESPACE ID
USER-DEFINED TABLE HL70300 – NAMESPACE ID
Value
Description
No suggested values
Usage
Comment
These values are local to each implementation
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 83
© 2012 Health Level Seven International. All rights reserved.
6.21 USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
C
D
H
N
O
P
S
Value
Description
Clinic
Department
Home
Nursing Unit
Provider’s Office
Phone
SNF
Usage
R
R
R
R
R
R
R
Comment
6.22 HL7 TABLE HL70354 – MESSAGE STRUCTURE
HL7 TABLE HL70354 – MESSAGE STRUCTURE
Value
ACK
RSP_K33
RSP_K34
DBC_O41
DBU_O42
DRG_O43
DER_O44
DEO_O45
DEL_O46
DRC_O47
DPR_O48
QBP_Q33
QBP_Q34
Varies
K33
K34
O41
O42
O43
O44
O45
O46
O47
O48
Q33
Q34
Event
Page 84
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
R
R
R
R
R
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.23 HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
0
Value
Description
Message accepted
Usage
R
100
Segment sequence error
R
101
102
Required field missing
Data type error
R
R
103
Table value not found
R
200
201
202
203
204
Unsupported message type
Unsupported event code
Unsupported processing id
Unsupported version id
Unknown key identifier
R
R
R
R
R
205
Duplicate key identifier
R
206
Application record locked
R
207
Application internal error
R
Comment
Success. Optional, as the AA conveys success. Used for systems that
must always return a status code.
Error: The message segments were not in the proper order, or required
segments are missing.
Error: A required field is missing from a segment
Error: The field contained data of the wrong data type, e.g., an NM field
contained "FOO".
Error: A field of data type ID or IS was compared against the
corresponding table, and no match was found.
Rejection: The Message Type is not supported.
Rejection: The Event Code is not supported.
Rejection: The Processing ID is not supported.
Rejection: The Version ID is not supported.
Rejection: The ID of the patient, order, etc., was not found. Used for
transactions other than additions, e.g., transfer of a non-existent patient.
Rejection: The ID of the patient, order, etc., already exists. Used in
response to addition transactions (Admit, New Order, etc.).
Rejection: The transaction could not be performed at the application
storage level, e.g., database locked.
Rejection: A catchall for internal errors not explicitly covered by other
codes.
6.24 HL7 TABLE HL70396 – CODING SYSTEM
HL7 TABLE HL70396 – CODING SYSTEM
Value
Description
Usage
Comment
99zzz or L
Local general code (where z is an
alphanumeric character)
Locally defined codes for purpose of sender or receiver. Local codes
can be identified by L (for backward compatibility) or 99zzz (where z is
an alphanumeric character).
UBNRCSS
UBNRCSS
US Biobvigilance Network Reaction Categories Signs and Symptoms
IBTnnnn
ISBT 128 codes where nnnn specifies
International Society of Blood Transfusion. (specific contact information
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 85
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70396 – CODING SYSTEM
Value
Description
a specific table within ISBT 128.
Usage
will be supplied to editor.)
Comment
The variable suffix (nnnn) identifies a specific table within ISBT 128.
UCUM
UCUM code set for units of
measure(from Regenstrief)
6.25 USER-DEFINED TABLE HL70471 – QUERY NAME
USER-DEFINED TABLE HL70471 – QUERY NAME
Value
GetDonorRecordCandidates
GetDonorRecord
Description
Query to retrieve Donor Record Candidates
Query to retrieve a Donor Record
Usage
R
R
Comment
6.26 HL7 TABLE HL70516 – ERROR SEVERITY
HL7 TABLE HL70516 – ERROR SEVERITY
W
I
E
F
Value
Warning
Information
Error
Fatal Error
Description
Usage
R
R
R
R
Comment
Transaction successful, but there may issues
Transaction was successful but includes information e.g., inform patient
Transaction was unsuccessful
Message not processed due to application or network failure condition
6.27 USER-DEFINED TABLE HL70559 – DURATION UNITS
USER-DEFINED TABLE HL70559 – DURATION UNITS
Value
min
S
Minutes
Seconds
Description
Page 86
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.28 USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
Value
WBL
2RC
PLS
PLT
PNP
PNR
PPR
GRN
HEM
Description
Whole Blood
Double Red Cells
Plasma
Platelets
Platelets and Plasma
Platelets and Red Cells
Platelets, Plasma, and Red Cells
Granulocytes
Hemachromatosis
HPC
LYM
THA
THW
Hematopoietic Progenitor Cells
Lymphocytes
Therapeutic Apheresis
Therapeutic Whole Blood
Usage
R
R
R
R
R
R
R
R
R
R
R
R
R
Comment
To be used as whole blood for transfusion; may not be counted as red
blood cell loss; Donor may be considered a patient.
Stem Cells and other cells classified as Hematopoietic
6.29 USER-DEFINED TABLE HL70561 – PROCESS INTERRUPTION
USER-DEFINED TABLE HL70561 – PROCESS INTERRUPTION
Value
NIN
WOT
ABR
Description
Process was not interrupted
Walk Out: Process interrupted before the Phlebotomist
inserts the needle in the Donor’s arm
Aborted Run: Process interrupted after the Phlebotomist
inserts the needle in the Donor’s arm
Usage
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 87
© 2012 Health Level Seven International. All rights reserved.
6.30 USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
Value
NRG
PCD
DCW
CFT
DBB
DNI
ASC
BSC
GFE
Description
No reason given, donor decided to stop
without giving a reason
Phone Call-Donor
Couldn’t wait
Couldn’t follow through with donation
(scared)
Bathroom
Phlebotomy Issue
Apheresis Software Crash
Manufacturing Software Crash
General Facility Emergency
Usage
R
Comment
R
R
R
R
R
R
R
R
Power outage, natural disaster (tornado, flood, hurricane, etc.), air
conditioning failure, etc.
6.31 USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
Value
INF
VSM
COL
MIS
NAD
PFL
CLT
DND
DBG
DAK
DMT
Description
Infiltration
Vein Spasm
Collapse
Missed / in tissue
Needle adjustment (this may not end a
procedure, if successful will impact
component production)
Poor flow
Clotted
Defective Needle
Defective Bag
Defective Apheresis Kit
Defective Instrument
Page 88
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
Comment
R
R
R
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
Value
IPF
ACN
Description
Instrument Power Failure
Air Contamination
Usage
R
R
Comment
6.32 USER-DEFINED TABLE HL70563 – PHLEBOTOMY STATUS
USER-DEFINED TABLE HL70563 – PHLEBOTOMY STATUS
Value
SUC
NDR
Description
Successful
Not Drawn
UL5
Unsuccessful Less than 50 ml drawn
Usage
R
R
R
Comment
Successful means a complete component was drawn
There may be two reasons for this to occur
Phlebotomy performed, no blood obtained
Phlebotomy not performed due to other circumstances
Phlebotomy was performed, some blood was drawn, less than 50 ml
was drawn
6.33 USER-DEFINED TABLE HL70565 – ARM STUCK
USER-DEFINED TABLE HL70565 – ARM STUCK
L
R
B
Value
Left Arm
Right Arm
Both Arms
Description
Usage
R
R
R
Comment
6.34 USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
Value
WBL
RBC
Description
Whole Blood
Red Blood Cells
Usage
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 89
© 2012 Health Level Seven International. All rights reserved.
USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
Value
PLS
PLT
GRN
PSC
LYM
Description
Plasma
Platelets
Granulocytes
Peripheral Stem Cells
Lymphocytes
Usage
R
R
R
R
R
Comment
6.35 USER-DEFINED TABLE HL70567 – WEIGHT UNITS
USER-DEFINED TABLE HL70567 – WEIGHT UNITS
Value
[lb_av]
[oz_av]
Kg
G
Pound
Ounce
Kilogram
Gram
Description
Usage
R
R
R
R
Comment
6.36 USER-DEFINED TABLE HL70568 – VOLUME UNITS
USER-DEFINED TABLE HL70568 – VOLUME UNITS
Value
L
[pt_us]
Ml
Liter
Pint
Milliliters
Description
Page 90
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.37 USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
Value
degF
Cel
Description
Degrees Fahrenheit
Degrees Celsius
Usage
R
R
Comment
6.38 HL7 TABLE HL70834 – MIME TYPE
HL7 TABLE HL70834 – MIME TYPE
Value
application
audio
image
model
text
video
multipart
Description
Application data
Audio data
Image data
Model data
Text data
Video data
MIME multipart package
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Usage
O
R
R
O
R
R
O
Comments
Page 91
© 2012 Health Level Seven International. All rights reserved.
7 DATA TYPES
This chapter defines the data types used in this Implementation Guide. They are listed alphabetically and contain all elements that define each
type. The usage column of the component table has been updated to reflect the standard constrained usage of each data type referred to in this
Implementation Guide. Exceptional usage patterns are noted in this section and specific exceptional component usage constraints are
documented with the element definition.
7.1 DATA TYPES SUMMARY
TABLE 7-1 – DATA TYPES
Data type
Data Type Name
CNE
Coded with No Exceptions
CNN
Composite ID Number and Name Simplified
CQ
Composite Quantity with Units
CWE
Coded with Exceptions
CX
Extended Composite ID with Check Digit
DTM
Date/Time
ED
Encapsulated Data
EI
Entity Identifier
FN
Family Name
FT
Formatted Text Data
HD
Hierarchic Designator
ID
Coded Values for HL7 Tables
IS
Coded value for User-Defined Tables
MSG
Message Type
NM
Numeric
PT
Processing Type
RP
Reference Pointer
SAD
Street Address
SI
Sequence ID
Page 92
© 2012 Health Level Seven International. All rights reserved.
Length
24
65536
20
16
4
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 7-1 – DATA TYPES
Data type
Data Type Name
SN
Structured Numeric
ST
String
TX
Text Data
VID
Version Identifier
XAD
Extended Address
XCN
Extended Composite ID Number and Name
XON
Extended Composite Name and ID Number
for Organizations
XPN
Extended Person Name
XTN
Extended Telecommunication Number
Length
999
65536
7.2 DATA TYPE TABLE ABBREVIATIONS
The following sections detail the structure of each data type, including segment name, usage, value set, and description. The table below details
the abbreviated terms used in the data type tables, as well as the definitions associated with those abbreviations.
TABLE 7-2 – DATA TYPE ATTRIBUTES
Seq
Len
DT
Abbreviation
Definition
Sequence of the elements as numbered in the HL7 segment.
• Maximum length of the element. Lengths are only provided for atomic data types.
Lengths should be considered recommendations, not absolutes. The receiver can truncate
fields, components and sub-components that are longer than the recommended length. The
receiver should continue to process a message even when a field, component, or subcomponent length exceeds the maximum recommended length identified in this specification.
Data type used by this profile for HL7 element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 93
© 2012 Health Level Seven International. All rights reserved.
TABLE 7-2 – DATA TYPE ATTRIBUTES
Abbreviation
Usage
Definition
Usage of the field for this profile. Indicates whether the field, component, or subcomponent is
required, optional, or conditional in the corresponding segment, field, or component. Legal
values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• O – Optional. May optionally be populated.
• CE – Conditional. Populated under specified conditions.
• C – Conditional, but may be empty.
• X – Not used for this profile.
The set of coded values to be used with the field.
Value Set
Component Name
Description/Comments
Note: Where a table constraint is indicated, or where HL7 Version 2.8
standards are pre-adopted, the constrained or specified HL7 table is included
below the data type table.
HL7 descriptor of the element in the data type.
Context and usage for the element.
Note: In the tables throughout this document, Yellow = This Interoperability Specification does not support the use of this item.
Page 94
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.3 CNE – CODED NO EXCEPTIONS
TABLE 2-6 – CODED NO EXCEPTIONS (CNE)
SEQ
1
2
LEN
30
200
DT
ST
ST
Usage
RE
RE
Value Set
3
20
ID
CE
HL70396
4
5
6
ST
ST
ID
X
X
X
7
8
ST
ST
X
X
9
ST
X
Component Name
Identifier
Text
Name of Coding System
Alternate Identifier
Alternate Text
Name of Alternate Coding
System
Coding System Version ID
Alternate Coding System
Version ID
Original Text
Comments
It is strongly recommended that text be sent to
accompany any identifier. When a coded value is not
known, the orginal text attribute is used to carry the
text, not the text component.
Condition rule: Required if an identifier is provided in
component 1.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: Specifies a coded element and its associated detail. The CNE data type is used when a required or mandatory coded
field is needed. The specified HL7 table or imported or externally defined coding system must be used and may not be extended
with local values. Text may not replace the code. A CNE field must have an HL7 defined or external table associated with it. A
CNE field may be context sensitive such that a choice of explicit coding systems might be designated. This allows for realm and
other types of specificity. Every effort will be made to enumerate the valid coding system(s) to be specified in the 3rd component,
however, the standards body realizes that this is impossible to fully enumerate.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 95
© 2012 Health Level Seven International. All rights reserved.
7.4 CNN – COMPOSITE ID NUMBER AND NAME SIMPLIFIED
TABLE 2-35 – COMPOSITE ID NUMBER AND NAME SIMPLIFIED (CNN)
SEQ
LEN
1
20
ST
RE
50
50
FN
ST
ST
RE
RE
RE
ST
ST
IS
IS
HD
RE
RE
X
X
CE
2
3
4
5
6
7
8
9
10
10
DT
Usage
Value
Set
Component Name
ID Number
Family Name
Given Name
Second and Further Given Names
or Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Source Table
Assigning Authority
Comments
If this is a person, the ID must be accompanied by
an OID for the assigning authority (component 9).
If this is an organization, the OID for the
organization should be provided here.
Not Supported
Not Supported
Condition rule: Required if component 1 (ID
Number) is populated.
Definition: Specifies a person using both an identifier and the person’s name.
Page 96
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.5 CQ – COMPOSITE QUANTITY WITH UNITS
TABLE 2-5 – COMPOSITE QUANTITY WITH UNITS (CQ)
SEQ
1
2
LEN
DT
16
Usage
Value
R
RE
UCUM
NM
CWE
Set
Comments
Component
Name
Quantity
Units
Units of measure must be drawn from the UCUM coding
system.
Definition: Specifies a quantity include units.
7.6 CWE – CODED WITH EXCEPTIONS
TABLE 2-6 – CODED WITH EXCEPTIONS (CWE)
SEQ
LEN
1
2
30
200
ST
ST
RE
RE
3
20
ID
CE
4
5
6
ST
ST
ID
X
X
X
7
ST
X
8
ST
X
ST
RE
9
200
DT
Usage
Value Set
HL70396
Comments
Component
Name
Identifier
Text
Name of Coding
System
Alternate Identifier
Alternate Text
Name of Alternate
Coding System
Coding System
Version ID
Alternate Coding
System Version ID
Original Text
It is strongly recommended that text be sent to accompany any
identifier. When a coded value is not known, the orginal text
attribute is used to carry the text, not the text component.
Condition rule: Required if an identifier is provided in component
1.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Original Text is used to convey either the text which was the
basis for coding, or when there is no code to be sent, only free
text.
Definition: The CWE data type is used where it is necessary to communicate a code, text, coding system and the version of
coding system the code was drawn from. It also allows the communication of an alternate code drawn from another coding
system. Many coded fields in this specification identify coding systems or value sets that must be used for the field. When
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 97
© 2012 Health Level Seven International. All rights reserved.
populating the CWE data types with these values, this guide does not give preference to the triplet in which the standard code
should appear. The receiver is expected to examine the coding system names in components 3 and 6 to determine if it recognizes
the coding system.
The CWE data type allows communication of an early form of what has come to be called "null flavors." HL7 2.6 refers to these
as CWE Statuses, where the values are drawn from HL7 table 0353. Support for the CWE Statuses are optional.
This guide conforms to the HL7 Version 2.6 convention of using the CWE data type in place of the CE to allow transmission of
version information.
7.7 CX – EXTENDED COMPOSITE ID WITH CHECK DIGIT
TABLE 2-7 – EXTENDED COMPOSITE ID WITH CHECK DIGIT (CX)
SEQ
LEN
1
30
2
3
4
5
6
7
8
9
10
5
DT
Usage
ST
R
ST
ID
HD
ID
HD
DT
DT
CWE
CWE
X
X
R
R
X
X
X
X
X
Value Set
HL70203
Comments
Component
Name
ID Number
Check Digit
Check Digit Scheme
Assigning Authority
Identifier Type Code
Assigning Facility
Effective Date
Expiration Date
Assigning Jurisdiction
Assigning Agency or
Department
The ID Number component combined with the Assigning
Authority component must uniquely identify the associated
object, i.e., whatever object with which the field is
associated.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: The CX data type is used to carry identifiers. This guide requires that all identifiers be accompanied by assigning
authorities, and that all identifiers carry an identifier type. This method allows the exchange of unique identifiers for the associated
object across organizational and enterprise boundaries, enabling broad interoperability.
Although the Identifier Type Code component is required, it is not a part of the actual identifier. Rather, it is metadata about the
identifier. The ID Number and Assigning Authority component, together, constitute the actual identifier.
Page 98
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.8 DTM – DATE/TIME
TABLE 2-10 – DATE/TIME (DTM)
SEQ
LEN
1
24
DT
Usage
Value Set
R
Comments
Component
Name
Date/Time
Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]
Definition: Specifies a point in time using a 24-hour clock notation.
Usage: It is strongly recommended that the time zone offset always be included in the DTM.
7.9 ED – ENCAPSULATED DATA
TABLE 2-11 – ENCAPSULATED DATA (ED)
SEQ
LEN
1
DT
Usage
HD
RE
Value Set
Component
Name
Source Application
2
9
ID
R
HL70191
Type of Data
3
18
ID
RE
HL70291
Data Subtype
4
6
ID
R
HL70299
Encoding
5
65536
TX
R
Data
Comments
Identifier of the application that is the
source of the encapsulated data.
Identifier of the type of data found in
component 5.
Identifier of the subtype of data found in
component 5
Identifier of the type of encoding to be
performed in the data component
The data in this component must be
properly escaped after encoding.
Receivers will need to de-escape the
text prior to de-encoding.
Definition: This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the
source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference
pointer) data type except that instead of pointing to the data on another system, it contains the data which is to be sent to that
system.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 99
© 2012 Health Level Seven International. All rights reserved.
7.10 EI – ENTITY IDENTIFIER
TABLE 2-12 – ENTITY IDENTIFIER (EI)
SEQ
LEN
DT
Usage
1
30
ST
R
2
20
IS
R
3
999
ST
X
4
6
ID
X
Value
Set
HL70300
HL70301
Component Name
Comments
Entity Identifier
Namespace ID
Universal ID
An identifier which represents each
local, implemented system/application
which can assign identifiers.
Not Supported
Universal ID Type
Not Supported
Definition: The entity identifier defines a given entity within a specified series of identifiers.
Usage: The EI data type is used to carry identifiers. This guide requires that all entity identifiers be accompanied by assigning
authorities. This allows the exchange of unique identifiers for the associated object across organizational and enterprise
boundaries, enabling broad interoperability.
In the EI data type, the Namespace ID, Universal ID and Universal ID type correspond with the HD data type identified elsewhere.
These types together are commonly considered the assigning authority for the identifier. The Entity Identifier and assigning
authority components, together, constitute the actual identifier.
7.11 FN – FAMILY NAME
TABLE 2-14 – FAMILY NAME (FN)
SEQ
1
2
3
5
LEN
50
DT
Usage
ST
ST
ST
ST
R
X
X
X
ST
X
Value
Set
Component Name
Surname
Own Surname Prefix
Own Surname
Surname Prefix From
Partner/Spouse
Surname From
Partner/Spouse
Comments
Not Supported
Not Supported
Not Supported
Not Supported
Definition: This data type allows full specification of the surname of a person. Where appropriate, it differentiates the person's own
surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name.
It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root.
Page 100
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.12 FT – FORMATTED TEXT DATA
TABLE 2-15 – FORMATTED TEXT DATA (FT)
SEQ
LEN
DT
65536
Usage
R
Component Name
Value
Set
Comments
Coded Value for HL7-Defined Tables
Definition: This data type is derived from the TX data type by allowing the addition of embedded formatting instructions. These instructions
are limited to those that are intrinsic and independent of the circumstances under which the field is being used. The actual instructions and
their representation are described in section 2.7.6, “Usage and Examples of Formatted Text”. The FT field is of arbitrary length (up to 64k)
and may contain formatting commands enclosed in escape characters.
Example:
|\.sp\(skip one vertical line)|
For additional examples of formatting commands see Section 2.7, "Use of Escape Sequences in Text Fields".
Usage: The FT data type allows use of the formatting escape sequences documented in HL7 Version 2.6, Chapter 2, Section 2.7 - Use of
Escape Sequences in Test Fields.
7.13 HD – HIERARCHIC DESIGNATOR
TABLE 2-16 – HIERARCHIC DESIGNATOR (HD)
1
2
3
SEQ
LEN
IS
ST
ID
DT
Usage
R
X
X
Value Set
HL70300
Component Name
Namespace ID
Universal ID
Universal ID Type
Comments
Assign a unique code for each
application/system.
Not Supported
Not Supported
Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has
responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers,
provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient
identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or drivers’ license numbers, or a
facility where such identifiers are assigned.
Usage: The HD data type is used directly to identify objects such as applications or facilities. It is also used as a component of
other data types where it is typically an assigning authority for an identifier. It may be used to identify a URI. Where this capability
is used in this specification, that usage is described separately. Note that the HD data type has been constrained to carry an OID
identifying an application, a facility or an assigning authority.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 101
© 2012 Health Level Seven International. All rights reserved.
7.14 ID – CODED VALUE FOR HL7-DEFINED TABLES
TABLE 2-17 – CODED VALUE FOR HL7-DEFINED TABLES (ID)
SEQ
1
LEN
DT
Usage
Variable
R
Component Name
Value
Set
Comments
Coded Value for HL7-Defined Tables
Definition: Used to communication values defined in HL7-Defined Tables.
7.15 IS – CODED VALUE FOR USER-DEFINED TABLES
TABLE 2-18 – CODED VALUE FOR USER-DEFINED TABLES (ID)
SEQ
1
LEN
DT
Usage
20
R
Component Name
Value
Set
Comments
Coded Value for User-Defined Tables
Definition: Used to communication values defined in User-Defined Tables.
7.16 MSG – MESSAGE TYPE
TABLE 2-19 – MESSAGE TYPE (MSG)
SEQ
1
2
3
LEN
3
3
7
DT
Usage
ID
ID
ID
R
R
R
Value
Set
HL70076
HL70003
HL70354
Component Name
Comments
Message Code
Trigger Event
Message Structure
Definition: This field contains the message type, trigger event, and the message structure ID for the message.
Page 102
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.17 NM – NUMERIC
TABLE 2-20 – NUMERIC (NM)
SEQ
LEN
1
DT
16
Usage
Component Name
Value
Set
R
Comments
Numeric
Definition: A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an
optional decimal point. In the absence of a sign, the number is assumed to be positive. If there is no decimal point the number is assumed
to be an integer.
7.18 PT – PROCESSING TYPE
TABLE 2-23 – PROCESSING TYPE (PT)
1
2
SEQ
1
LEN
ID
ID
DT
Usage
R
X
Value Set
HL70103
Component Name
Processing ID
Processing Mode
Comments
Not Supported
Definition: This data type indicates whether to process a message as defined in HL7 Application (level 7) Processing rules.
7.19 RP – REFERENCE POINTER
TABLE 2-24 – REFERENCE POINTER (RP)
SEQ
LEN
1
999
2
2.1
20
DT
Usage
Value
Set
Component Name
ST
R
Pointer
HD
R
Application ID
IS
O
Namespace ID
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comments
Pointer to the object. For URIs, it contains the path and query
parts.
Example:
/library/committees/orders/minutes/OO_Minutes_20100101.pdf
Length of RP-1 is based on pre-adoption of HL7 Version 2.6
standards.
Unique identifier of the application that holds the object being
pointed to. For URIs, it contains the scheme and authority
parts.
Page 103
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-24 – REFERENCE POINTER (RP)
SEQ
3
LEN
DT
Usage
Value
Set
Component Name
2.2
999
ST
R
2.3
6
11
ID
ID
R
RE
HL70301
HL70834
Universal ID Type
Type of Data
32
ID
RE
HL70291
Subtype
4
Universal ID
Comments
Field that, for URIs, contains the scheme and authority parts.
Example: http://www.hl7.org
Field that, for URIs, contains the literal value ‘URI’.
Identifier of the type of data pointed to. For the URI example
above, this is ‘application’
Identifier of the subtype of data pointed to. For the URI
example above, this is .pdf, for portable document format.
Definition: This data type transmits information about data stored on another system. It contains a reference pointer that uniquely
identifies the data on the other system, the identity of the other system, and the type of data.
Usage: Field using the RP data type to allow communication of pointers to images, sound clips, XML documents, html markup,
etc. The RP data type is used when the object being pointed to is too large to transmit directly.
This specification defines the mechanism for exchanging pointers to objects, but does not address the details of applications
actually accessing and retrieving the objects over a network.
The most common scheme for passing a pointer is to use a Universal Resource Identifier (see http://ietf.org/rfc/rfc2396.txt for a
detailed definition). The general format of a URI is in the form: <scheme>://<authority><path>?<query>. The scheme and
authority portions appear in the Application ID component, Universal ID subcomponent. The path and query portion of the URI
appear in the Pointer component of the RP data type.
7.20 SAD – STREET ADDRESS
TABLE 2-26 – STREET ADDRESS (SAD)
SEQ
1
2
3
LEN
50
DT
Usage
ST
ST
ST
Page 104
© 2012 Health Level Seven International. All rights reserved.
R
X
X
Value
Set
Component Name
Street or Mailing Address
Street Name
Dwelling Number
Comments
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Definition: This data type specifies an entity's street address and associated detail.
Usage: The SAD is used only as a component of the XAD data type.
7.21 SI – SEQUENCE ID
TABLE 2-27 – SEQUENCE ID (SI)
SEQ
1
LEN
DT
Usage
4
R
Component Name
Value
Set
Sequence ID
Comments
Non-negative integer up to 9999. May
be further constrained to limit the number
of times a segment may repeat.
Definition: A non-negative integer in the form of a NM field. The uses of this data type are defined in the chapters defining the segments
and messages in which it appears.
7.22 SN – STRUCTURED NUMERIC
TABLE 2-28 – STRUCTURED NUMERIC (SN)
SEQ
LEN
DT
Usage
Component Name
Value
Set
1
2
ST
RE
Comparator
2
3
16
1
NM
ST
RE
RE
Num1
Separator/Suffix
4
16
NM
RE
Num2
Comments
Component that must be one of ">" or
"<" or ">=" or "<=" or "=" or "<>". This
component defaults to "=" if empty.
Component that must be one of "-" or "+"
or "/" or "." or ":".
Definition: The structured numeric data type is used to unambiguously express numeric clinical results along with qualifications. This
enables receiving systems to store the components separately, and facilitates the use of numeric database queries. The corresponding
sets of values indicated with the <comparator> and <separator/suffix> components are intended to be the authoritative and complete set
of values. If additional values are needed for the <comparator> and <separator/suffix> components, they should be submitted to HL7 for
inclusion in the Standard.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 105
© 2012 Health Level Seven International. All rights reserved.
If <num1> and <num2> are both non-null, then the separator/suffix must be non-null. If the separator is "-", the data range is inclusive;
e.g., <num1> - <num2> defines a range of numbers x, such that: <num1> <=x<= <num2>.
Usage: The SN data type carries a structured numeric value. Structured numeric values include intervals (^0^-^1), ratios (^1^/^2 or
^1^:^2), inequalities (<^10), or categorical results (2^+).
7.23 ST – STRING DATA
TABLE 2-29 – STRING DATA (ST)
SEQ
1
LEN
DT
Usage
999
Value
Set
R
Component Name
Comments
String Data
Definition: The ST data type is normally used for short text strings.
Usage: No leading blanks (space characters) are permitted. Trailing blanks are permitted.
7.24 TX – TEXT DATA
TABLE 2-32 – TEXT DATA (TX)
SEQ
1
LEN
65536
DT
Usage
R
Value Set
Component Name
Text Data
Comments
Definition: The TX data type is used to carry string data intended for display purposes.
Usage: It can contain leading blanks (space characters).
7.25 VID – VERSION IDENTIFIER
TABLE 2-33 – VERSION IDENTIFIER (VID)
SEQ
1
2
3
LEN
3
DT
ID
CWE
CWE
Usage
R
X
X
Value Set
HL70104
Page 106
© 2012 Health Level Seven International. All rights reserved.
Component Name
Version ID
Internationalization Code
International Version ID
Comments
Fixed to value ‘”2.6” in this guide.
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.26 XAD – EXTENDED ADDRESS
TABLE 2-34 – EXTENDED ADDRESS (XAD)
SEQ
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
LEN
50
50
60
12
3
3
2
DT
SAD
ST
ST
ST
ST
ID
ID
ST
IS
IS
ID
DR
TS
TS
CWE
ID
ID
ID
ST
ST
NM
CWE
Usage
RE
RE
RE
RE
RE
RE
X
X
RE
X
X
X
X
X
X
X
X
X
X
X
X
X
Value Set
ISO 3166-1
Component Name
Street Address
Other Designation
City
State or Province
Zip or Postal Code
Country
Address Type
Other Geographic Designation
County/Parish Code
Census Tract
Address Representation Code
Address Validity Range
Effective Date
Expiration Date
Expiration Reason
Temporary Indicator
Bad Address Indicator
Address Usage
Addressee
Comment
Preference Order
Protection Code
Comments
2nd address line
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: This data type specifies the address of a person, place or organization plus associated information.
7.27 XCN – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
SEQ
1
LEN
20
DT
ST
Usage
RE
Value Set
Component Name
ID Number
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comments
If this is a person, the ID must be
accompanied by an OID for the
Page 107
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
SEQ
2
3
4
LEN
50
50
DT
Usage
FN
ST
ST
RE
RE
RE
5
6
7
8
9
10
10
ST
ST
IS
IS
HD
RE
RE
X
X
RE
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1
ID
ST
ID
ID
HD
ID
CWE
DR
ID
TS
TS
ST
CWE
CWE
RE
X
X
RE
X
X
X
X
X
X
X
RE
X
X
3
5
10
Value Set
Component Name
Family Name
Given Name
Second and Further Given Names or
Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Source Table
Assigning Authority
HL70200
HL70061
HL70203
Name Type Code
Identifier Check Digit
Check Digit Scheme
Identifier Type Code
Assigning Facility
Name Representation Code
Name Context
Name Validity Range
Name Assembly Order
Effective Date
Expiration Date
Professional Suffix
Assigning Jurisdiction
Assigning Agency or Department
Comments
assigning authority (component 9). If this
is an organization, the OID for the
organization should be provided here.
Not supported
Not supported
Condition rule: Required if component 1
(ID Number) is populated.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Usage: This data type is used where there is a need to specify the ID number and name of a person.
Page 108
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.28 XON – EXTENDED COMPOSITE NAME AND IDENTIFICATION NUMBER FOR ORGANIZATIONS
TABLE 2-36 – EXTENDED COMPOSITE NAME AND IDENTIFICATION NUMBER FOR ORGANIZATIONS (XON)
SEQ
1
2
3
4
5
6
LEN
100
1
DT
ST
IS
NM
NM
ID
HD
7
8
9
10
5
ID
HD
ID
ST
30
Usage
R
R
X
X
X
CE
Value Set
HL70204
X
X
X
RE
Component Name
Organization Name
Organization Name Type Code
ID Number
Check Digit
Check Digit Scheme
Assigning Authority
Identifier Type Code
Assigning Facility
Name Representation Code
Organization Identifier
Comments
Fixed to a value of “L”
Not supported
Not supported
Not supported
Condition rule: Required if component 10
(organization identifier) is populated.
Not Supported
Not supported
Not supported
Definition: This data type is used to specify the name and ID number of an organization.
7.29 XPN – EXTENDED PERSON NAME
TABLE 2-37 – EXTENDED PERSON NAME (XPN)
SEQ
1
2
3
4
5
6
7
8
9
10
11
12
13
LEN
50
50
10
10
1
DT
FN
ST
ST
ST
ST
IS
ID
ID
CWE
DR
ID
TS
TS
Usage
RE
RE
RE
RE
RE
RE
RE
X
X
X
X
X
X
Value Set
HL70200
Family Name
Given Name
Second and Further Given Names or Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Name Type Code
Name Representation Code
Name Context
Name Validity Range
Name Assembly Order
Effective Date
Expiration Date
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Component Name
Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 109
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-37 – EXTENDED PERSON NAME (XPN)
SEQ
14
LEN
50
DT
ST
Usage
RE
Value Set
Component Name
Professional Suffix
Comments
Definition: This data type specifies the name of a person plus associated information.
7.30 XTN – EXTENDED TELECOMMUNICATION NUMBER
TABLE 2-37 – EXTENDED TELECOMMUNICATION NUMBER (XTN)
SEQ
1
2
3
4
5
6
7
8
9
10
LEN
3
8
100
3
5
9
5
199
4
DT
Usage
ID
ID
ST
NM
NM
NM
NM
ST
ST
X
RE
RE
R
X
X
X
X
X
X
Value
Set
HL70201
HL70202
Component Name
Telephone Number
Telecommunication Use Code
Telecommunication Equipment Type
Communication Address
Country Code
Area/City Code
Local Number
Extension
Any Text
Extension Prefix
Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Definition: This data type specifies the telecommunications numbers for a person, place or organization plus associated information.
Page 110
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
HL7 Version 2.6 Implementation Guide:
Blood Bank Donation Services (US Realm), Release 1
January, 2012
Based on the HL7 v2.6 Interoperability Standard
(with pre-adoptions from HL7 v2.8)
HL7 Informative Document
Sponsored by:
Orders and Observations Work Group
Copyright © 2012 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is
strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are registered trademarks of
Health Level Seven International. Reg. U.S. Pat & TM Off.
IMPORTANT NOTES:
HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from
HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license,
please visit http://www.HL7.org/implement/standards/index.cfm.
If you are the individual that obtained the license for this HL7 Standard, specification or other
freely licensed work (in each and every instance "Specified Material"), the following describes the
permitted uses of the Material.
A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to
the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified
Material to develop and sell products and services that implement, but do not directly incorporate, the
Specified Material in whole or in part without paying license fees to HL7.
INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional
items of Special Material in whole or part, into products and services, or to enjoy additional authorizations
granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL
MEMBERS of HL7.
B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are
authorized, without additional charge, on a perpetual (except as provided for in the full license terms
governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal
purposes only) and share this Material with your employees and consultants for study purposes, and (b)
utilize the Material for the purpose of developing, making, having made, using, marketing, importing,
offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all
cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual
property rights of third parties (which may include members of HL7). No other license, sublicense, or
other rights of any kind are granted under this Agreement.
C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are
authorized, without additional charge, to read and use the Specified Material for evaluating whether to
implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell
products and services that implement, but do not directly incorporate, the Specified Material in whole or in
part.
NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into
products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL
MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7.
Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.
Page 2
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
Acknowledgements
Chapter Chair:
Chapter Chair:
Chapter Chair:
Chapter Chair:
Chapter Chair:
Project chair and Principal
Author:
Project Chair and Coordinator:
Hans Buitendijk
Siemens Medical Solutions Health Services Corporation
Patrick Loyd
Gordon Point Informatics Ltd.
Austin Kreisler
SAIC - Science Applications International Corp
Ken McCaslin
Quest Diagostics, Incorporated
Rob Hausam
OntoReason
Patrick Loyd
Gordon Point Informatics Ltd.
Jonathan Harber
Blood Systems, Inc.
Thanks to the Project Team of experts who met over the course of 2009 & 2010 to produce this guide and
upgrades to the v2.8 HL7 Standard for Blood Donation Services. The Project Team is listed below.
Name
Jonathan Harber*
Rodeina Davis*
Melinda Bryant
Amit Bhagat
Shri Potdar
Patrick Loyd*
Robert Kapler
Pat Distler
Patti Larson*
Ruth Harkin
Peggy Dunn
Goudar Shankar
Jeff Wurst
Sue McBride
Philip Abrams
Suzanne Nagami*
David Eide*
Joe Foster
Rick Stone
Troy Campbell
Bob Diol
Organization
Blood Systems, Inc.
Blood Center of Wisconsin
ITSynergistics
Blood Center of Wisconsin
Mediware
GPI
ABC
ICCBBA
Haemonetics
NY Blood Center
Puget Sound Blood Center
Carter BloodCare
BBCS
MAK-System
Talisman
Kaiser Permanente
Group Health Cooperative
Fenwal
Healthcare-ID
Florida Blood Services
Blood Center of Wisconsin
* Denotes HL7 OO Work Group Member
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 3
© 2012 Health Level Seven International. All rights reserved.
TABLE OF CONTENTS
1
2
3
4
5
INTRODUCTION ............................................................................................................................................ 7
1.1
Purpose................................................................................................................................................... 7
1.2
Audience ................................................................................................................................................. 7
1.3
Scope ...................................................................................................................................................... 7
1.4
Assumptions ........................................................................................................................................... 7
1.5
Conventions ............................................................................................................................................ 8
1.6
Open Issues ............................................................................................................................................ 9
MESSAGING INFRASTRUCTURE .............................................................................................................. 13
2.1
Delimiters .............................................................................................................................................. 13
2.2
Null Values ............................................................................................................................................ 14
2.3
Lengths ................................................................................................................................................. 14
2.4
Snapshot processing ............................................................................................................................ 14
2.5
Use Of Escape Sequences In Text Fields ............................................................................................ 15
2.6
Acknowledgements ............................................................................................................................... 15
2.7
Field Lengths ........................................................................................................................................ 15
MESSAGE PROFILE – Blood BANK DONATION PROCESS MESSAGING .............................................. 16
3.1
Usage Notes for Donation Service (Blood Bank) .................................................................................. 16
3.2
Activity Diagram .................................................................................................................................... 16
3.3
Actors .................................................................................................................................................... 18
3.4
Dynamic Definition ................................................................................................................................ 19
3.5
Interactions ........................................................................................................................................... 20
MESSAGES ................................................................................................................................................. 24
4.1
DBC - Create Donor Record Message (Event O41) ............................................................................. 26
4.2
DBU - Update Donor Record Message (Event O42) ............................................................................ 27
4.3
QBP - Get Donor Record Candidates (Event Q33)............................................................................... 28
4.4
RSP - Get Donor Record Candidates Response (Event K33) .............................................................. 29
4.5
QBP - Get Donor Record (Event Q34).................................................................................................. 30
4.6
RSP - Get Donor Record Response (Event K34) ................................................................................. 31
4.7
DRG - Donor Registration (Event O43) ................................................................................................ 33
4.8
DER - Donor Eligibility Request (Event O44)........................................................................................ 34
4.9
DEO - Donor Eligibility Observations (Event O45) ................................................................................ 35
4.10
DEL - Donor Eligibility (Event O46) .................................................................................................. 37
4.11
DRC - Donor Request to Collect (Event O47) .................................................................................. 38
4.12
DPR - Donation Procedure (Event O48)........................................................................................... 39
4.13
ACK – Acknowledgement ................................................................................................................. 41
SEGMENT AND FIELD DESCRIPTIONS .................................................................................................... 42
5.1
Segment Attribute Table Abbreviations ................................................................................................ 42
5.2
Segment Usage Definitions .................................................................................................................. 43
5.3
MSH – Message Header Segment ....................................................................................................... 44
5.4
MSA – Acknowledgement Segment ..................................................................................................... 46
5.5
ERR – Error Segment ........................................................................................................................... 47
5.6
PID – Patient Identification Segment .................................................................................................... 48
5.7
PD1 – Patient Additional Demographic................................................................................................. 50
5.8
PV1 – Patient Visit Information ............................................................................................................. 51
5.9
OBR – Observation Request Segment ................................................................................................. 53
5.10
OBX – Observation Result Segment (Questionnaire Responses and Mini-Physical) ...................... 56
Page 4
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
5.11
OBX – Observation Result Segment (Donor) ................................................................................... 58
5.12
OBX - Observation Identifiers (Donor) .............................................................................................. 59
5.13
OBX – Observation Result Segment (Donation and Adverse Events) ............................................. 62
5.14
OBX - Observation Identifiers (donation and Adverse Events) ......................................................... 63
5.15
AL1 – Patient Allergy Information Segment ...................................................................................... 65
5.16
NTE – Notes and Comments Segment ............................................................................................ 66
5.17
DON - Blood Bank Donation Segment ............................................................................................. 67
5.18
BUI – Blood Unit Information Segment ............................................................................................. 69
5.19
RCP – Response Control Parameter Segment ................................................................................ 70
5.20
QPD – Query Parameter Definition Segment – For Event Q33 ........................................................ 71
5.21
QPD – Query Parameter Definition Segment – For Event Q34 ........................................................ 73
5.22
QAK – Query Acknowledgement Segment....................................................................................... 73
6
CODE SYSTEMS AND VALUE SETS ......................................................................................................... 74
6.1
Code Table Abbreviations..................................................................................................................... 75
6.2
User-Defined Table HL70001 – Administrative Sex.............................................................................. 75
6.3
User-Defined Table HL70003 – Event Type ......................................................................................... 76
6.4
User-Defined Table HL70005 – Race ................................................................................................... 76
6.5
HL7 Table HL70008 – Acknowledgement Code ................................................................................... 77
6.6
HL7 Table HL70076 – Message Type .................................................................................................. 77
6.7
HL7 Table HL70103 – Processing ID ................................................................................................... 77
6.8
HL7 Table HL70125 – Value Type........................................................................................................ 78
6.9
HL7 Table HL70136 - Yes/No Indicator ................................................................................................ 79
6.10
HL7 Table HL70155 – Accept/Application Acknowledgment Conditions .......................................... 79
6.11
User-Defined Table HL70189 – Ethnic Group .................................................................................. 80
6.12
User-Defined Table HL70190 - Address type ................................................................................... 80
6.13
HL7 Table HL70191 – Type Of Referenced Data ............................................................................. 80
6.14
HL7 Table HL70200 - Name Type .................................................................................................... 81
6.15
HL7 Table HL70201 - Telecommunication use code ........................................................................ 81
6.16
HL7 Table HL70202 - Telecommunication Equipment Type code ................................................... 81
6.17
HL7 Table HL70203 – Identifier Type ............................................................................................... 82
6.18
External Table HL70291 – Sub Type Of Referenced Data ............................................................... 83
6.19
HL7 Table HL70299 – Encoding....................................................................................................... 83
6.20
User-Defined Table HL70300 – Namespace ID ............................................................................... 83
6.21
User-Defined Table HL70305 – Person Location Type .................................................................... 84
6.22
HL7 Table HL70354 – Message Structure ....................................................................................... 84
6.23
HL7 Table HL70357 – Message Error Condition Codes................................................................... 85
6.24
Hl7 Table HL70396 – Coding System .............................................................................................. 85
6.25
User-Defined Table HL70471 – Query Name................................................................................... 86
6.26
HL7 Table HL70516 – Error Severity................................................................................................ 86
6.27
User-Defined Table HL70559 – Duration Units ................................................................................ 86
6.28
User-Defined Table HL70560 – Blood Procedure Type ................................................................... 87
6.29
User-Defined Table HL70561 – Process Interruption ....................................................................... 87
6.30
User-Defined Table HL70562 – Process Interruption Reason.......................................................... 88
6.31
User-Defined Table HL70564 – Phlebotomy Issue........................................................................... 88
6.32
User-Defined Table HL70563 – Phlebotomy Status ......................................................................... 89
6.33
User-Defined Table HL70565 – Arm Stuck ...................................................................................... 89
6.34
User-Defined Table HL70566 – Blood Unit Type ............................................................................. 89
6.35
User-Defined Table HL70567 – Weight Units................................................................................... 90
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 5
© 2012 Health Level Seven International. All rights reserved.
6.36
User-Defined Table HL70568 – Volume Units.................................................................................. 90
6.37
User-Defined Table HL70569 – Temperature Units ......................................................................... 91
6.38
HL7 Table HL70834 – MIME Type ................................................................................................... 91
7
Data Types ................................................................................................................................................... 92
7.1
Data Types Summary ........................................................................................................................... 92
7.2
Data Type Table Abbreviations............................................................................................................. 93
7.3
CNE – Coded No Exceptions................................................................................................................ 95
7.4
CNN – Composite ID Number and Name Simplified............................................................................. 96
7.5
CQ – Composite Quantity with Units .................................................................................................... 97
7.6
CWE – Coded with Exceptions ............................................................................................................. 97
7.7
CX – Extended Composite ID with Check Digit .................................................................................... 98
7.8
DTM – Date/Time.................................................................................................................................. 99
7.9
ED – Encapsulated Data....................................................................................................................... 99
7.10
EI – Entity Identifier......................................................................................................................... 100
7.11
FN – Family Name .......................................................................................................................... 100
7.12
FT – Formatted Text Data .............................................................................................................. 101
7.13
HD – Hierarchic Designator ............................................................................................................ 101
7.14
ID – Coded Value for HL7-Defined Tables ..................................................................................... 102
7.15
IS – Coded Value for User-Defined Tables .................................................................................... 102
7.16
MSG – Message Type .................................................................................................................... 102
7.17
NM – Numeric ................................................................................................................................. 103
7.18
PT – Processing Type .................................................................................................................... 103
7.19
RP – Reference Pointer .................................................................................................................. 103
7.20
SAD – Street Address..................................................................................................................... 104
7.21
SI – Sequence ID............................................................................................................................ 105
7.22
SN – Structured Numeric ................................................................................................................ 105
7.23
ST – String Data ............................................................................................................................. 106
7.24
TX – Text Data................................................................................................................................ 106
7.25
VID – Version Identifier ................................................................................................................... 106
7.26
XAD – Extended Address ............................................................................................................... 107
7.27
XCN – Extended Composite ID Number and Name for Persons.................................................... 107
7.28
XON – Extended Composite Name and Identification Number for Organizations .......................... 109
7.29
XPN – Extended Person Name ...................................................................................................... 109
7.30
XTN – Extended Telecommunication Number ............................................................................... 110
Page 6
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
1 INTRODUCTION
1.1 PURPOSE
The HL7 Blood Bank Donation Services Implementation Guide – U.S. Realm is a messaging specification
intended to standardize the electronic transmission of information between system application
components in a Blood Bank setting. While this is U.S. Realm specific, there are no constraints that are
U.S. specific; rather the project team did not include sufficient International stakeholder representation to
assert the outcome and this Implementation Guide is Universal in nature.
This Implementation Guide is specific to the interoperability to support activities related to the registration,
screening for eligibility, donation, and collection of blood from a human. The goal of this specification is to
provide an applicable specification that can be adopted as an industry standard, thereby obviating the
need for individual vendors to define anew the specifications of each Donation Service interface required.
1.2 AUDIENCE
The standards defined in this guide are intended for use by clinical data exchange systems found in the
Blood Donation community groups listed below:
•
Blood Centers in the United States of America - Any service center that performs the collection of
blood.
•
Physician’s Offices – Any care practice, clinic, hospital, individual physician, or department that
orders directed or autologous (self) donations.
1.3 SCOPE
This specification focuses exclusively on the electronic transfer of information between system application
components used to support activities for the collection and donation of blood. This Implementation
Guide does not include:
•
definition for maintaining a registry of providers who can ‘order’ blood donations.
•
definition for communication between automated lab testing devices and Lab Information
Systems.
•
definition for communicating shipping information.
Although this Implementation Guide does not include the definitions immediately foregoing in this
paragraph, reuse of the information in this document to aid activities designed to automate those
definitions is not precluded.
The remainder of this document specifies the dynamic and static aspects of this Implementation Guide.
Although this document describes the elements of HL7 messages and messaging interactions as they
relate to this specification, it does not constitute an introduction to HL7. Readers unfamiliar with HL7
should first review the HL7 2.x standard (especially Chapters 4 and 7), available to HL7 members or for
purchase at www.hl7.org.
1.4 ASSUMPTIONS
This document assumes that users have a need to electronically exchange blood donation services
information. It also assumes that the user is familiar with the HL7 v2.6 standard.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 7
© 2012 Health Level Seven International. All rights reserved.
1.5 CONVENTIONS
This specification is based on the HL7 version 2.6 messaging standard. Because the v2.6 HL7 Standard
does not contain relevant elements to communicate blood donation information, two segments (DON –
Blood Donation Segment & BUI – Blood Unit Information) and all the message types are pre-adopted
from the HL7 v2.8 Standard.
Note that the HL7 v2.8 Standard is still in ballot along with this document and, therefore, there is some risk of change. However,
stakeholders interested in blood donation messaging based on HL7 v2.x were invited to participate with the project team to
minimize risk of change during balloting and reconciliation.
The specification defines message profiles for relevant HL7 message types. A message profile is an
unambiguous specification of an HL7 message type intended for a particular use case, as defined in
Section 2.12 of the HL7 v2.6 standard.
A message profile defines both the dynamic aspects of information interchange (i.e., the systems that
participate in such interchanges and the real-world events that trigger the interchanges) as well as the
static aspects of messaging (i.e., the structure and contents of the electronic messages that are
exchanged).
•
The rules outlined in HL7 2.6, Chapter 2, section 2.12, Conformance Using Message Profiles,
were used to document the use case for, and constraints applied to, the messages described in
this guide.
•
Data types have been described separately from the fields that use the data types. For details
regarding data type field lengths, please refer to section 2.3, Lengths, in this document.
Page 8
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
1.6 OPEN ISSUES
1
P. Loyd
11/8
Is this IG US Realm or Universal?
> Believe US Realm; Universal can use it, but
International stakeholders were not vetted.
Closed
2
P. Loyd
11/8
How much detail for data types?
>We believe the amount of detail in this guide is
appropriate for an IG. It is expected that vendors and
other stakeholders directly using this guide
would/could gain access to the base HL7 v2.6
Standard.
Closed
3
P. Loyd
11/8
Confirm methodology; no unlimited (*) cardinalities
>Author used the 10, 100, 1000, 10000 method
> Medications – upper limit of 25
>Donor-obs – 10 is fine
Adverse Reaction obs- 10 is too little based on
hierarchy (PEL, updated to 100)
> All NTEs updated to 1..100
> Donor Candidates response max limit updated to
1000
Closed
4
P. Loyd
11/8
Query Parameters
>FN (Given Names), LN, DOB, Admin Sex for
Candidates
>For Donor Record, use only donor id
Closed
5
P. Loyd
11/8
Should there be a group around donation. Under what
circumstances is there more than one DON? Check
the minutes to see if we have that point documented
(cause we need it).
>More than one stick, then more than one DON
PEL> fixed cardinality of group vs DON segment for
DPC and RSP
Closed
6
P. Loyd
11/8
Section 2.5 – Leave the notes to balloters from the IG
where some of the materials were sourced?
>No, remove them
Closed
7
P. Loyd
11/8
Confirmation and/or rejection interactions
>Need this ability – forward thinking
PEL> update graphic, ensure IG has all the right
pieces/parts for ack’ing and nack’ing
PEL> Determined to use original acknowledgement
mode (and not enhanced mode).
Closed
8
P. Loyd
11/8
Why are create/update separate Donor BoR?
>Like them separate (which is OK)
Closed
9
P. Loyd
11/8
Confirm mapping ConditionText to TQ1
Who is the administrator of the questionnaire: donor or
staff, if staff – indicate in OBR 10.1
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 9
© 2012 Health Level Seven International. All rights reserved.
> Map to OBX Responsible Observer, use ‘donor’
value or the staff person’s ID when appropriate
10
P. Loyd
11/8
HL7 tables need further constraining: 0008, 0125,
0155, 0357, 0516
PEL> 0008, 0155, 0357, 0516 (done)
JH, PL> value type 0125 (from min-physical and
questionnaires). What types of values do we expect?
Team> Review value types included in this profile
Closed. The
team reviewed
these data
types and has
agreed that
these types will
be sufficient to
address all
required use
cases
11
P. Loyd
11/8
Data types incomplete
Closed
12
P. Loyd
11/8
Confirm mapping Medication – RXA
PEL> Mapped into donor-level OBXs
Closed
13
P. Loyd
11/8
Add IG-specific language from minutes
Closed
14
P. Loyd
11/8
AL1-3, data type is CWE
PEL> determine to make CWE but not recommend a
code system for this IG.
Closed
15
P. Loyd
11/8
Need a profileID
PEL> One is recommended
Closed
16
P. Loyd
11/8
User-defined tables need further constraining or
values: Sex 0001,
Race 0005,
ethnic group 0189,
address type 0190 (only support home, business),
organization name types 0204 (not supported),
language 0296 (not supported)
Closed
17
P. Loyd
11/8
Create donor-level OBX
Closed
18
P. Loyd
11/8
Create donation-level OBX
Closed
19
P. Loyd
11/8
Create adverse event-level OBX
Closed
20
P. Loyd
11/9
Do we need ED and RP data type? Do we support
either a reference pointer to data (for example, a pdf
file) or are we ready to embed the .pdf in an ED?
More specific, but duplicate of #10, table 0125.
Closed
21
P. Loyd
11/9
Should the mappable data elements be RE or O?
Team> RE
Closed
22
P. Loyd
11/9
Namespace methodology was chosen (for now) for
identifiers
Closed
23
P. Loyd
11/9
Team to check the lengths of strings (for example, last
name is 999 characters, at the moment)
Closed
Page 10
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
PEL> All places where the limit was 999 has been
restricted. Needs review by team.
24
P. Loyd
11/9
What’s the strategy for optional vs. RE (see #21)
Closed
25
P. Loyd
11/9
Use of UCUM
PEL> UCUM is standard. Just wanted to initially point
this out.
Closed
26
P. Loyd
11/9
Use of ISO 3166-1 for country codes
PEL> ISO is standard. Just wanted to initially point
this out.
Closed
27
P. Loyd
11/9
Check mapping 3.8, 3.9
PEL> Moved both to new fields in DON. Will need to
change OO proposal to reflect this update.
Closed
28
P. Loyd
12/6
Length (query parameter) for patient id, 20 characters
lastname, 50 characters
firstname, 50 characters
Include time for DOB? No, date only
Closed
29
P. Loyd
12/6
Support for multiples and use/type codes:
Telephone (and use code) 0201, 0202 (home, office,
cell only) up to 3
Address (and use code) 0190, up to 2, home, work
Name (and use code) 0200 (PEL look 1.5-1.12)
PEL> Nickname, Maiden Name in standard. Need
more info re: previous name (open a new issue below)
Race 0005 , (includes all races which does include
indigenous tribe designations)
language 0296, (no one supports)
ethnicgroup 0189, (Hispanic, non-hispanic designation
only)
identifiers 0203 (need survey)donor number, national
id, legacy id 1, legacy id 2 (limit of 4);
Select the max’es; field lengths and usage
Closed
30
P. Loyd
12/13
Add code tables to support ED data types
Closed
31
P. Loyd
12/30
Need more information on previous name. The HL7
standard supports this with effective date ranges for
any and all names and doesn’t support a ‘soft’ concept
like ‘previous’.
JH> Will survey vendors
PEL> Selected ‘B’ and document such from the
mapping document
Closed
32
P. Loyd
12/30
Change to naming of table 0001 – Administrative Sex
to Gender does not conform to the HL7 standard
(which might confuse folks)
Closed
33
P. Loyd
12/30
Mapping for usual collection location (PV1) and
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 11
© 2012 Health Level Seven International. All rights reserved.
collection facility (PDA) seem incorrect. Review with
team at next meeting
34
Page 12
P. Loyd
1/15/2011
What’s the difference between DON 28 and DON 33?
Closed
Jonathan
Presented Use
Cases to
Patrick for
inclusion.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
2 MESSAGING INFRASTRUCTURE
2.1 DELIMITERS
This profile supports the use of the normal HL7 delimiters. It is recommended, but not required, that
implementers be able to send messages using the standard HL7 delimiters. Receivers must, however,
be capable of receiving any legal delimiters that are sent in a particular message instance.
This table is adopted from the HL7 Version v2.6 Standard which offers information regarding Best
Practice. Note that this implementation guide includes additional constraints and explanations for some of
the entries.
TABLE 2-1 – DELIMITERS
Delimiter
Suggested
Encoding
Value
Character
Segment
Terminator
<cr>
-
Field Separator
|
-
Component
Separator
^
1
Repetition
Separator
~
2
Escape Character
\
3
Position
Description
Terminates a segment record. This value cannot
be changed by implementers.
Additional constraints and Explanation:
The <cr> denotes the ASCII-013 carriage return
character. There is a common misunderstanding
that a line feed character, or carriage return
followed by a line feed character, is allowed also.
Neither of these 2 methods are allowed by HL7 or
this profile as part of the segment terminator.
Only the ASCII-013 carriage return is allowed.
Separates two adjacent data fields within a
segment. It also separates the segment ID from
the first data field in each segment.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-124, the vertical bar (|) character, as the
field separator.
Separates adjacent components of data fields
where allowed.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-094, the caret (^) character, as the
component separator.
Separates multiple occurrences of a field where
allowed.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-126, the tilde character (~), as the
repetition separator.
Escape character for use with any field
represented by an ST, TX or FT data type, or for
use with the data (fourth) component of the ED
data type. If no escape characters are used in a
message, this character may be omitted.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 13
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-1 – DELIMITERS
Delimiter
Subcomponent
Separator
Suggested
Encoding
Value
&
Character
Position
4
Description
However, it must be present if subcomponents
are used in the message. Best practice is to
always include this character.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-091, the backslash (\) character, as the
escape character.
Separates adjacent subcomponents of data fields
where allowed. If there are no subcomponents,
this character may be omitted. Best practice is to
always include this character.
Additional constraints and Explanation:
It is strongly recommended that senders use
ASCII-038, the ampersand (&) character, as the
subcomponent separator.
2.2 NULL VALUES
In HL7, a null value is indicated by paired double quotes (|""|) for a field. A null value indicates that the
receiver of the message should delete the corresponding piece of information from its data store. For this
implementation guide, null values within components and subcomponents are meaningless. For example
|lastname^firstname^""^^^^L| would be interpreted exactly as |lastname^firstname^^^^^L|. The
components and subcomponents of a data type constitute a snapshot of the data. The set of data
represented by the data type is handled as a complete set; therefore, using the null value to indicate a
missing component or subcomponent is unnecessary.
2.3 LENGTHS
In HL7 Version 2.5, HL7 assigned lengths to the components of data types, but did not standardize the
lengths of the fields that use those data types. This guide employs the following rules for lengths:
•
Only lengths of atomic data types are documented. This rule applies to both complex data types
and fields in segments.
•
The lengths of atomic data types are based upon either the 2.5.1 length, the 2.6 length, or a
length the project team felt was needed to meet the use case.
•
Lengths of optional and unsupported segment fields and data type components are not
documented in this guide. The lengths of optional and unsupported fields and data type
components are outside the scope of this document.
Note: In HL7 Version 2.5.1, the length of 65536 has a special meaning: For HL7, "If the maximum length needs to
convey the notion of a Very Large Number, the number 65536 should be displayed to alert the user."
In this implementation guide, fields or components with length 65536 should be understood as having no prescribed
length. Receivers should be prepared to accept any size chunk of data carried in the field or component.
2.4 SNAPSHOT PROCESSING
HL7 distinguishes between two methods of update: the "snapshot" and the "action code/unique identifier"
modes. Both modes apply to repeating segments and repeating segment groups. For repeating fields,
Page 14
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
only snapshot processing applies. For the purpose of this guide, only snapshot processing is supported
for segments, segment groups and fields.
2.4.1 REPEATING SEGMENTS
HL7 defines snapshot processing for segments as follows:
In the "snapshot" mode, the information contained in the set of repeating segments or segment groups from the incoming
message replaces the corresponding information in the receiving application. This is equivalent to a deletion of the prior
information followed by the addition of the newly supplied information. In this mode, everything (all repeating segments
and segment groups) must be sent with every subsequent message in the series of messages. There is no other way to
indicate which ones changed and which ones did not.
To specify "delete all of the segments in this repeating group" in the snapshot mode, send a single segment with "delete
data" (indicated by a value of "") in all fields.. This actively signals the receiver that there is information that needs to be
deleted. If no segment were sent, this would equate to "no information." No information should not signal the receiver to
take an action. There would be risk that the receiver might misinterpret the sender's intent. 1
2.4.2 REPEATING FIELDS
Snapshot processing for repeating fields requires sending a full list of repetitions for each transaction. If
the intent is to delete an element, the element is left off the list. This is analogous to the snapshot mode
for repeating segments and segment groups. To delete the whole list, transmit the field once with a "Null"
in the first component.
Repetitions of fields shall not have empty repetitions followed by repetitions containing data, except
where the HL7 standard clearly reserves certain repetitions for specific purposes. For instance PID-5,
Patient Name is a repeating field, the first repetition of which is reserved by HL7 for the legal name. In
the case where a name is known for the patient, but is not the legal name, format the name field as
follows: |~lastname^firstname^mi^^^^A|.
2.5 USE OF ESCAPE SEQUENCES IN TEXT FIELDS
Senders and receivers using this profile shall handle escape sequence processing as described in HL7
Version 2.6, Chapter 2, section 2.7.4 (Special Characters) and section 2.7.5 (Hexadecimal).
Implementers may support escape sequences described in sections 2.7.2 (Escape sequences supporting
multiple character sets), 2.7.3 (Highlighting), 2.7.6 (Formatted Text) and 2.7.7 (Local).
2.6 ACKNOWLEDGEMENTS
Senders and receivers using this profile shall use original mode acknowledgement processing which
defines acknowledgements upon successful or unsuccessful processing of a message by a receiver.
Note that the interaction diagram does not show the acknowledgements.
2.7 FIELD LENGTHS
After lengthy discussion, the authors have concluded that there is no satisfactory way to calculate
maximum length for complex data types with embedded optional components that would be of benefit to
the user. Therefore, lengths are specified only for fields associated with “atomic” data types.
1
Taken from HL7 v2.6 Standard, Chapter 2, section 2.10.4.1.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 15
© 2012 Health Level Seven International. All rights reserved.
3 MESSAGE PROFILE – BLOOD BANK DONATION PROCESS
MESSAGING
The following message profile definitions support communications between systems components often
deployed in a blood donation/collection center.
3.1 USAGE NOTES FOR DONATION SERVICE (BLOOD BANK)
The Blood Bank Donation Service messages and segments were developed using a different
methodology than the similar Transfusion Service (BLOOD BANK) already present in this standard (HL7
v2.6 Standard). Each of the segments defined for the Transfusion Service groups together all the
‘transfusion’ information in one segment, each. The Donation Service was developed breaking out the
blood product ‘donated’ from the donation event itself. This is a more sustainable and interoperable
approach. Future changes to the Transfusion Service should uptake this style.
3.2 ACTIVITY DIAGRAM
The donation service messages have been developed to facilitate communications between typical
system components in a blood bank donation service facility. Frequently different components of blood
banking systems (e.g. registration, questionnaire) are bundled together in one system produced by one
vendor. However since there is no standard for that bundling, in any particular implementation any of the
named system components can be implemented on another system and therefore communications to that
component is necessary. The typical components are illustrated in the graphic on the next page.
Additionally, the graphic also depicts a flow of information through those systems during a donation
process. Note that the interaction diagram does not show the acknowledgements; however, return
acknowledgements are allowed for any non-query message interaction (a QAK acknowledgement is
required for queries; see RSP messages).
Page 16
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 17
© 2012 Health Level Seven International. All rights reserved.
3.3 ACTORS
As mentioned previously, many of the existing systems used in the donation collection process conduct
all these actions in a single bundled system. Extension of the systems on this page is presented in this
format because there is no standard for that bundling, in any particular implementation any of the named
system components can be implemented on another system and therefore communications to that
component is necessary.
3.3.1 ORDERING PROVIDER
For Directed and Autologous Donations, this is the Healthcare Provider requesting a blood
donation.
3.3.2 REGISTRATION SYSTEM
All donors are registered in this system.
3.3.3 DONOR BOOK OF RECORD SYSTEM
This is the source-of-truth for every donor, whether evaluated and deferred, rejected, or not
deferred.
3.3.4 MINI-PHYSICAL SYSTEM
The mini-physical examination conducted on all potential donors is documented using this
system.
3.3.5 QUESTIONNAIRE SYSTEM
Each potential donor must fill out a questionnaire which asks about previous medical history
and risk factors using this documentation system.
3.3.6 DONATION SYSTEM
The phlebotomists and other healthcare professionals use this system to document the blood
donation procedure.
3.3.7 DEVICE INTERFACES
Interface to devices used during the mini-physical, donation, and shipping systems.
3.3.8 PROVIDER MASTER
This system keeps the master list of providers.
3.3.9 SHIPPING SYSTEM
This system is used to document the shipping manifest from information received from the
actual donations.
Page 18
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
3.4 DYNAMIC DEFINITION
TABLE 3-1 – DYNAMIC DEFINITION
Item
Profile ID
HL7 Version
Accept Acknowledgement
Application Acknowledgement
Acknowledgement Mode
Profile Type
Message Types
Encoding
Value
USBBDon
2.6
AL – Always
Refer to HL7 Table 0155 – Accept/application Acknowledgment conditions for valid values.
Immediate
Realm Constrainable Profile
See Section 3.5 - Interactions
A
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 19
© 2012 Health Level Seven International. All rights reserved.
3.5
INTERACTIONS
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
Query for Donor
Candidates (Q33)
Description
Query request candidate
donor information
2
Donor Candidate Query
Response (K33)
Query response candidate
donor information
3
Query for Donor Record
(Q34)
Donor Record Query
Response (K34)
Query request donor record
5
Create Donor Record
(O41)
Create donor record
5
Update Donor Record
(O42)
Update donor book of
record
6
Registration (O43)
Register donor for potential
donation
6
Registration (O43)
Register donor for potential
donation
7
Donor Eligibility Request
(O44)
7
Donor Eligibility Request
Request to conduct Predonation Tests and
Physical Exams. May also
include the questions to
ask.
Request to conduct Pre-
1
4
Query response donor
record
Page 20
© 2012 Health Level Seven International. All rights reserved.
Message
QBP - Get Donor
Record
Candidates
(Event Q33)
RSP - Get Donor
Record Candidates
Response (Event K33)
QBP - Get Donor
Record (Event Q34)
RSP - Get Donor
Record
Response
(Event K34)
DBC – Create Donor
Record Message
(Event O41)
DBU - Update Donor
Record Message
(Event O42)
DRG - Donor
Registration (Event
O43)
DRG - Donor
Registration (Event
O43)
DER - Donor Eligibility
Request (Event O44)
Sending Actor
Donor Registration
System
Receiving Actor
Donor Book of Record
System
Donor Book of Record
System
Donor Registration System
Donor Registration
System
Donor Book of Record
System
Donor Book of Record
System
Donor Registration System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donor Book of Record
System
Donor Registration
System
Donation System
Donor Registration
System
Electronic Medical
Questionnaire System
DER - Donor Eligibility
Donor Registration
Mini-Physical System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No.
(O44)
Event
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
8
Donor Eligibility
Observations (O45)
9
Eligibility (O46)
9
Eligibility (O46)
Description
donation Tests and
Physical Exams. May also
include the questions to
ask.
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Questionnaire questions
and answers and miniphysical observations and
assessments
Communication of the
eligibility assessment for
this donation event (also
used in the case of a
deferral as well as a
successful eligibility
assessment)
Communication of the
eligibility assessment for
this donation event (also
used in the case of a
deferral as well as a
Message
Request (Event O44)
Sending Actor
System
Receiving Actor
DEO - Donor Eligibility
Observations (Event
O45)
Electronic Medical
Questionnaire System
Donor Registration System
DEO - Donor Eligibility
Observations (Event
O45)
Mini-Physical System
Donor Registration System
DEO - Donor Eligibility
Observations (Event
O45)
Electronic Medical
Questionnaire System
Donor Book of Record
System
DEO - Donor Eligibility
Observations (Event
O45)
Mini-Physical System
Donor Book of Record
System
DEL – Donor Eligibility
(EVENT O46)
Donor Registration
System
Donor Book of Record
System
DEL – Donor Eligibility
(EVENT O46)
Donor Book of Record
System
Donor Registration System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 21
© 2012 Health Level Seven International. All rights reserved.
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
10
Request to Collect (O47)
10
Request to Collect (O47)
11
Donation (O48)
11
Donation (O48)
12
Products Collected
12
Products Collected
12
Products Collected
13
Shipment Manifest
14
Donation Request
Description
successful eligibility
assessment)
Donor / Medical Screener
has completed the
questionnaire portion of the
medical history
Donor / Medical Screener
has completed the
questionnaire portion of the
medical history
Messages may transmit the
answers back, or may
simply indicate that donor
is Not Deferred (yet)
Messages may transmit the
answers back, or may
simply indicate that donor
is Not Deferred (yet)
Communication of blood
unit information for units
collected
Communication of blood
unit information for units
collected
Communication of blood
unit information for units
collected
Shipping manifest for blood
units collected
For directed and
autologous donations, the
request from an ordering
Page 22
© 2012 Health Level Seven International. All rights reserved.
Message
Sending Actor
Receiving Actor
DRC – Donor Request
to Collect (EVENT
O47)
Donor Registration
System
Donation System
DRC – Donor Request
to Collect (EVENT
O47)
Donor Book of Record
System
Donation System
DPR – Donation
Procedure (EVENT
O48)
Donation System
Donor Registration System
DPR – Donation
Procedure (EVENT
O48)
Donation System
Donor Book of Record
System
Not in scope
Donation System
Shipping System
Not in scope
Donor Registration
System
Shipping System
Not in scope
Donor Book of Record
System
Shipping System
Not in scope
Shipping System
Receiving System
Not in scope
Order Management Ordering Provider
Donor Registration System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No.
Event
14
Donation Request
15
Device Interfaces
15
Device Interfaces
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
16
Provider Create/Update
17
O41, O42, O43, O44, O45,
O46, O47, O48
Description
provider
For directed and
autologous donations, the
request from an ordering
provider
Communication between
lab testing devices
Communication between
lab testing devices
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Communication of provider
master file updates
Acknowledgements
Message
Receiving Actor
Not in scope
Order Management Ordering Provider
Donor Book of Record
System
Not in scope
Devices
Not in scope
Devices
Electronic Medical
Questionnaire System
Mini-Physical System
Not in scope
Provider Master
Donor Registration System
Not in scope
Provider Master
Not in scope
Provider Master
Donor Book of Record
System
Donation System
Not in scope
Provider Master
Not in scope
Provider Master
Electronic Medical
Questionnaire System
Mini-Physical System
ACK
Varies
Varies
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Sending Actor
Page 23
© 2012 Health Level Seven International. All rights reserved.
4 MESSAGES
The following sections detail the structure of each message, including segment name, usage, cardinality,
and description. The table below details the abbreviated terms used in the message tables, as well as
the definitions associated with those abbreviations.
TABLE 4 -1 – MESSAGE ATTRIBUTES
Abbreviation
Segment
Name
Usage
Cardinality
Section
Description
Definition
Three-character code for the segment and the abstract syntax (e.g., the square and curly braces).
• [ XXX ]
Optional
• { XXX }
Repeating
• XXX Required
•
[{ XXX }] Optional and Repeating
Note that for segment groups there is no segment code present, but the square and curly braces
will still be present.
Name of the segment or segment group element.
Use of the segment for this guide. Indicates if the segment is required, optional, or conditional in a
message. Legal values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• X – Not used.
Minimum and maximum number of times the element may appear.
• [0..0] Element never present.
• [0..1] Element may be omitted and can have, at most, one occurrence.
• [1..1] Element must have exactly one occurrence.
• [0..n] Element may be omitted or may repeat up to n times.
• [1..n] Element must appear at least once, and may repeat up to n times.
• [0..*] Element may be omitted or repeat an unlimited number of times.
• [1..*] Element must appear at least once, and may repeat unlimited number of times.
• [m..n] Element must appear at least m, and at most, n times.
The part of this guide that describes the segment.
A short description of the use of the segment.
Note: In the tables throughout this document, Yellow = This Implementation Guide does not support the
use of this item.
Page 24
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved.
January 2012
TABLE 4 -1 – MESSAGE USAGE DEFINITIONS
Value
R
Required
Description
RE
Required but may be empty
X
Not supported
Comment
A conforming sending application shall populate all “R” elements with a nonempty value. Conforming receiving application shall process
(save/print/archive/etc.) or ignore the information conveyed by required
elements. A conforming receiving application shall 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.
Any element designated as required in a standard HL7 message definition
shall also be required in all HL7 message profiles based on that standard
message.
The element may be missing from the message, but shall be sent by the
sending application if there is relevant data to report. A conforming sending
application shall be capable of providing all "RE" elements. If the conforming
sending application knows the required values for the element, then it shall
send that element. If the conforming sending application does not know the
required values, then that element will be omitted.
Receiving applications will be expected to process (save/print/archive/etc.)
or ignore data contained in the element, but shall be able to successfully
process the message if the element is omitted (no error message should be
generated because the element is missing).
For conformant sending applications, the element shall not be sent.
Conformant receiving applications shall ignore the element if it is sent.
However, the receiving application will not raise an application error if it
receives the element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 25
© 2012 Health Level Seven International. All rights reserved.
4.1 DBC - CREATE DONOR RECORD MESSAGE (EVENT O41)
The Create Donor Record messages contain information to create a new donor book of record.
TABLE 4-2 – DBC^O41 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message. This includes
identification of message delimiters, sender, receiver, message type,
timestamp, etc.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
PID
PATIENT - Donor Begin
Patient Identification – Donor
Identification
R
[1..1]
5.6
[PD1]
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor. The subject must be a person
(no animals).
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
[
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
PATIENT – Donor End
Page 26
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.2 DBU - UPDATE DONOR RECORD MESSAGE (EVENT O42)
The Update Donor Record messages contain information to update an existing donor book of record.
TABLE 4-3 – DBU^O42 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
[
PID
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
PATIENT – Donor End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 27
© 2012 Health Level Seven International. All rights reserved.
4.3 QBP - GET DONOR RECORD CANDIDATES (EVENT Q33)
This query/response is designed for interaction between a registration system and the system which contains the Donor Book of Record. The query consists of
query parameters which assist in determining if the Donor already has a record in the Donor Book or Record system. The query parameters are minimal and
number of elements returned in the query response for each candidate is minimal.
TABLE 4-4 – QBP QUERY INFORMATION
Query Statement ID:
Q33
Query Type:
Query by Parameter
Query Name:
GetDonorRecordCandidates
Query Trigger:
QBP^Q33^QBP_Q33
Query Mode:
Immediate
Response Trigger:
RSP^K33^RSP_K33
Query Characteristics
Purpose:
Query is used to find if a donor record exists on the Donor
Book of Record system. A few, basic, demographic
paramters are provided. The return are a set of records
which meet the parameter criteria. The intent is to ‘select’
one of the returned candidate records, then run the Get
Donor Record query to return the detail for that specific
donor.
Returns minimal information for set of donor records
TABLE 4-5 – QBP^Q33 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
QPD
Query Parameter Definition Segment
R
[1..1]
5.16
For communicating query parameters
RCP
Response Control Parameters
R
[1..1]
5.15
For communicating response control parameters
Page 28
© 2012 Health Level Seven International. All rights reserved.
Usage
R
Cardinality
[1..1]
Section
5.3
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.4 RSP - GET DONOR RECORD CANDIDATES RESPONSE (EVENT K33)
TABLE 4-6 – RSP^K33 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
MSA
Message Acknowledgement
R
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
The message scknowledgement segment acknowledges a specific
message (by id)
Any errors during processing
QAK
Query Acknowldgement
R
[1..1]
5.18
Query acknowledgement
QPD
Query Paremeter Definition
R
[1..1]
5.16
Return the query parameters used for selection in this return set.
PATIENT - Donor Begin
Patient Identification – Donor
Identification
PATIENT – Donor End
R
[1..1000]
R
[1..1]
[
PID
]
Usage
R
Cardinality
[1..1]
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Page 29
© 2012 Health Level Seven International. All rights reserved.
4.5 QBP - GET DONOR RECORD (EVENT Q34)
This query/response is designed for interaction between a viewing system and the system which contains the Donor Book of Record. The query consists of query
parameters, and the response of the demographics for that donor.
TABLE 4-7 – QBP QUERY INFORMATION
Query Statement ID:
Q34
Query Type:
Query by Parameter
Query Name:
GetDonorRecord
Query Trigger:
QBP^Q34^QBP_Q34
Query Mode:
Immediate
Response Trigger:
RSP^K34^RSP_K34
Query Characteristics
Uses donor id to find a specific donor record and return it.
Purpose:
Returns demographic information and donations for a donor
TABLE 4-8 – QBP^Q34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
Usage
R
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
QPD
Query Parameter Definition Segment
R
[1..1]
5.17
For communicating query parameters
RCP
Response Control Parameters
R
[1..1]
5.15
For communicating response control parameters
Page 30
© 2012 Health Level Seven International. All rights reserved.
Cardinality
[1..1]
Section
5.3
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.6 RSP - GET DONOR RECORD RESPONSE (EVENT K34)
TABLE 4-9 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
MSA
Message Acknowledgement
R
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
The message scknowledgement segment acknowledges a specific
message (by id)
Any errors during processing
QAK
Query Acknowldgement
R
[1..1]
5.18
Query acknowledgement
QPD
Query Paremeter Definition
R
[1..1]
5.16
Return the query parameters used for selection in this return set.
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
VISIT Donor Registration Begin
Patient Visit – Donor Registration
RE
[0..1000]
R
[1..1]
5.8
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
RE
[0..1000]
[
PID
[{
PV1
[{NTE}]
}]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
[{
Donation Begin
[{DON}]
Donation
RE
[0..1]
5.13
Donation procedure
[{OBX}]
Donation Adverse Reaction
Observations
RE
[0..100]
5.10
Adverse Reaction Observations during the Donation procedure.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 31
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-9 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
[{NTE}]
}]
Name
Notes and Comments for Donation
Usage
RE
Cardinality
[0..100]
Section
5.12
Description
Donation procedure notes and comments
Donation End
Page 32
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.7 DRG - DONOR REGISTRATION (EVENT O43)
The Donor Registration messages contain information to register a donor for a donation.
TABLE 4-10 – DRG^O43 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
Donor Registration-level notes and comments
PATIENT – Donor End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 33
© 2012 Health Level Seven International. All rights reserved.
4.8 DER - DONOR ELIGIBILITY REQUEST (EVENT O44)
The Donor Registration messages contain minimal information about a donor registration.
TABLE 4-11 – DER^O44 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Donor Registration
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
R
[1..100]
Observations Request
R
[1..1]
5.9
Each order group is a question or an indication to perform a miniphysical.
The question or mini-physical request
Notes and Comments for OBR
RE
[0..100]
5.12
Any notes about the question or mini-physical
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
{
ORDER_OBSERVATION Begin
OBR
[{NTE}]
}
ORDER_OBSERVATION End
Page 34
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.9 DEO - DONOR ELIGIBILITY OBSERVATIONS (EVENT O45)
Communicate both mini-physical observations and questions and answers from a donor questionnaire. Note that this message type is a specific sub-set of
the full OUL (Unsolicited Lab Result) Message. The intent is to provide for a smaller message for implementation by blood banking donation
service systems which does not contain all the information necessary for a full laboratory result. This message type should be used only when
specimen information can safely be ignored (measure of HgB via test kit with no actual specimen drawn rather a skin prick is used by the device).
If a lab result can only be safely and appropriately understood if that result contains full information (e.g. specimen), then the OUL message type
should be used and not this DEO – Donor Eligibility Observation message type.
TABLE 4-12 – DEO^O45 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
PATIENT - Donor Begin
Patient Identification – Donor
Identification
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
R
[1..1]
RE
[0..1]
R
[1..1]
5.8
RE
[0..100]
5.12
Donor Registration-level notes and comments
R
[1..100]
Observations Request
R
[1..1]
5.9
Each order group is a question & answer pair or mini-physical
assessment.
The question or mini-physical observation requests
Notes and Comments for OBR
RE
[0..100]
5.12
Any notes about the question or mini-physical observation requests
R
[1..1]
OBX
OBSERVATION Begin
Observations
R
[1..1]
5.10
The answer or mini-physical observation
[{NTE}]
Notes and Comments
RE
[0..100]
5.12
Notes or comments about the answer or mini-physical assessment
[
PID
[
PV1
[{NTE}]
]
]
Notes and Comments for Donor
Registration
VISIT Donor Registration End
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
The visit group may be empty in this message type.
PATIENT – Donor End
{
ORDER_OBSERVATION Begin
OBR
[{NTE}]
[{
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
The answer group or mini-physical assessment
Page 35
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-12 – DEO^O45 ABSTRACT MESSAGE SYNTAX
Segment
}]
}
Name
Usage
Cardinality
Section
Description
OBSERVATION End
ORDER_ OBSERVATION End
Page 36
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.10 DEL - DONOR ELIGIBILITY (EVENT O46)
Use this segment to communicate a donor’s eligibility to donate.
TABLE 4-13 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
[DON]
PATIENT – Donor End
Donation
RE
[0..1]
5.13
Donation procedure
[{NTE}]
Notes and Comments for Donation
RE
[0..100]
5.12
Donation procedure notes and comments
[
PID
[
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
VISIT Donor Registration End
]
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 37
© 2012 Health Level Seven International. All rights reserved.
4.11 DRC - DONOR REQUEST TO COLLECT (EVENT O47)
Used to communicate to a collection system that the donor is eligible and collection can begin.
TABLE 4-14 – DRC^O47 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
R
[1..1]
5.6
[PD1]
PATIENT - Donor Begin
Patient Identification – Donor
Identification
Additional Demographics
RE
[0..1]
5.7
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
Donor-level additional demographics
[{OBX}]
Donor Observations
RE
[0..100]
5.10
Donor-level observations which includes any medications
[{NTE}]
Notes and Comments for Donor
RE
[0..100]
5.12
Donor-level notes and comments
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
Donor Registration
Notes and Comments for Donor
Registration
VISIT Donor Registration End
RE
[0..100]
5.12
Donor Registration-level notes and comments
ORDER_OBSERVATION Begin
Observation Request
R
[1..1]
R
[1..1]
5.9
The request to collect
Notes and Comments for Request
RE
[0..100]
5.12
Any notes about the request to collect
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
The visit group may be empty in this message type.
PATIENT – Donor End
{
OBR
[{NTE}]
}
Request to collect group
ORDER_OBSERVATION End
Page 38
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.12 DPR - DONATION PROCEDURE (EVENT O48)
This segment contains information from the blood unit collection procedure from the donor. The Donation Segment is repeating. If there is more than one stick,
there will be a separate DON segment for each stick.
TABLE 4-15 – DPR^O48 ABSTRACT MESSAGE SYNTAX
Segment
MSH
Message Header
[{SFT}]
Software Segment
X
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
User Authentication Credential
X
Not Supported
R
[1..1]
PID
PATIENT - Donor Begin
Patient Identification – Donor Identification
R
[1..1]
RE
[0..1]
PV1
VISIT Donor Registration Begin
Patient Visit – Donor Registration
R
[1..1]
5.8
[{NTE}]
Notes and Comments for Donor Registration
RE
[0..100]
5.12
ORDER_OBSERVATION Begin
Observations Request
R
[1..100]
R
[1..1]
5.9
The request to collect
Notes and Comments for Request
RE
[0..100]
5.12
Any notes about the request to collect
RE
[0..10]
[
[
Name
]
VISIT Donor Registration End
]
PATIENT – Donor End
{
OBR
[{NTE}]
[{
Donation Begin
Usage
R
Cardinality
[1..1]
Section
5.3
The donor group must be populated in this message type.
5.6
The patient identification (PID) segment is used to provide basic
demographics regarding the donor.
The visit group may be empty in this message type.
Donor Registration-level notes and comments
Request to collect group
One donation group per stick
[{DON}]
Donation
R
[1..1]
5.13
Donation procedure
[{OBX}]
Donation Observations and Adverse Events
RE
[0..100]
5.10
Donation observations
[{NTE}]
Notes and Comments for Donation
RE
[0..10]
5.12
Donation procedure notes and comments
[{
R
[1..10]
[{BUI}]
Blood Unit Begin
Blood Unit Information
R
[1..1]
5.14
Blood Unit Information
[{NTE}]
Notes and Comments for Blood Unit
RE
[0..100]
5.12
Blood Unit Information notes and comments
}]
Blood Unit End
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Group must contain at least one blood unit segment
Page 39
© 2012 Health Level Seven International. All rights reserved.
TABLE 4-15 – DPR^O48 ABSTRACT MESSAGE SYNTAX
Segment
}]
Name
Usage
Cardinality
Section
Description
Donation End
Page 40
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
4.13 ACK – ACKNOWLEDGEMENT
TABLE 4-16 – ACK^XXX^ACK ABSTRACT MESSAGE SYNTAX
Segment
MSH
Name
Message Header
Usage
R
Cardinality
Section
Description
[1..1]
5.3
The Message Header (MSH) segment contains information
describing how to parse and process the message.
[0..0]
Not Supported
[{SFT}]
Software Segment
X
MSA
Message Acknowledgement
R
[1..1]
5.4
Message Acknowledgement
[{ ERR }]
Error
C
[0..100]
5.5
Required when MSA-1 is not "AA" or "CA."
Note: XXX above is replaced with the appropriate event code (O41, O42, etc.)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 41
© 2012 Health Level Seven International. All rights reserved.
5 SEGMENT AND FIELD DESCRIPTIONS
This messaging guide provides notes for supported fields. The following format is used in this document for listing and defining message
segments and fields. First, the message segment’s use is defined, and a segment attribute table listing all fields defined in the segment is shown.
5.1
SEGMENT ATTRIBUTE TABLE ABBREVIATIONS
The following sections detail the structure of each segment attribute, including field length, data type, usage, cardinality, value set and description.
The table below details the abbreviated terms used in the segment attribute tables, as well as the definitions associated with those abbreviations.
TABLE 5-1 – SEGMENT ATTRIBUTES
Seq
Abbreviation
Len
DT
Usage
Definition
Sequence of the elements as numbered in the HL7 segment.
Maximum length of the element. Lengths are provided only for atomic data types.
Lengths should be considered recommendations, not absolutes. The receiver can truncate fields, components, and sub-components that are longer
than the recommended length. The receiver should continue to process a message even when a field, component, or sub-component length exceeds
the maximum recommended length identified in this specification.
Data type used by this profile for HL7 element.
Usage of the field for this profile. Indicates if the field, component, or subcomponent is required, optional, or conditional in the corresponding
segment, field, or component. Legal values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• O – Optional. May optionally be populated.
• C – Conditional. Populated under specified conditions.
• CE – Conditional, but can be empty.
• X – Not used for this profile.
Note: A required field in an optional segment does not mean the segment must be present in the message. Rather, if the segment
is present, the required fields within that segment must be populated. This convention applies to required components of optional
fields. If the field is populated, then the required components must be populated. The convention applies to required subcomponents of optional components, as well. If a component is populated, then the required sub-components of that component
must be populated.
Page 42
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-1 – SEGMENT ATTRIBUTES
Abbreviation
Cardinality
Value Set
Note: Where a table constraint is indicated, or where HL7 Version 2.6 standards are adopted, the constrained or specified HL7
table is included below the segment table.
HL7 Element Name
Description/Comments
5.2
Definition
Indicator of the minimum and maximum number of times the element may appear.
• [0..0] Element never present.
• [0..1] Element may be omitted and it can have at most one occurrence.
• [1..1] Element must have exactly one occurrence.
• [0..n] Element may be omitted or may repeat up to n times.
• [1..n] Element must appear at least once, and may repeat up to n times.
• [0..*] Element may be omitted or repeat for an unlimited number of times.
• [1..*] Element must appear at least once, and may repeat unlimited number of times.
• [m..n] Element must appear at least m, and at most, n times.
The set of coded values to be used with the field.
HL7 descriptor of the element in the segment.
Context and usage for the element.
SEGMENT USAGE DEFINITIONS
TABLE 5 -2 – SEGMENT USAGE DEFINITIONS
R
Value
RE
Required
Description
Required but may be empty
Comment
A conforming sending application shall populate all “R” elements with a non-empty value. Conforming receiving
application shall process the information conveyed by required elements. A conforming receiving application must not
raise an error due to the presence of a required element, but must raise an error due to the absence of a required
element.
Any element designated as required in a standard HL7 message definition shall also be required in all HL7 message
profiles of that standard message.
The element 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" elements. If the conforming sending application
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 that element will be omitted.
Receiving applications will be expected to process (save/print/archive/etc.) data contained in the element, but must be
able to successfully process the message if the element is omitted (no error message should be generated because the
element is missing).
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 43
© 2012 Health Level Seven International. All rights reserved.
TABLE 5 -2 – SEGMENT USAGE DEFINITIONS
O
Optional
C
Conditional
X
Not supported
5.3
Sending applications may populate this field, but they are not required to do so per this specification. If the sending
application populates the field, the value must conform to all specifications for the field in the HL7 v2.6 standard.
Sending applications should not expect conformant receiving applications to process data sent in this field.
Receiving applications may process data received in this field, but they are not required to do so per this specification.
Receiving applications should not expect the field to be populated by conformant sending applications.
This usage has an associated condition predicate, which can be evaluated based on the values of other data elements in
the same message.
If the predicate is satisfied:
A conformant sending application must always send the element. A conformant receiving application must process or
ignore data in the element. It may raise an error if the element is not present.
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 condition
predicate is false and the element IS present.
For conformant sending applications, the element will not be sent. Conformant receiving applications may ignore the
element if it is sent, or may raise an application error.
MSH – MESSAGE HEADER SEGMENT
The Message Header Segment (MSH) contains information describing how to parse and process the message. This includes identification of
message delimiters, sender, receiver, message type, timestamp, etc.
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Usage
R
Cardinality
[1..1]
ST
R
[1..1]
3
HD
RE
[0..1]
4
HD
R
[1..1]
1
Seq
2
1
4
Len
DT
ST
Page 44
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Description/Comments
Field Separator
Character to be used as the field separator for the rest of the
message.
Literal value: ‘|’ [ASCII (124)].
Encoding Characters
Four characters, always appearing in the same order: |^~\&|.
Literal value: ‘^~\&’.
Sending Application
Field that may be used to identify the sending application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the sending application instance.
Sending Facility
Field that uniquely identifies the facility that sends the message. If
populated, it will contain an OID that represents the sending facility.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
5
Seq
Len
DT
HD
Usage
RE
Cardinality
[0..1]
6
HD
RE
[0..1]
7
DTM
R
[1..1]
8
9
10
ST
MSG
ST
X
R
R
[0..0]
[1..1]
[1..1]
11
PT
R
[1..1]
12
VID
R
[1..1]
13
14
15
NM
ST
ID
X
X
X
[0..0]
[0..0]
[0..0]
ID
CE
[0..1]
17
18
19
ID
ID
CWE
X
X
X
[0..0]
[0..0]
[0..0]
20
ID
X
[0..0]
16
25
2
Value Set
HL70155
HL7 Element Name
Description/Comments
Receiving Application
Field that may be used to identify the receiving application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the receiving application instance.
Receiving Facility
Field that uniquely identifies the facility that is to receive the
message. If populated, it will contain an OID that represents the
receiving facility.
Date/Time Of Message
Field containing the date/time the message was created by the
sending system. Format: YYYYMMDDHHMMSS[.S[S[S[S]]]]+/ZZZZ. Note that the time zone offset is required, and the minimum
granularity is to the second, although more precise time stamps are
allowed.
Security
Not supported
Message Type
See table for each message type.
Message Control ID
String that uniquely identifies the message instance from the
sending application.
Processing ID
Field that may be used to indicate the intent for processing the
message, such as "Testing," "Development," or "Production." For
this message, the field will be fixed to the value ”P”.
Version ID
HL7 version number used to interpret format and content of the
message. For this message, the version ID will always be 2.5.1
Sequence Number
Not supported
Continuation Pointer
Not supported
Accept Acknowledgment Not supported
Type
Application
Condition Rule: Shall be populated with a value from HL7 table
Acknowledgment Type
0155 for the Response message.
Country Code
Not supported
Character Set
Not supported
Principal Language Of
Not supported
Message
Alternate Character Set Not supported
Handling Scheme
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 45
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Seq
21
5.4
Len
DT
EI
Usage
R
Cardinality
[1..10]
Value Set
HL7 Element Name
Description/Comments
Message Profile Identifier Field used to reference or assert adherence to a message profile.
Message profiles contain detailed explanations of grammar, syntax,
and usage for a particular message or set of messages. This field is
allowed to repeat. The profile ID for the profile defined in this guide
should appear as a Repeat. Other profile IDs may appear in the
field, as well, in cases where more constrained profiles are created
from this profile. An OID for this profile is available once it is
assigned. The OID appearing as the literal value is an example OID
only.
Literal Value: USBBDon^^2.16.840.1.113883.19.9.7^ISO
MSA – ACKNOWLEDGEMENT SEGMENT
The Message Response Segment (MSA) contains the information sent as acknowledgment to the order message received by a Laboratory
Information System.
TABLE 5-4 – ACKNOWLEDGEMENT SEGMENT (MSA)
Usage
R
Cardinality
[1..1]
ST
R
[1..1]
3
4
ST
NM
X
X
[0..0]
[0..0]
5
ID
X
[0..0]
6
CWE
X
[0..0]
1
Seq
2
2
Len
25
DT
ID
Page 46
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL70008
HL7 Element Name
Description/Comments
Acknowledgment Code Acknowledgment code indicating receipt of message. (Refer to HL7
Table 0008 - Acknowledgment code for valid values.)
Message Control ID
Identifier that enables the sending system to associate this response
with the message for which it is intended. This value will be the
MSH.10 message control ID from the message being acknowledged.
Text Message
Not Supported
Expected Sequence
Not Supported
Number
Delayed
Not Supported
Acknowledgment Type
Error Condition
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.5
ERR – ERROR SEGMENT
The ERR segment is used to add error comments to acknowledgment messages.
TABLE 5-5 – ERROR SEGMENT (ERR)
1
2
3
4
Seq
Len
1
5
6
7
65536
8
9
10
11
12
DT
ELD
ERL
CWE
ID
Usage
X
X
R
R
Cardinality
[0..0]
[0..0]
[1..1]
[1..1]
CWE
ST
X
X
[0..0]
[0..0]
TX
R
[1..1]
TX
IS
CWE
CWE
XTN
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL70357
HL70516
HL7 Element Name
Error Code and Location
Error Location
HL7 Error Code
Severity
Application Error Code
Application Error
Parameter
Diagnostic Information
Not Supported
Not Supported
Identifies the HL7 (communications) error code.
Identifies the severity of an application error. Knowing if something is
Error, Warning or Information is intrinsic to how an application
handles the content.
Not Supported
Not Supported
Information that may be used by help desk or other support
personnel to diagnose a problem.
User Message
Not supported
Inform Person Indicator Not supported
Override Type
Not supported
Override Reason Code
Not supported
Help Desk Contact Point Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Page 47
© 2012 Health Level Seven International. All rights reserved.
5.6
PID – PATIENT IDENTIFICATION SEGMENT
The Patient Identification Segment (PID) is used to provide basic demographics regarding the donor. The subject must be a person (no animals).
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID – PID
2
3
CX
CX
X
R
[0..0]
[1..4]
Patient ID
Patient Identifier List
4
5
CX
XPN
X
R
[0..0]
[1..4]
Alternate Patient ID – PID
Patient Name – Donor Name
6
XPN
RE
[0..1]
Mother’s Maiden Name
Page 48
© 2012 Health Level Seven International. All rights reserved.
Description/Comments
For the first repeat of the PID segment, the sequence
number shall be one (1), for the second repeat, the
sequence number shall be two (2), etc.
Not supported
Field used to convey all types of patient/person
identifiers. This includes social security numbers,
driver’s license numbers, medical record numbers, etc.
The following donor identifiers are supported in this IG:
a. Donor #
b. National ID (SSN etc.)
c. Legacy ID # (Donor # from a previous blood bank
system)
d. Legacy ID # 2nd (Donor # from a previous blood
bank system)
Not supported
Donor name or aliases. When the name of the donor is
not known, a value must still be placed in this field since
the field is required. In that case, HL7 recommends the
following: |~^^^^^^U|. The "U" for the name type code
in the second name indicates that it is unspecified.
Since there may be no name components populated,
this means there is no legal name, nor is there an alias.
This guide will interpret this sequence to mean there is
no donor name.
The following donor names are supported in this IG:
Donor Name
Nickname
Maiden Name
Previous Name????
May be included for identification purposes. Name type
code is constrained to the value "M."
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
DT
TS
Usage
RE
Cardinality
[0..1]
Value Set
IS
XPN
CWE
RE
X
RE
[0..1]
[0..0]
[0..1]
HL70001
11
XAD
RE
[0..2]
Patient Address
12
13
IS
XTN
X
RE
[0..0]
[0..2]
County Code
Phone Number – Home
14
15
16
17
18
19
20
21
22
23
24
25
26
27
XTN
CWE
CWE
CWE
CX
ST
DLN
CX
CWE
ST
ID
NM
CWE
CWE
RE
X
X
X
X
X
X
X
RE
X
X
X
X
RE
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
Phone Number – Business
Primary Language
Marital Status
Religion
Patient Account Number
SSN Number – Patient
Driver’s License Number – Patient
Mother’s Identifier
Ethnic Group
Birth Place
Multiple Birth Indicator
Birth Order
Citizenship
Veterans Military Status
28
29
30
31
32
33
CWE
TS
ID
ID
IS
TS
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
7
Seq
8
9
10
Len
20
HL70005
HL70189
HL70172
HL7 Element Name
Date/Time of Birth
Administrative Sex
Patient Alias
Race
Nationality
Patient Death Date and Time
Patient Death Indicator
Identity Unknown Indicator
Identity Reliability Code
Last Update Date/Time
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Donor’s date of birth. The time component is not
supported in this IG.
Donor’s gender.
Not supported
One or more codes that broadly refer to the donor’s
race(s).
Donor’s addresses. This IG supports only two
addresses: home and work/business
Not supported
This IG supports only two ‘personal’ phone numbers;
Home and Mobile.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Field is meant for military status (active, retired, etc).
Empty field = non-military donor
“A”ctive only = military donor on active duty. Field
should either contain an “A” or be null.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 49
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
Seq
34
35
36
37
38
39
5.7
Len
DT
HD
CWE
CWE
ST
CWE
CWE
Usage
X
X
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL7 Element Name
Last Update Facility
Species Code
Breed Code
Strain
Species Code
Tribal Citizenship
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
PD1 – PATIENT ADDITIONAL DEMOGRAPHIC
This segment contains additional donor demographic information.
TABLE 5-7 – PATIENT ADDITIONAL DEMOGRAPHIC (PD1)
Seq
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Len
DT
IS
IS
XON
XCN
IS
IS
IS
IS
ID
CX
CWE
ID
Usage
X
X
RE
X
X
X
X
X
X
X
X
RE
Cardinality
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
DT
XON
CWE
IS
DT
DT
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Page 50
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL70136
HL7 Element Name
Living Dependency
Living Arrangement
Patient Primary Facility – Usual Collection Location
Patient Primary Care Provider Name & ID No.
Student Indicator
Handicap
Living Will Code
Organ Donor Code
Separate Bill
Duplicate Patient
Publicity Code
Protection Indicator – Notifiable Donor
Protection Indicator Effective Date
Place of Worship
Advance Directive Code
Immunization Registry Status
Immunization Registry Status Effective Date
Publicity Code Effective Date
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
“Y” Donor is notifiable
“N” Not notifiable
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-7 – PATIENT ADDITIONAL DEMOGRAPHIC (PD1)
Seq
19
20
21
22
Len
5.8
DT
IS
IS
IS
DT
Usage
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
HL7 Element Name
Military Branch
Military Rank/Grade
Military Status
Advance Directive Last Verified Date
Description/Comments
Not supported
Not supported
Not supported
Not supported
PV1 – PATIENT VISIT INFORMATION
This segment contains basic inpatient or outpatient encounter information.
TABLE 5-8 – PATIENT VISIT INFORMATION (PV1)
Seq
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Len
4
20
20
DT
SI
IS
PL
CWE
CX
PL
XCN
XCN
XCN
IS
PL
IS
IS
IS
IS
IS
XCN
IS
CX
FC
Usage
X
R
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
X
Cardinality
[0..0]
[1..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
Value Set
HL70004
HL7 Element Name
Set ID - PV1
Patient Class
Assigned Patient Location
Admission Type
Preadmit Number
Prior Patient Location
Attending Doctor
Referring Doctor
Consulting Doctor
Hospital Service
Temporary Location
Preadmit Test Indicator
Re-admission Indicator
Admit Source
Ambulatory Status
VIP Indicator
Admitting Doctor
Patient Type
Visit Number
Financial Class
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Not supported
Use a fixed value of “N” for “Not applicable”.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Number assigned for each donation ‘visit’ or registration.
Not supported
Page 51
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-8 – PATIENT VISIT INFORMATION (PV1)
Seq
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Len
DT
IS
IS
IS
IS
DT
NM
NM
IS
IS
DT
IS
NM
NM
IS
DT
IS
DLD
CWE
IS
IS
IS
PL
PL
DTM
TS
NM
NM
NM
NM
CX
IS
XCN
Usage
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
X
X
X
X
X
RE
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
[0..0]
[0..0]
Page 52
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Charge Price Indicator
Courtesy Code
Credit Rating
Contract Code
Contract Effective Date
Contract Amount
Contract Period
Interest Code
Transfer to Bad Debt Code
Transfer to Bad Debt Date
Bad Debt Agency Code
Bad Debt Transfer Amount
Bad Debt Recovery Amount
Delete Account Indicator
Delete Account Date
Discharge Disposition
Discharged to Location
Diet Type
Servicing Facility
Bed Status
Account Status
Pending Location
Prior Temporary Location
Admit Date/Time
Discharge Date/Time
Current Patient Balance
Total Charges
Total Adjustments
Total Payments
Alternate Visit ID – Drive ID
Visit Indicator
Other Healthcare Provider
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Date and time donor registered
Not supported
Not supported
Not supported
Not supported
Not supported
Donation Drive Identifier
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.9 OBR – OBSERVATION REQUEST SEGMENT
The Observation Request Segment (OBR) is used to capture information about:
1. The donation service requested to be performed
2. Questions in a questionnaire (the answers are in an associated OBX)
3. Assessments being performed for a mini-physical
the donation service to be performed, the questions .
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID - OBR
2
EI
RE
[0..1]
Placer Order Number
3
EI
R
[1..1]
Filler Order Number
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Sequence number of one of multiple OBRs under one
PID. For the first order transmitted, the Set ID shall be 1;
for the second OBR, this element is valued 2; and so on.
This identifier is assigned by the placer of the order. This
identifier distinguishes the placer’s order from all other
orders created by the placer where an order is
interpreted to be the testing identified in a single OBR
segment. Normally, it is a type of system identifier
assigned by the placer software application.
The Placer Order Number and the Filler Order Number
are essentially foreign keys exchanged between
applications for uniquely identifying orders and the
associated results across applications.
Order number associated with the Filling Application.
This number is assigned to the test by the organization
performing the test. The Filler Order Number identifies
this order as distinct from all other orders being
processed by this filler where an order is interpreted to
be the testing identified in a single OBR segment..
Normally, this is a type of system identifier assigned by
the filler software application.
The Filler Order Number, along with the Placer Order
Number, are essentially foreign keys exchanged between
applications for uniquely identifying orders and the
associated results across applications.
In messages containing multiple OBRs, each OBR must
be identified by a unique Filler Order Number.
Page 53
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
DT
CWE
Usage
R
Cardinality
[1..1]
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
ID
TS
TS
TS
CQ
XCN
ID
CWE
ST
TS
SPS
XCN
XTN
ST
ST
ST
ST
DTM
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
RE
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..1]
Priority – OBR
Requested Date/Time
Observation Date/Time
Observation End Date/Time
Collection Volume
Collector Identifier
Specimen Action Code
Danger Code
Relevant Clinical Information
Specimen Received Date/Time
Specimen Source
Ordering Provider
Order Callback Phone Number
Placer Field 1
Placer Field 2
Filler Field 1
Filler Field 2
Results Rpt/Status Chng - Date/Time
23
24
25
26
27
28
29
30
31
32
MOC
ID
ID
PRL
TQ
XCN
EIP
ID
CWE
NDL
X
X
X
X
X
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..*]
[0..0]
Charge to Practice
Diagnostic Serv Sect ID
Result Status
Parent Result
Quantity/Timing
Result Copies To
Parent
Transportation Mode
Reason for Study
Principal Result Interpreter
4
Seq
Len
Page 54
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Universal Service Identifier
Description/Comments
Identifier code for the requested observation/test/
battery/donation. This IG does not recommend a specific
coding system at this time.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
For requests or the sending of questionnaire questions,
this field is empty. For answers, mini-physical
observations and assessments, this field contains the
same information as OBX-14.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
DT
NDL
NDL
NDL
TS
NM
CWE
CWE
CWE
ID
ID
CWE
CWE
CWE
CWE
Usage
X
O
X
X
X
X
X
X
X
X
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
47
48
CWE
CWE
X
X
[0..0]
[0..0]
49
50
IS
CWE
X
X
[0..0]
[0..0]
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Seq
Len
Value Set
HL7 Element Name
Assistant Result Interpreter
Technician
Transcriptionist
Scheduled Date/Time
Number of Sample Containers
Transport Logistics of Collected Sample
Collector's Comment
Transport Arrangement Responsibility
Transport Arranged
Escort Required
Planned Patient Transport Comment
Procedure Code
Procedure Code Modifier
Placer Supplemental Service
Information
Filler Supplemental Service Information
Medically Necessary Duplicate
Procedure Reason
Result Handling
Parent Universal Service Identifier
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 55
© 2012 Health Level Seven International. All rights reserved.
5.10 OBX – OBSERVATION RESULT SEGMENT (QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for mini-physical
observations and assessments and questionnaire answers. For sending lab results using this segment, see Section 4.9 – DEO – Donor Eligibility
Observation message type for more information.
TABLE 5-10 –OBSERVATION/RESULT SEGMENT (OBX) - QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
HL7 Element Name
Set ID – OBX
2
3
3
ID
CWE
R
R
[1..1]
[1..1]
4
10
ST
C
[0..1]
Observation Sub-ID
5
Var
R
[1..1]
Observation Value
6
CWE
CE
[0..1]
Units
7
8
9
10
11
ST
IS
NM
ID
ID
X
X
X
X
R
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Page 56
© 2012 Health Level Seven International. All rights reserved.
HL70085
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR. Where possible
for lab results, the LOINC code system is recommended.
Required if there is more than one OBX with the same OBX-3
(Observation Identifier) associated with the same OBR.
Normally, this field is populated with a number, but text values
may also be used.
Field that documents each specific value (answer, assessment,
etc.)
Required if the results have units. UCUM® is an HL7-approved
code system, and shall be used for units as described in the
appropriate HITSP Interoperability Specification. If a numeric
value has no units of measure, the CWE data type allows an
"NA" (Not Applicable) from HL70353 as the Identifier
component.
Conditional statement: If the data type in OBX 2 is "NM" or "SN,"
this field is required.
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 –OBSERVATION/RESULT SEGMENT (OBX) - QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL
Seq
12
Len
DT
TS
Usage
X
Cardinality
[0..0]
13
14
ST
DTM
X
RE
[0..0]
[0..1]
15
16
CWE
XCN
X
RE
[0..0]
[0..1]
17
18
19
20
21
CWE
EI
TS
CWE
EI
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
22
23
CNE
XON
X
X
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Description/Comments
Effective Date of Reference
Not supported
Range
User-Defined Access Checks Not supported
Date/Time of the Observation Date and time of the observation (for one example, time the
question was answered)
Producer’s Reference
Not supported
Responsible Observer
For questions and answers, the staff person conducting the
interview. Use the value of “donor” to indicate that the donor
filled out the questionnaire without staff assistance.
Observation Method
Not supported
Equipment Instance Identifier Not supported
Date/Time of the Analysis
Not supported
Observation Site
Not supported
Observation Instance
Not supported
Identifier
Mood Code
Not supported
Performing Organization
Not supported
Name
Performing Organization
Not supported
Address
Performing Organization
Not supported
Medical Director
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 57
© 2012 Health Level Seven International. All rights reserved.
5.11 OBX – OBSERVATION RESULT SEGMENT (DONOR)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used to donor-level
observations.
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX) - DONOR
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
ID
CWE
R
R
[1..1]
[1..1]
HL70125
4
5
ST
Var
X
R
[0..0]
[1..1]
Observation Sub-ID
Observation Value
6
7
8
9
10
11
12
CWE
ST
IS
NM
ID
ID
TS
R
X
X
X
X
R
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
[0..0]
13
14
15
16
17
18
19
20
21
ST
DTM
CWE
XCN
CWE
EI
TS
CWE
EI
X
RE
X
RE
X
X
X
X
X
[0..0]
[0..1]
[0..0]
[0..1]
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
Units
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Effective Date of Reference
Range
User-Defined Access Checks
Date/Time of the Observation
Producer’s Reference
Responsible Observer
Observation Method
Equipment Instance Identifier
Date/Time of the Analysis
Observation Site
Observation Instance
Identifier
1
Seq
2
3
4
3
Len
Page 58
© 2012 Health Level Seven International. All rights reserved.
HL70085
HL7 Element Name
Set ID – OBX
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR.
Not supported
Field that documents each specific value (answer, assessment,
etc.)
Not supported
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
Not supported
Not supported
Date and time of the observation
Not supported
The staff person gathering the information from the donor.
Not supported
Not supported
Not supported
Not supported
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX) - DONOR
Seq
22
23
Len
DT
CNE
XON
Usage
X
X
Cardinality
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Mood Code
Performing Organization
Name
Performing Organization
Address
Performing Organization
Medical Director
Not supported
Not supported
Description/Comments
Not supported
Not supported
5.12 OBX - OBSERVATION IDENTIFIERS (DONOR)
The following observation identifiers are used in OBX-3 to communicate the type of donor observation associated with the donation procedure.
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
882-1
DEGRE
OCCUP
JTITL
EMPLY
EMPPH
NODO
FIRDO
NOLDO
AWARD
AWADE
YRDO
UPROC
DPROC
LASDD
LASDF
DMED
Description
Blood Type Indicator ABORH
Academic Degree
Occupation
Job Title
Employer
Employer's Phone #
# of Legacy Donations
First Donation Date
# of Lifetime Donations
Award Code
Award Description
Total Yearly Donations
Usual Procedure Type
Undesired Procedure Type
Last Donation Date
Last Donation Facility (Location)
Donor has recently taken a substance
OBX-2 DT
CNE
ST
ST
ST
ST
TN
NM
DT
NM
ST
ST
NM
CWE
CWE
DT
ST
ID
Comment
From LOINC (LN) Code System where possible.
Y/N
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 59
© 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
Description
(drug) on the list of products which
automatically cause a donation deferral.
OBX-2 DT
DMEDN
Medication which caused a donation
deferral
CWE
DMEDC
Condition for which the deferral
medication is being taken
CWE
DMEDO
DMEDD
OMED
Is Medication which caused a donation
deferral ongoing
Date of last dose of deferral medication
Is the donor taking any non-deferral
medications?
ID
DTM
ID
OMEDN
Any other medications (not on the
deferral list) which the donor is taking
CWE
OMEDC
Condition for which the other
medication is being taken
CWE
OMEDO
Is other medication ongoing
ID
Page 60
© 2012 Health Level Seven International. All rights reserved.
Comment
See document at link below for the list of medication which cause
a blood donation deferral:
http://www.aabb.org/resources/donation/questionnaires/Document
s/dhq/v1-3/MedicationDeferralListv1.3.pdf
http://www.fda.gov/downloads/BiologicsBloodVaccines/BloodBlood
Products/ApprovedProducts/LicensedProductsBLAs/BloodDonorS
creening/UCM213553.pdf
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded medications as
coding improves interoperability.
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded conditions as
coding improves interoperability.
Y/N
Y/N
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded medications as
coding improves interoperability.
This IG does not recommend a specific coding system at this time.
It is expected many implementers will choose to only populate the
originalText component of the CWE data type; however, the IG
project team recommends moving towards coded conditions as
coding improves interoperability.
Y/N
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Value
OMEDD
Description
Date of last dose of other medication
OBX-2 DT
DTM
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 61
© 2012 Health Level Seven International. All rights reserved.
5.13 OBX – OBSERVATION RESULT SEGMENT (DONATION AND ADVERSE EVENTS)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for donation-level
observations, and donation procedure adverse events.
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
HL7 Element Name
Set ID – OBX
2
3
3
ID
CWE
R
R
[1..1]
[1..1]
4
10
ST
C
[0..1]
Observation Sub-ID
5
6
Var
CWE
R
CE
[0..1]
[0..1]
Observation Value
Units
7
8
9
10
11
12
ST
IS
NM
ID
ID
TS
X
X
X
X
R
X
[0..0]
[0..0]
[0..0]
[0..0]
[1..1]
[0..0]
13
ST
X
[0..0]
References Range
Abnormal Flags
Probability
Nature of Abnormal Test
Observation Result Status
Effective Date of Reference
Range
User-Defined Access Checks Not supported
Page 62
© 2012 Health Level Seven International. All rights reserved.
HL70085
Value Type
Observation Identifier
Description/Comments
Sequence number of the OBX in relation to the OBR
Observation segment to which it refers. The sequence number
should increment by 1 for each OBX in the group.
This field identifies the data type used for OBX-5.
Unique identifier for the type of observation. This field provides
a code for the type of observation. OBX.3 in conjunction with
OBX.4 Observation Sub-ID should uniquely identify this OBX
from all other OBXs associated with this OBR.
Required if there is more than one OBX with the same OBX-3
(Observation Identifier) associated with the same OBR.
Normally, this field is populated with a number, but text values
may also be used. See section below regarding using OBX-4
for adverse reaction observations.
Field that documents each specific value
Required if the results have units. UCUM® is an HL7-approved
code system, and shall be used for units as described in the
appropriate HITSP Interoperability Specification. If a numeric
value has no units of measure, the CWE data type allows an
"NA" (Not Applicable) from HL70353 as the Identifier
component.
Conditional statement: If the data type in OBX 2 is "NM" or "SN,"
this field is required.
Not supported
Not supported
Not supported
Not supported
Fixed to a value of “F” for Final.
Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX)
Seq
14
15
16
Len
DT
DTM
CWE
XCN
Usage
RE
X
RE
Cardinality
[0..1]
[0..0]
[0..1]
17
18
19
20
21
CWE
EI
TS
CWE
EI
X
X
X
X
X
[0..0]
[0..0]
[0..0]
[0..0]
[0..0]
22
23
CNE
XON
X
X
[0..0]
[0..0]
24
XAD
X
[0..0]
25
XCN
X
[0..0]
Value Set
HL7 Element Name
Description/Comments
Date/Time of the Observation Date and time of the adverse event or deferral assessment.
Producer’s Reference
Not supported
Responsible Observer
For adverse events, the staff member observing the reaction or
problem. For deferral, the staff member making the final
assessment for deferral.
Observation Method
Not supported
Equipment Instance Identifier Not supported
Date/Time of the Analysis
Not supported
Observation Site
Not supported
Observation Instance
Not supported
Identifier
Mood Code
Not supported
Performing Organization
Not supported
Name
Performing Organization
Not supported
Address
Performing Organization
Not supported
Medical Director
5.14 OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
The following observation identifiers are used in OBX-3 to communicate the type of donation observation or adverse event observation associated
with the donation procedure.
OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
IMPLEMENTATION GUIDE TABLE DON0003 – DONATION OBSERVATION CODES
Value
ASOC
DEFF
DFBD
DFED
DFCD
Description
Association
Deferral
Deferral Begin Date
Deferral End Date
Deferral Cancel Date
OBX-2
DT
ST
ST
DT
DT
DT
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 63
© 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
IMPLEMENTATION GUIDE TABLE DON0003 – DONATION OBSERVATION CODES
Value
Description
OBX-2
DEFO
DEFC
Deferral Override
Deferral Code
DT
ST
ST
LOST
Loss Type
ST
LOSA
SDA
SERA
Loss Amount
Special Donation Attributes
Serological Attribute (Antigen Antibody)
NM
ST
ST
RCT
Reaction Type
ST
RCC
Reaction Category
ST
RSS
Reaction Signs and Symptoms
ST
Comment
Question (QTN)
Vital Code (VCD)
Test (TST)
Red Cell Actual (RCA)
Red Cell 12 (RC12)
Red Cell Predicted (RCP)
Plasma Actual (PLA)
Plasma 12 (PL12)
Plasma Predicted (PLP)
When the OBX is Loss amount, Loss units are populated in OBX-6
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
For Adverse Events, codes are from the National Hemovigilance
standards and codes
http://www.aabb.org/programs/biovigilance/us/Documents/biovigilancem
anual.pdf
5.14.1 ADVERSE EVENTS
Adverse events are communicated using OBX segments immediately following the DON segment (representing/communicating the
donation procedure) during which the adverse event(s) occurred. The adverse event table has three-levels of hierarchy, Type (top-most),
Category (middle), and Signs and Symptoms (most detailed). Within each Type, there are one or more Categories, and within each
Category, there are one or more signs and symptoms. To communicate this, use a hierarchical OBX segments using the Sub-ID (OBX-4)
to indicate the hierarchy of each specific OBX-segment.
Page 64
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
The sub-id changes for each Reaction Type being communicated (so, 1, 2, etc.). For each category within a type, add a period ‘.’ and
another digit to represent the different categories (so 1.1, 1.2, etc.). For each category, communicate each sign/symptom by adding a
period and a last digit to the sub-id (so, 1.1.1, 1.1.2, etc.).
Example:
OBX||CE|RCT^Reaction Type^DON0003|1|Vasovagal^Vasovagal^UBNRCSS||||F
OBX||CE|RCC^Reaction Category^DON0003|1.1|LOC, any duration (uncomplicated)^LOC, any duration (uncomplicated)^UBNRCSS||||F
OBX||CE|RSS^Reaction Signs and Symptoms^DON0003|1.1.1|Pallor, pale skin or lips ^Pallor, pale skin or lips^UBNRCSS||||F
OBX||CE|RSS^Reaction Signs and Symptoms^DON0003|1.1.2|Rapid pulse^Rapid pulse^UBNRCSS||||F
5.15
AL1 – PATIENT ALLERGY INFORMATION SEGMENT
The AL1 segment contains patient allergy information of various types. Most of this information will be derived from user-defined tables. Each
AL1 segment describes a single patient allergy.
TABLE 5-11 – PATIENT ALLERGY INFORMATION SEGMENT (AL1)
1
Seq
4
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL7 Element Name
Set ID - AL1
2
3
705
CWE
CWE
X
R
[0..0]
[1..1]
Allergen Type Code
Allergen
Code/Mnemonic/Description
4
5
6
705
15
8
CWE
ST
DT
X
X
X
[0..0]
[0..0]
[0..0]
Allergy Severity Code
Allergy Reaction Code
Identification Date
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Sequence of AL1s should there be more than one of the
same type.
Not Supported
This IG does not recommend a specific coding system at this
time. It is expected many implementers will choose to only
populate the originalText component of the CWE data type;
however, the IG project team recommends moving towards
coded allergens as coding improves interoperability.
Not Supported
Not Supported
Not Supported
Page 65
© 2012 Health Level Seven International. All rights reserved.
5.16
NTE – NOTES AND COMMENTS SEGMENT
The NTE segment defined here is commonly used for sending notes and comments. Each NTE follows the segment to which that note or
comment pertains (see Message Types section above).
TABLE 5-12 – NOTES AND COMMENTS SEGMENT (NTE)
1
Seq
2
3
4
5
6
7
8
Len
4
65536
24
24
DT
SI
Usage
RE
Cardinality
[0..1]
ID
FT
CWE
XCN
DTM
DTM
DTM
X
R
X
X
RE
RE
X
[0..0]
[1..1]
[0..0]
[0..0]
[0..1]
[0..1]
[0..0]
Page 66
© 2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Element Name
Set ID - NTE
Source of Comment
Comment
Comment Type
Entered By
Entered Date/Time
Effective Start Date
Expiration Date
Description/Comments
Sequence of NTEs should there be more than one of the same
type.
Not Supported
Not Supported
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.17 DON - BLOOD BANK DONATION SEGMENT
The intent of this segment is to describe the actual donation procedure.
TABLE 5-13 – DONATION SEGMENT (DON)
DT
EI
CNE
Usage
C
C
Cardinality
[1..1]
[1..1]
3
4
5
6
7
8
9
10
DTM
DTM
NM
CNE
CNE
CNE
ID
CNE
RE
RE
RE
RE
RE
RE
R
C
[1..1]
[1..1]
[1..1]
[1..1]
[1..10]
[1..10]
[1..1]
[1..10]
11
12
13
14
15
16
17
18
19
20
21
22
23
24
DTM
CNE
CNE
CNE
ID
XCN
DTM
XON
DTM
XCN
CNE
CNE
XCN
XCN
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
RE
[1..1]
[1..1]
[1..1]
[1..100]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
[1..1]
1
2
Seq
Len
Value Set
HL70559
HL70560
HL70560
HL70136
HL70560
HL70561
HL70562
HL70564
HL70136
HL70563
HL70565
HL7 Element Name
Donation Identification Number
Donation Type
Phlebotomy Start Date/Time
Phlebotomy End Date/Time
Donation Duration
Donation Duration Units
Intended Procedure Type
Actual Procedure Type
Donor Eligibility Flag
Donor Eligibility Procedure Type
Donor Eligibility Date
Process Interruption
Process Interruption Reason
Phlebotomy Issue
Intended Recipient Blood Relative
Intended Recipient Name and ID
Intended Recipient DOB
Intended Recipient Facility
Intended Recipient Procedure Date
Intended Recipient Ordering Provider
Phlebotomy Status
Arm Stick
Bleed Start Phlebotomist
Bleed End Phlebotomist
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
See component mapping table below
The accepted values for this element are the table column
headers in the table listed in the ISBT 128 Standard
Technical Specification Table 5, Data Structure 002.
The element is populated with the procedure type or types
for which a donor is eligible when the donor is found to be
eligible for donation.
Page 67
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-13 – DONATION SEGMENT (DON)
Seq
25
26
27
28
Len
75
25
DT
ST
ST
ID
XCN
Usage
RE
RE
RE
R
Cardinality
[1..1]
[1..1]
[1..1]
[1..1]
Value Set
29
30
31
32
DTM
NM
EI
XCN
R
RE
RE
R
[1..1]
[1..1]
[1..100]
[1..1]
33
XCN
RE
[1..1]
Donation Material Review Staff
34
XON
R
[1..1]
Collection Facility
HL70136
HL7 Element Name
Aphaeresis Type Machine
Aphaeresis Machine Serial Number
Donor Reaction
Final Review Staff ID
Final Review Date/Time
Number of Tubes Collected
Donation Sample Identifier
Donation Accept Staff
Description/Comments
This is the name of the person who reviews all the
documents to ensure that all processes have been
completed and all blanks are completed correctly
This is the person who ultimately accepted or deferred the
donor. This may be the same person as DON-28 or DON33, but also may be different in the case where the
accepting or deferring Staff is acting at the direction of the
person in DON -28 or DON-33.
This is a person who may be a point of escalation if the
interviewer is unsure of whether to accept or defer the
donor or if the answers to the questions require escalation
(i.e. to a Supervisor, Medical Director, etc.). This may be
the same person as DON-28, but may also be different.
DONATION IDENTIFIER (DON-1) COMPONENT MAPPING
Business Element
Donation Identification Number
(leave null)
Use FID (facility identifier) from ISBT.
ISBT or Codabar
Page 68
© 2012 Health Level Seven International. All rights reserved.
Component
Entity Identifier
Namespace ID
Universal ID
Universal ID Type
ST
IS
ST
ID
Data Type
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.18 BUI – BLOOD UNIT INFORMATION SEGMENT
The intent of this segment is to describe the information associated with a blood unit, one example of which is one or more blood unit(s) resulting
from a donation.
TABLE 5-14 – BLOOD UNIT SEGMENT (BUI)
DT
Usage
Cardinality
SI
O
[1..1]
Set ID – BUI
2
EI
R
[1..1]
Blood Unit Identifier
The definition will be or assigned to the particular blood unit(s)
resulting from a donation. The Blood Unit Identifier field consists of
three components: DIN, the labeling standard used to identify the
blood unit and if known, the specific product code for the blood unit
to further identify type of unit (s) collected. If the donation results in
two different unit types (as specified in BUI-3), the unit can be
uniquely identified by the combination of the Blood Unit Identifier
and the Blood Unit Type. If multiple bags of the same Blood Unit
Type are collected, the product code (either a standard product code
or a locally assigned product code) is used to uniquely identify each
unit.
3
CNE
R
[1..1]
Blood Unit Type
need specific instructions on collections vs. shipping
4
NM
R
[1..1]
5
CNE
R
[1..1]
6
NM
R
[1..1]
7
CNE
R
[1..1]
8
ST
O
[1..1]
9
ST
O
[1..1]
10
XON
RE
[1..1]
1
Seq
Len
Value Set
HL70566
HL7 Element Name
Blood Unit Weight
HL70567
Weight Units
Blood Unit Volume
HL70568
Volume Units
Container Catalog Number
NM
R
[1..1]
12
CNE
R
[1..1]
The Container Manufacturer should be the Manufacturer Identifier
Code specified in Table 18 (RT016) in the ISBT 128 Technical
Specification
Transport Temperature
HL70569
Transport Temperature Units
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Systems should use Manufacturer and Catalogue Number from the
ISBT-128 Manufacturers Data File to determine container type.
Container Lot Number
Container Manufacturer
11
Description/Comments
Page 69
© 2012 Health Level Seven International. All rights reserved.
5.19
RCP – RESPONSE CONTROL PARAMETER SEGMENT
The RCP segment is used to restrict the amount of data that should be returned in response to query.
TABLE 5-15 – RESPONSE CONTROL PARAMETERS SEGMENT (RCP)
Usage
Cardinality
ID
X
[0..0]
CQ
R
[1..1]
3
CNE
X
4
DTM
5
1
Seq
Len
DT
Value Set
HL7 Element Name
Description/Comments
Query Priority
Not Supported
Quantity Limited Request
Fixed to a value of “RD” for record.
[0..0]
Response Modality
Not Supported
X
[0..0]
ID
X
[0..0]
Execution and Delivery Time Not Supported
Not Supported
Modify Indicator
6
SRT
X
[0..0]
Sort-by Field
Not Supported
7
ID
X
[0..0]
Segment group inclusion
Not Supported
2
10
Page 70
© 2012 Health Level Seven International. All rights reserved.
HL70126
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.20
QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q33
The QPD segment defines the parameters of the query.
TABLE 5-16 – QBP^Q33 INPUT PARAMETERS
Name
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL Segment
Field
Search
0471
Name
1
MessageQueryName
60
CWE
R
N
N/A
2
QueryTag
32
ST
R
N
N/A
3
DonorLastName
S
Y
50
ST
RE
N
N/A
PID.5
4
DonorFirstName
S
Y
50
ST
RE
N
N/A
PID.5
5
DonorDOB
DTM
RE
N
N/A
PID.7
6
DonorSex
IS
RE
N
N/A
0001
Service
Identifier
PID.8
Code
Element
Name
PID-5 Patient
Name
PID-5 Patient
Name
PID-7
Date/Time of
Birth
PID-8 Sex
TABLE 5-17 – INPUT PARAMETER ATTRIBUTES
Abbreviation
Field Seq
Name
Definition
The ordinal number of the element being discussed. Sequence 1 is always Message Query
Name, and sequence 2 is always Query Tag. Sequence 3 and above are reserved for user
parameters.
The user-defined name for the element as will be used in the query. Example:
MedicationDispensed. When Name is derived from an actual HL7 element (segment and field),
the segment field name and element name appear in the columns headed by those names.
When Name is not derived from an actual HL7 element (segment and field), the source system
defines the values they expect in this field.
For Query Profiles published in the HL7 Standard, the Input Parameter Specification table
includes the Query Profile ID in parentheses in the upper left-hand cell. This allows the table to
be imported automatically into the HL7 database.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 71
© 2012 Health Level Seven International. All rights reserved.
TABLE 5-17 – INPUT PARAMETER ATTRIBUTES
Abbreviation
Key/Search
Sort
Length
Type
Opt
Repeat
Match Operator
TBL
Segment Field Name
Service Identifier Code
Element Name
Definition
This field identifies which element is the key and which elements are searchable. The key field
is designated by a value of 'K'. A value of 'S' designates fields upon which an indexed search
can be performed by the source. 'L' designates non-indexed fields. (Note that searching on a
non-indexed field requires the Server to perform a linear scan of the data base.) If this column
is left blank, the field may not be searched.
Valued as "Y" if the output of the query can be sorted on this field. This column should only be
valued in Virtual Tables that are used as output specifications.
The maximum field length that will be transmitted by the source.
The data type of this user parameter. The values available for this field are described in
Chapter 2, section 2.16 of this standard. Data types QIP and QSC are available for transmitting
complex user parameters.
Defines whether the field is required ('R'), optional ('O'), conditionally required ('C'), or required
for backward compatibility ('B').
Valued as 'Y' if the field may repeat (i.e., be multiply valued).
The relational operator that will be applied against the value that the querying system specifies
for this field. Note: These are defined by HL7 Table 0209 – Relational Operator, a component of
the QSC data type
Identifies the HL7 table from which the values are derived.
Identifies the HL7 segment and field from which the new definition is derived. This field will be
blank if the Name is NOT derived from an actual HL7 segment and field.
A value of data type CWE that contains the applicable LOINC code, if it exists, or the applicable
HL7 code, if it exists, if no Segment Field Name has been identified. If a Segment Field Name
has been identified, this field is not populated.
The name of the element identified by Segment Field Name. This may also be a user-defined
'Z'-element.
Page 72
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.21
QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q34
The QPD segment defines the parameters of the query.
TABLE 5-16 – QBP^Q34 INPUT PARAMETERS
Name
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL
Search
1
MessageQueryName
60
CWE
R
N
N/A
2
QueryTag
32
ST
R
N
N/A
3
DonorIdentifier
20
ST
RE
N
N/A
5.22
0471
Segment
Field
Name
PID.3
Service
Identifier
Element Name
Code
PID-3 Patient
Identifier List
QAK – QUERY ACKNOWLEDGEMENT SEGMENT
The QAK segment contains information sent with responses to a query.
TABLE 5-17 – QUERY ACKNOWLEDGEMENT SEGMENT (QAK)
Seq
Len
1
DT
Usage
Cardinality
Value Set
HL7 Element Name
ST
X
[0..0]
Query Tag
Query Response Status
2
2
ID
RE
[0..1]
3
250
CWE
RE
[0..1]
4
10
NM
RE
[0..1]
Hit Count Total
5
10
NM
RE
[0..1]
This payload
6
10
NM
RE
[0..1]
Hits remaining
HL70471
Not Supported
Message Query Name
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Description/Comments
Page 73
© 2012 Health Level Seven International. All rights reserved.
6 CODE SYSTEMS AND VALUE SETS
Successful message implementation requires that transmitted messages (message instances) contain valid values for coded fields. It is
important to note that code sets are relatively dynamic and subject to change between publications of these implementation guides.
Every code value passed in a message instance is drawn from a code system that has a globally unique identifier, such as an OID. In
general, the coded values allowed in a field (a) may be drawn from more than one code system, and (b) may be a subset of the codes
from a given coding system. Combining (a) and (b) makes it possible for the allowed code value to be a combination of multiple subsets
drawn from multiple coding systems. In most cases, only some of the codes defined in a code system are legal for use in a particular
message.
The subsets of the codes that are legal for a particular field are identified by an HL7 construct known as a Value Set. A value set is a
collection of coded values drawn from code systems. Value sets serve to identify the specific set of coded values for the message from
the universe of coded values across all coding systems. The actual content of any Value Set is subject to continual change, and the set of
Value Sets may also change to reflect current needs.
The segment tables in previous sections identify the Value Set or Coding System used for each supported field containing a coded value.
Fields that use the data type CNE or CWE require that messages include the code, (drawn from HL7 0396) that uniquely defines the
coding system, as well as the coded value itself. Some of these pre-coordinated value sets must be updated, or new ones created, as
new needs are identified.
Value Sets are identified by a unique identifier also, but this identifier is not transmitted in the message. The identifier or code for the
coding system from which the value is derived is sent in the message. However, the value set identifier is useful and important when
vocabulary items are modified or replaced.
Page 74
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.1
CODE TABLE ABBREVIATIONS
The following sections detail the structure of each code table, including field value, description, usage, and comments. The table below details the
abbreviated terms used in the code tables, as well as the definitions associated with those abbreviations.
TABLE 5-1 – SEGMENT ATTRIBUTES
Value
Len
Abbreviation
Usage
Definition
The actual code value to be send in conformant messages.
Description of the code.
Usage of the field for this profile. Indicates if the field, component, or subcomponent is required, optional, or conditional in the corresponding
segment, field, or component. Legal values are:
• R – Required. Must always be populated.
• O – Optional. May optionally be populated.
• X – Not used for this profile.
Note: Codes present in the HL7-defined tables may have been constrained for use in the Implementation Guide. In those cases
where the full list of codes from an HL7 table is not supported, those codes not supported are dropped from the list in this IG (as
opposed to marking them as “X”. As always, User-defined tables contain only relevant codes to be used for this IG.
Comment
Any comments specific to usage of the specific code.
6.2 USER-DEFINED TABLE HL70001 – ADMINISTRATIVE SEX
USER-DEFINED TABLE HL70001 – ADMINISTRATIVE SEX
Value
F
M
O
U
A
N
Description
Female
Male
Other
Unknown
Ambiguous
Not applicable
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Usage
R
R
R
R
R
R
Comment
Page 75
© 2012 Health Level Seven International. All rights reserved.
6.3 USER-DEFINED TABLE HL70003 – EVENT TYPE
USER-DEFINED TABLE HL70003 – EVENT TYPE
Value
K33
K34
O41
O42
O43
O44
O45
O46
O47
O48
Q33
Q34
Description
RSP – Donor Record Candidates
RSP – Donor Record
DBC – Donor Record Create
DBU – Donor Record Update
DRG – Donor Registration
DER – Donor Eligibility Request
DEO – Donor Eligibility Observations
DEL – Donor Eligibility
DRC – Donor Request to Collect
DPR – Donation Procedure
QBP – Donor Record Candidates
QBP – Donor Record
Usage
R
R
R
R
R
R
R
R
R
R
R
R
Comment
Usage
Comment
6.4 USER-DEFINED TABLE HL70005 – RACE
USER-DEFINED TABLE HL70005 – RACE
Value
1002-5
2028-9
2054-5
2076-8
2106-3
2131-1
Description
American Indian or Alaska Native
Asian
Black or African American
Native Hawaiian or Other Pacific Islander
White
Other Race
Page 76
© 2012 Health Level Seven International. All rights reserved.
R
R
R
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.5 HL7 TABLE HL70008 – ACKNOWLEDGEMENT CODE
HL7 TABLE HL70008 – ACKNOWLEDGEMENT CODE
Value
AA
AE
AR
Description
Original mode: Application Accept - Enhanced mode: Application acknowledgment: Accept
Original mode: Application Error - Enhanced mode: Application acknowledgment: Error
Original mode: Application Reject - Enhanced mode: Application acknowledgment: Reject
Usage
R
R
R
Comment
Usage
R
R
R
R
R
R
R
R
R
R
R
Comment
Usage
R
Comment
6.6 HL7 TABLE HL70076 – MESSAGE TYPE
HL7 TABLE HL70076 – MESSAGE TYPE
Value
ACK
QBP
RSP
DBC
DBU
DRG
DER
DEO
DEL
DRC
DPR
General acknowledgment message
Query by parameter
Segment pattern response
Donor Record Create
Donor Record Update
Donor Registration
Donor Eligibility Request
Donor Eligibility Observations
Donor Eligibility
Donor Request to Collect
Donation Procedure
Description
6.7 HL7 TABLE HL70103 – PROCESSING ID
HL7 TABLE HL70103 – PROCESSING ID
Value
D
Debugging
Description
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 77
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70103 – PROCESSING ID
Value
P
T
Description
Production
Training
Usage
R
R
Comment
6.8 HL7 TABLE HL70125 – VALUE TYPE
HL7 TABLE HL70125 – VALUE TYPE
Value
CE
Description
Coded Entry
Usage
R
CWE
Coded with Exceptions
R
DT
ED
Date
Encapsulated Data
R
R
FT
Formatted Text (Display)
R
NM
Numeric
R
RP
Reference Pointer
R
Page 78
© 2012 Health Level Seven International. All rights reserved.
Comment
Data type to be used where it is important to communicate the coding system
with the coded result being reported.
Data type to be used where it is important to communicate the coding system
and coding system version with the coded result being reported.. Pre-adopted
from Version 2.6
Field using the NM data type to carry a date value.
Field using the ED data type to allow communication of images, sound clips,
XML documents, html markup, etc.
Field using the FT data type to carry a text result value this is intended for
display. The text may contain formatting escape sequences as described in the
data types section. Numeric results and numeric results with units of measure
should not be reported as text. These should be reported as NM or SN numeric
results, with the units of measure in OBX-6.
Field using the NM data type to carry a numeric result value. The only nonnumeric characters allowed in this field are a leading plus (+) or minus (-) sign.
The structured numeric (SN) data type should be used for conveying inequalities,
ranges, ratios, etc. The units for the numeric value should be reported in OBX-6.
Field using the RP data type to allow communication of pointers to images,
sound clips, XML documents, html markup, etc. The RP data type is used when
the object being pointed to is too large to transmit directly.
This specification defines the mechanism for exchanging pointers to objects, but
it does not address the details of applications actually accessing and retrieving
the objects over a network.
The most common scheme for passing a pointer is to use a Universal Resource
Identifier (see http://ietf.org/rfc/rfc2396.txt for detailed definition). The general
format of a URI is in the form: <scheme>://<authority><path>?<query>. The
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
HL7 TABLE HL70125 – VALUE TYPE
Value
Description
Usage
SN
Structured Numeric
R
ST
String Data
R
TN
TS
TX
Telephone Number
Time Stamp (Date & Time)
Text Data (Display)
R
R
R
Comment
scheme and authority portions appear in the Application ID component, Universal
ID subcomponent. The path and query portion of the URI appear in the Pointer
component of the RP data type.
Field using the SN data type to carry a structured numeric result value.
Structured numeric include intervals (^0^-^1), ratios (^1^/^2 or ^1^:^2),
inequalities (<^10), or categorical results (2^+). The units for the structured
numeric value should be reported in OBX-6.
Field using the ST data type to carry a short text result value. Numeric results
and numeric results with units of measure should not be reported as text. These
should be reported as NM or SN numeric results, with the units of measure in
OBX-6.
Field using the TN date type to carry a phone number.
Field using the TX data type to carry a text result value this is intended for
display. Numeric results and numeric results with units of measure should not be
reported as text. These should be reported as NM or SN numeric results, with
the units of measure in OBX-6.
6.9 HL7 TABLE HL70136 - YES/NO INDICATOR
HL7 TABLE HL70136 – YES/NO INDICATOR
Y
N
Value
Yes
No
Description
Usage
R
R
Comment
6.10 HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
Value
AL
NE
ER
Description
Always
Never
Error/reject conditions only
Usage
R
O
O
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 79
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
Value
SU
Description
Successful completion only
Usage
O
Comment
6.11 USER-DEFINED TABLE HL70189 – ETHNIC GROUP
USER-DEFINED TABLE HL70189 - ETHNIC GROUP
H
N
U
Value
Description
Hispanic or Latino
Not Hispanic or Latino
Unknown
Usage
R
R
R
Comment
6.12 USER-DEFINED TABLE HL70190 - ADDRESS TYPE
USER-DEFINED TABLE HL70190 - ADDRESS TYPE
H
Value
O
Home
Description
Office/Business
Usage
R
R
Comment
Refers to a residence or domicile, literally the place where the subject
resides the majority of the time. Generally speaking most people will
have a home address and it will represent their primary address. Home
address is mutually exclusive of permanent address.
Refers to a work address specific to the subject.
6.13 HL7 TABLE HL70191 – TYPE OF REFERENCED DATA
HL7 TABLE HL70191 – TYPE OF REFERENCED DATA
Value
AP
AU
IM
multipart
TEXT
Description
Other application data, typically uninterpreted binary data (HL7 V2.3 and later)
Audio data (HL7 V2.3 and later)
Image data (HL7 V2.3 and later)
MIME multipart package
Machine readable text document (HL7 V2.3.1 and later)
Page 80
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.14 HL7 TABLE HL70200 - NAME TYPE
HL7 TABLE HL70200 - NAME TYPE
B
L
M
N
Value
Description
Name at Birth
Legal Name
Maiden Name
Nickname /”Call me” Name/Street Name
Usage
R
R
R
R
For Previous Name
For Donor Name
For Maiden Name
For Nickname
Comment
6.15 HL7 TABLE HL70201 - TELECOMMUNICATION USE CODE
TABLE 5-3 – HL7 TABLE HL70201 - TELECOMMUNICATION USE CODE
Value
PRN
WPN
PRS
Description
Primary Residence Number
Work Number
Personal
Usage
R
R
R
Comment
Used for home phone
Used for work phone
Not tied to a location or role – Used for mobile or cellular
phone
6.16 HL7 TABLE HL70202 - TELECOMMUNICATION EQUIPMENT TYPE CODE
HL7 TABLE HL70202 - TELECOMMUNICATION EQUIPMENT TYPE CODE
Value
PH
CP
Description
Telephone
Cellular or Mobile Phone
Usage
R
R
Comment
Used for home phone and work phone
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 81
© 2012 Health Level Seven International. All rights reserved.
6.17 HL7 TABLE HL70203 – IDENTIFIER TYPE
HL7 TABLE HL70203 – IDENTIFIER TYPE
Value
BCT
Description
Birth Certificate
CZ
Citizenship Card
R
DL
DR
HC
MI
Driver’s license number
Donor Registration Number
Health Card Number
Military ID number
R
R
R
R
MR
Medical record number
R
NI
National unique individual identifier
R
NNxxx
R
PI
National Person Identifier where the xxx is the
ISO table 3166 3-character (alphabetic) country
code
Patient internal identifier
PN
Person number
R
PPN
Passport number
R
SS
Social Security number
O
Page 82
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
Comment
A number associated with a document identifying the event of
a person’s birth.
A number assigned by a person’s country of residence to
identify a person’s citizenship.
A number assigned to an individual who has had military duty,
but is not currently on active duty. The number is assigned by
the DOD or Veterans’ Affairs (VA).
An identifier that is unique to a patient within a set of medical
records, not necessarily unique within an application.
Class: Insurance
In the US, the Assigning Authority for this value is typically
CMS, but it may be used by all providers and insurance
companies in HIPAA related transactions.
A number that is unique to a patient within an Assigning
Authority.
A number that is unique to a living subject within an Assigning
Authority.
A unique number assigned to the document affirming that a
person is a citizen of the country. In the US this number is
issued only by the State Department.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.18 EXTERNAL TABLE HL70291 – SUB TYPE OF REFERENCED DATA
EXTERNAL TABLE HL70291 - SUB TYPE OF REFERENCED DATA
Value
Description
Usage
R
Comment
Table 0291 comprises the values of MIME media subtypes established
in accordance with RFC 2046 (http://ietf.org/rfc/rfc2046.txt) and
registered with the Internet Assigned Numbers Authority
(http://www.iana.org/numbers.html). Note that the MIME media subtype
values are case-insensitive, in accordance with RFC 2045.
6.19 HL7 TABLE HL70299 – ENCODING
HL7 TABLE HL70299 - ENCODING
A
Value
Hex
Base64
Description
No encoding - data are displayable ASCII
characters.
Hexadecimal encoding - consecutive pairs of
hexadecimal digits represent consecutive single
octets.
Encoding as defined by MIME (Multipurpose Internet
Mail Extensions) standard RFC 1521. Four
consecutive ASCII characters represent three
consecutive octets of binary data. Base64 utilizes a
65-character subset of US-ASCII, consisting of both
the upper and lower case alphabetic characters,
digits "0" through “9”, “+", “/", and “=”.
Usage
R
Comment
R
R
The Request For Comment (RFC) 1521 standard is
available at: http://www.ietf.org/rfc/rfc1521.txt
6.20 USER-DEFINED TABLE HL70300 – NAMESPACE ID
USER-DEFINED TABLE HL70300 – NAMESPACE ID
Value
Description
No suggested values
Usage
Comment
These values are local to each implementation
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 83
© 2012 Health Level Seven International. All rights reserved.
6.21 USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
C
D
H
N
O
P
S
Value
Description
Clinic
Department
Home
Nursing Unit
Provider’s Office
Phone
SNF
Usage
R
R
R
R
R
R
R
Comment
6.22 HL7 TABLE HL70354 – MESSAGE STRUCTURE
HL7 TABLE HL70354 – MESSAGE STRUCTURE
Value
ACK
RSP_K33
RSP_K34
DBC_O41
DBU_O42
DRG_O43
DER_O44
DEO_O45
DEL_O46
DRC_O47
DPR_O48
QBP_Q33
QBP_Q34
Varies
K33
K34
O41
O42
O43
O44
O45
O46
O47
O48
Q33
Q34
Event
Page 84
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
R
R
R
R
R
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.23 HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
0
Value
Description
Message accepted
Usage
R
100
Segment sequence error
R
101
102
Required field missing
Data type error
R
R
103
Table value not found
R
200
201
202
203
204
Unsupported message type
Unsupported event code
Unsupported processing id
Unsupported version id
Unknown key identifier
R
R
R
R
R
205
Duplicate key identifier
R
206
Application record locked
R
207
Application internal error
R
Comment
Success. Optional, as the AA conveys success. Used for systems that
must always return a status code.
Error: The message segments were not in the proper order, or required
segments are missing.
Error: A required field is missing from a segment
Error: The field contained data of the wrong data type, e.g., an NM field
contained "FOO".
Error: A field of data type ID or IS was compared against the
corresponding table, and no match was found.
Rejection: The Message Type is not supported.
Rejection: The Event Code is not supported.
Rejection: The Processing ID is not supported.
Rejection: The Version ID is not supported.
Rejection: The ID of the patient, order, etc., was not found. Used for
transactions other than additions, e.g., transfer of a non-existent patient.
Rejection: The ID of the patient, order, etc., already exists. Used in
response to addition transactions (Admit, New Order, etc.).
Rejection: The transaction could not be performed at the application
storage level, e.g., database locked.
Rejection: A catchall for internal errors not explicitly covered by other
codes.
6.24 HL7 TABLE HL70396 – CODING SYSTEM
HL7 TABLE HL70396 – CODING SYSTEM
Value
Description
Usage
Comment
99zzz or L
Local general code (where z is an
alphanumeric character)
Locally defined codes for purpose of sender or receiver. Local codes
can be identified by L (for backward compatibility) or 99zzz (where z is
an alphanumeric character).
UBNRCSS
UBNRCSS
US Biobvigilance Network Reaction Categories Signs and Symptoms
IBTnnnn
ISBT 128 codes where nnnn specifies
International Society of Blood Transfusion. (specific contact information
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 85
© 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70396 – CODING SYSTEM
Value
Description
a specific table within ISBT 128.
Usage
will be supplied to editor.)
Comment
The variable suffix (nnnn) identifies a specific table within ISBT 128.
UCUM
UCUM code set for units of
measure(from Regenstrief)
6.25 USER-DEFINED TABLE HL70471 – QUERY NAME
USER-DEFINED TABLE HL70471 – QUERY NAME
Value
GetDonorRecordCandidates
GetDonorRecord
Description
Query to retrieve Donor Record Candidates
Query to retrieve a Donor Record
Usage
R
R
Comment
6.26 HL7 TABLE HL70516 – ERROR SEVERITY
HL7 TABLE HL70516 – ERROR SEVERITY
W
I
E
F
Value
Warning
Information
Error
Fatal Error
Description
Usage
R
R
R
R
Comment
Transaction successful, but there may issues
Transaction was successful but includes information e.g., inform patient
Transaction was unsuccessful
Message not processed due to application or network failure condition
6.27 USER-DEFINED TABLE HL70559 – DURATION UNITS
USER-DEFINED TABLE HL70559 – DURATION UNITS
Value
min
S
Minutes
Seconds
Description
Page 86
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.28 USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
Value
WBL
2RC
PLS
PLT
PNP
PNR
PPR
GRN
HEM
Description
Whole Blood
Double Red Cells
Plasma
Platelets
Platelets and Plasma
Platelets and Red Cells
Platelets, Plasma, and Red Cells
Granulocytes
Hemachromatosis
HPC
LYM
THA
THW
Hematopoietic Progenitor Cells
Lymphocytes
Therapeutic Apheresis
Therapeutic Whole Blood
Usage
R
R
R
R
R
R
R
R
R
R
R
R
R
Comment
To be used as whole blood for transfusion; may not be counted as red
blood cell loss; Donor may be considered a patient.
Stem Cells and other cells classified as Hematopoietic
6.29 USER-DEFINED TABLE HL70561 – PROCESS INTERRUPTION
USER-DEFINED TABLE HL70561 – PROCESS INTERRUPTION
Value
NIN
WOT
ABR
Description
Process was not interrupted
Walk Out: Process interrupted before the Phlebotomist
inserts the needle in the Donor’s arm
Aborted Run: Process interrupted after the Phlebotomist
inserts the needle in the Donor’s arm
Usage
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 87
© 2012 Health Level Seven International. All rights reserved.
6.30 USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
Value
NRG
PCD
DCW
CFT
DBB
DNI
ASC
BSC
GFE
Description
No reason given, donor decided to stop
without giving a reason
Phone Call-Donor
Couldn’t wait
Couldn’t follow through with donation
(scared)
Bathroom
Phlebotomy Issue
Apheresis Software Crash
Manufacturing Software Crash
General Facility Emergency
Usage
R
Comment
R
R
R
R
R
R
R
R
Power outage, natural disaster (tornado, flood, hurricane, etc.), air
conditioning failure, etc.
6.31 USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
Value
INF
VSM
COL
MIS
NAD
PFL
CLT
DND
DBG
DAK
DMT
Description
Infiltration
Vein Spasm
Collapse
Missed / in tissue
Needle adjustment (this may not end a
procedure, if successful will impact
component production)
Poor flow
Clotted
Defective Needle
Defective Bag
Defective Apheresis Kit
Defective Instrument
Page 88
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
R
R
Comment
R
R
R
R
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
Value
IPF
ACN
Description
Instrument Power Failure
Air Contamination
Usage
R
R
Comment
6.32 USER-DEFINED TABLE HL70563 – PHLEBOTOMY STATUS
USER-DEFINED TABLE HL70563 – PHLEBOTOMY STATUS
Value
SUC
NDR
Description
Successful
Not Drawn
UL5
Unsuccessful Less than 50 ml drawn
Usage
R
R
R
Comment
Successful means a complete component was drawn
There may be two reasons for this to occur
Phlebotomy performed, no blood obtained
Phlebotomy not performed due to other circumstances
Phlebotomy was performed, some blood was drawn, less than 50 ml
was drawn
6.33 USER-DEFINED TABLE HL70565 – ARM STUCK
USER-DEFINED TABLE HL70565 – ARM STUCK
L
R
B
Value
Left Arm
Right Arm
Both Arms
Description
Usage
R
R
R
Comment
6.34 USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
Value
WBL
RBC
Description
Whole Blood
Red Blood Cells
Usage
R
R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comment
Page 89
© 2012 Health Level Seven International. All rights reserved.
USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
Value
PLS
PLT
GRN
PSC
LYM
Description
Plasma
Platelets
Granulocytes
Peripheral Stem Cells
Lymphocytes
Usage
R
R
R
R
R
Comment
6.35 USER-DEFINED TABLE HL70567 – WEIGHT UNITS
USER-DEFINED TABLE HL70567 – WEIGHT UNITS
Value
[lb_av]
[oz_av]
Kg
G
Pound
Ounce
Kilogram
Gram
Description
Usage
R
R
R
R
Comment
6.36 USER-DEFINED TABLE HL70568 – VOLUME UNITS
USER-DEFINED TABLE HL70568 – VOLUME UNITS
Value
L
[pt_us]
Ml
Liter
Pint
Milliliters
Description
Page 90
© 2012 Health Level Seven International. All rights reserved.
Usage
R
R
R
Comment
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
6.37 USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
Value
degF
Cel
Description
Degrees Fahrenheit
Degrees Celsius
Usage
R
R
Comment
6.38 HL7 TABLE HL70834 – MIME TYPE
HL7 TABLE HL70834 – MIME TYPE
Value
application
audio
image
model
text
video
multipart
Description
Application data
Audio data
Image data
Model data
Text data
Video data
MIME multipart package
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Usage
O
R
R
O
R
R
O
Comments
Page 91
© 2012 Health Level Seven International. All rights reserved.
7 DATA TYPES
This chapter defines the data types used in this Implementation Guide. They are listed alphabetically and contain all elements that define each
type. The usage column of the component table has been updated to reflect the standard constrained usage of each data type referred to in this
Implementation Guide. Exceptional usage patterns are noted in this section and specific exceptional component usage constraints are
documented with the element definition.
7.1 DATA TYPES SUMMARY
TABLE 7-1 – DATA TYPES
Data type
Data Type Name
CNE
Coded with No Exceptions
CNN
Composite ID Number and Name Simplified
CQ
Composite Quantity with Units
CWE
Coded with Exceptions
CX
Extended Composite ID with Check Digit
DTM
Date/Time
ED
Encapsulated Data
EI
Entity Identifier
FN
Family Name
FT
Formatted Text Data
HD
Hierarchic Designator
ID
Coded Values for HL7 Tables
IS
Coded value for User-Defined Tables
MSG
Message Type
NM
Numeric
PT
Processing Type
RP
Reference Pointer
SAD
Street Address
SI
Sequence ID
Page 92
© 2012 Health Level Seven International. All rights reserved.
Length
24
65536
20
16
4
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
TABLE 7-1 – DATA TYPES
Data type
Data Type Name
SN
Structured Numeric
ST
String
TX
Text Data
VID
Version Identifier
XAD
Extended Address
XCN
Extended Composite ID Number and Name
XON
Extended Composite Name and ID Number
for Organizations
XPN
Extended Person Name
XTN
Extended Telecommunication Number
Length
999
65536
7.2 DATA TYPE TABLE ABBREVIATIONS
The following sections detail the structure of each data type, including segment name, usage, value set, and description. The table below details
the abbreviated terms used in the data type tables, as well as the definitions associated with those abbreviations.
TABLE 7-2 – DATA TYPE ATTRIBUTES
Seq
Len
DT
Abbreviation
Definition
Sequence of the elements as numbered in the HL7 segment.
• Maximum length of the element. Lengths are only provided for atomic data types.
Lengths should be considered recommendations, not absolutes. The receiver can truncate
fields, components and sub-components that are longer than the recommended length. The
receiver should continue to process a message even when a field, component, or subcomponent length exceeds the maximum recommended length identified in this specification.
Data type used by this profile for HL7 element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 93
© 2012 Health Level Seven International. All rights reserved.
TABLE 7-2 – DATA TYPE ATTRIBUTES
Abbreviation
Usage
Definition
Usage of the field for this profile. Indicates whether the field, component, or subcomponent is
required, optional, or conditional in the corresponding segment, field, or component. Legal
values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• O – Optional. May optionally be populated.
• CE – Conditional. Populated under specified conditions.
• C – Conditional, but may be empty.
• X – Not used for this profile.
The set of coded values to be used with the field.
Value Set
Component Name
Description/Comments
Note: Where a table constraint is indicated, or where HL7 Version 2.8
standards are pre-adopted, the constrained or specified HL7 table is included
below the data type table.
HL7 descriptor of the element in the data type.
Context and usage for the element.
Note: In the tables throughout this document, Yellow = This Interoperability Specification does not support the use of this item.
Page 94
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.3 CNE – CODED NO EXCEPTIONS
TABLE 2-6 – CODED NO EXCEPTIONS (CNE)
SEQ
1
2
LEN
30
200
DT
ST
ST
Usage
RE
RE
Value Set
3
20
ID
CE
HL70396
4
5
6
ST
ST
ID
X
X
X
7
8
ST
ST
X
X
9
ST
X
Component Name
Identifier
Text
Name of Coding System
Alternate Identifier
Alternate Text
Name of Alternate Coding
System
Coding System Version ID
Alternate Coding System
Version ID
Original Text
Comments
It is strongly recommended that text be sent to
accompany any identifier. When a coded value is not
known, the orginal text attribute is used to carry the
text, not the text component.
Condition rule: Required if an identifier is provided in
component 1.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: Specifies a coded element and its associated detail. The CNE data type is used when a required or mandatory coded
field is needed. The specified HL7 table or imported or externally defined coding system must be used and may not be extended
with local values. Text may not replace the code. A CNE field must have an HL7 defined or external table associated with it. A
CNE field may be context sensitive such that a choice of explicit coding systems might be designated. This allows for realm and
other types of specificity. Every effort will be made to enumerate the valid coding system(s) to be specified in the 3rd component,
however, the standards body realizes that this is impossible to fully enumerate.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 95
© 2012 Health Level Seven International. All rights reserved.
7.4 CNN – COMPOSITE ID NUMBER AND NAME SIMPLIFIED
TABLE 2-35 – COMPOSITE ID NUMBER AND NAME SIMPLIFIED (CNN)
SEQ
LEN
1
20
ST
RE
50
50
FN
ST
ST
RE
RE
RE
ST
ST
IS
IS
HD
RE
RE
X
X
CE
2
3
4
5
6
7
8
9
10
10
DT
Usage
Value
Set
Component Name
ID Number
Family Name
Given Name
Second and Further Given Names
or Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Source Table
Assigning Authority
Comments
If this is a person, the ID must be accompanied by
an OID for the assigning authority (component 9).
If this is an organization, the OID for the
organization should be provided here.
Not Supported
Not Supported
Condition rule: Required if component 1 (ID
Number) is populated.
Definition: Specifies a person using both an identifier and the person’s name.
Page 96
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.5 CQ – COMPOSITE QUANTITY WITH UNITS
TABLE 2-5 – COMPOSITE QUANTITY WITH UNITS (CQ)
SEQ
1
2
LEN
DT
16
Usage
Value
R
RE
UCUM
NM
CWE
Set
Comments
Component
Name
Quantity
Units
Units of measure must be drawn from the UCUM coding
system.
Definition: Specifies a quantity include units.
7.6 CWE – CODED WITH EXCEPTIONS
TABLE 2-6 – CODED WITH EXCEPTIONS (CWE)
SEQ
LEN
1
2
30
200
ST
ST
RE
RE
3
20
ID
CE
4
5
6
ST
ST
ID
X
X
X
7
ST
X
8
ST
X
ST
RE
9
200
DT
Usage
Value Set
HL70396
Comments
Component
Name
Identifier
Text
Name of Coding
System
Alternate Identifier
Alternate Text
Name of Alternate
Coding System
Coding System
Version ID
Alternate Coding
System Version ID
Original Text
It is strongly recommended that text be sent to accompany any
identifier. When a coded value is not known, the orginal text
attribute is used to carry the text, not the text component.
Condition rule: Required if an identifier is provided in component
1.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Original Text is used to convey either the text which was the
basis for coding, or when there is no code to be sent, only free
text.
Definition: The CWE data type is used where it is necessary to communicate a code, text, coding system and the version of
coding system the code was drawn from. It also allows the communication of an alternate code drawn from another coding
system. Many coded fields in this specification identify coding systems or value sets that must be used for the field. When
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 97
© 2012 Health Level Seven International. All rights reserved.
populating the CWE data types with these values, this guide does not give preference to the triplet in which the standard code
should appear. The receiver is expected to examine the coding system names in components 3 and 6 to determine if it recognizes
the coding system.
The CWE data type allows communication of an early form of what has come to be called "null flavors." HL7 2.6 refers to these
as CWE Statuses, where the values are drawn from HL7 table 0353. Support for the CWE Statuses are optional.
This guide conforms to the HL7 Version 2.6 convention of using the CWE data type in place of the CE to allow transmission of
version information.
7.7 CX – EXTENDED COMPOSITE ID WITH CHECK DIGIT
TABLE 2-7 – EXTENDED COMPOSITE ID WITH CHECK DIGIT (CX)
SEQ
LEN
1
30
2
3
4
5
6
7
8
9
10
5
DT
Usage
ST
R
ST
ID
HD
ID
HD
DT
DT
CWE
CWE
X
X
R
R
X
X
X
X
X
Value Set
HL70203
Comments
Component
Name
ID Number
Check Digit
Check Digit Scheme
Assigning Authority
Identifier Type Code
Assigning Facility
Effective Date
Expiration Date
Assigning Jurisdiction
Assigning Agency or
Department
The ID Number component combined with the Assigning
Authority component must uniquely identify the associated
object, i.e., whatever object with which the field is
associated.
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: The CX data type is used to carry identifiers. This guide requires that all identifiers be accompanied by assigning
authorities, and that all identifiers carry an identifier type. This method allows the exchange of unique identifiers for the associated
object across organizational and enterprise boundaries, enabling broad interoperability.
Although the Identifier Type Code component is required, it is not a part of the actual identifier. Rather, it is metadata about the
identifier. The ID Number and Assigning Authority component, together, constitute the actual identifier.
Page 98
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.8 DTM – DATE/TIME
TABLE 2-10 – DATE/TIME (DTM)
SEQ
LEN
1
24
DT
Usage
Value Set
R
Comments
Component
Name
Date/Time
Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]
Definition: Specifies a point in time using a 24-hour clock notation.
Usage: It is strongly recommended that the time zone offset always be included in the DTM.
7.9 ED – ENCAPSULATED DATA
TABLE 2-11 – ENCAPSULATED DATA (ED)
SEQ
LEN
1
DT
Usage
HD
RE
Value Set
Component
Name
Source Application
2
9
ID
R
HL70191
Type of Data
3
18
ID
RE
HL70291
Data Subtype
4
6
ID
R
HL70299
Encoding
5
65536
TX
R
Data
Comments
Identifier of the application that is the
source of the encapsulated data.
Identifier of the type of data found in
component 5.
Identifier of the subtype of data found in
component 5
Identifier of the type of encoding to be
performed in the data component
The data in this component must be
properly escaped after encoding.
Receivers will need to de-escape the
text prior to de-encoding.
Definition: This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the
source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference
pointer) data type except that instead of pointing to the data on another system, it contains the data which is to be sent to that
system.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 99
© 2012 Health Level Seven International. All rights reserved.
7.10 EI – ENTITY IDENTIFIER
TABLE 2-12 – ENTITY IDENTIFIER (EI)
SEQ
LEN
DT
Usage
1
30
ST
R
2
20
IS
R
3
999
ST
X
4
6
ID
X
Value
Set
HL70300
HL70301
Component Name
Comments
Entity Identifier
Namespace ID
Universal ID
An identifier which represents each
local, implemented system/application
which can assign identifiers.
Not Supported
Universal ID Type
Not Supported
Definition: The entity identifier defines a given entity within a specified series of identifiers.
Usage: The EI data type is used to carry identifiers. This guide requires that all entity identifiers be accompanied by assigning
authorities. This allows the exchange of unique identifiers for the associated object across organizational and enterprise
boundaries, enabling broad interoperability.
In the EI data type, the Namespace ID, Universal ID and Universal ID type correspond with the HD data type identified elsewhere.
These types together are commonly considered the assigning authority for the identifier. The Entity Identifier and assigning
authority components, together, constitute the actual identifier.
7.11 FN – FAMILY NAME
TABLE 2-14 – FAMILY NAME (FN)
SEQ
1
2
3
5
LEN
50
DT
Usage
ST
ST
ST
ST
R
X
X
X
ST
X
Value
Set
Component Name
Surname
Own Surname Prefix
Own Surname
Surname Prefix From
Partner/Spouse
Surname From
Partner/Spouse
Comments
Not Supported
Not Supported
Not Supported
Not Supported
Definition: This data type allows full specification of the surname of a person. Where appropriate, it differentiates the person's own
surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name.
It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root.
Page 100
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.12 FT – FORMATTED TEXT DATA
TABLE 2-15 – FORMATTED TEXT DATA (FT)
SEQ
LEN
DT
65536
Usage
R
Component Name
Value
Set
Comments
Coded Value for HL7-Defined Tables
Definition: This data type is derived from the TX data type by allowing the addition of embedded formatting instructions. These instructions
are limited to those that are intrinsic and independent of the circumstances under which the field is being used. The actual instructions and
their representation are described in section 2.7.6, “Usage and Examples of Formatted Text”. The FT field is of arbitrary length (up to 64k)
and may contain formatting commands enclosed in escape characters.
Example:
|\.sp\(skip one vertical line)|
For additional examples of formatting commands see Section 2.7, "Use of Escape Sequences in Text Fields".
Usage: The FT data type allows use of the formatting escape sequences documented in HL7 Version 2.6, Chapter 2, Section 2.7 - Use of
Escape Sequences in Test Fields.
7.13 HD – HIERARCHIC DESIGNATOR
TABLE 2-16 – HIERARCHIC DESIGNATOR (HD)
1
2
3
SEQ
LEN
IS
ST
ID
DT
Usage
R
X
X
Value Set
HL70300
Component Name
Namespace ID
Universal ID
Universal ID Type
Comments
Assign a unique code for each
application/system.
Not Supported
Not Supported
Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has
responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers,
provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient
identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or drivers’ license numbers, or a
facility where such identifiers are assigned.
Usage: The HD data type is used directly to identify objects such as applications or facilities. It is also used as a component of
other data types where it is typically an assigning authority for an identifier. It may be used to identify a URI. Where this capability
is used in this specification, that usage is described separately. Note that the HD data type has been constrained to carry an OID
identifying an application, a facility or an assigning authority.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 101
© 2012 Health Level Seven International. All rights reserved.
7.14 ID – CODED VALUE FOR HL7-DEFINED TABLES
TABLE 2-17 – CODED VALUE FOR HL7-DEFINED TABLES (ID)
SEQ
1
LEN
DT
Usage
Variable
R
Component Name
Value
Set
Comments
Coded Value for HL7-Defined Tables
Definition: Used to communication values defined in HL7-Defined Tables.
7.15 IS – CODED VALUE FOR USER-DEFINED TABLES
TABLE 2-18 – CODED VALUE FOR USER-DEFINED TABLES (ID)
SEQ
1
LEN
DT
Usage
20
R
Component Name
Value
Set
Comments
Coded Value for User-Defined Tables
Definition: Used to communication values defined in User-Defined Tables.
7.16 MSG – MESSAGE TYPE
TABLE 2-19 – MESSAGE TYPE (MSG)
SEQ
1
2
3
LEN
3
3
7
DT
Usage
ID
ID
ID
R
R
R
Value
Set
HL70076
HL70003
HL70354
Component Name
Comments
Message Code
Trigger Event
Message Structure
Definition: This field contains the message type, trigger event, and the message structure ID for the message.
Page 102
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.17 NM – NUMERIC
TABLE 2-20 – NUMERIC (NM)
SEQ
LEN
1
DT
16
Usage
Component Name
Value
Set
R
Comments
Numeric
Definition: A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an
optional decimal point. In the absence of a sign, the number is assumed to be positive. If there is no decimal point the number is assumed
to be an integer.
7.18 PT – PROCESSING TYPE
TABLE 2-23 – PROCESSING TYPE (PT)
1
2
SEQ
1
LEN
ID
ID
DT
Usage
R
X
Value Set
HL70103
Component Name
Processing ID
Processing Mode
Comments
Not Supported
Definition: This data type indicates whether to process a message as defined in HL7 Application (level 7) Processing rules.
7.19 RP – REFERENCE POINTER
TABLE 2-24 – REFERENCE POINTER (RP)
SEQ
LEN
1
999
2
2.1
20
DT
Usage
Value
Set
Component Name
ST
R
Pointer
HD
R
Application ID
IS
O
Namespace ID
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comments
Pointer to the object. For URIs, it contains the path and query
parts.
Example:
/library/committees/orders/minutes/OO_Minutes_20100101.pdf
Length of RP-1 is based on pre-adoption of HL7 Version 2.6
standards.
Unique identifier of the application that holds the object being
pointed to. For URIs, it contains the scheme and authority
parts.
Page 103
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-24 – REFERENCE POINTER (RP)
SEQ
3
LEN
DT
Usage
Value
Set
Component Name
2.2
999
ST
R
2.3
6
11
ID
ID
R
RE
HL70301
HL70834
Universal ID Type
Type of Data
32
ID
RE
HL70291
Subtype
4
Universal ID
Comments
Field that, for URIs, contains the scheme and authority parts.
Example: http://www.hl7.org
Field that, for URIs, contains the literal value ‘URI’.
Identifier of the type of data pointed to. For the URI example
above, this is ‘application’
Identifier of the subtype of data pointed to. For the URI
example above, this is .pdf, for portable document format.
Definition: This data type transmits information about data stored on another system. It contains a reference pointer that uniquely
identifies the data on the other system, the identity of the other system, and the type of data.
Usage: Field using the RP data type to allow communication of pointers to images, sound clips, XML documents, html markup,
etc. The RP data type is used when the object being pointed to is too large to transmit directly.
This specification defines the mechanism for exchanging pointers to objects, but does not address the details of applications
actually accessing and retrieving the objects over a network.
The most common scheme for passing a pointer is to use a Universal Resource Identifier (see http://ietf.org/rfc/rfc2396.txt for a
detailed definition). The general format of a URI is in the form: <scheme>://<authority><path>?<query>. The scheme and
authority portions appear in the Application ID component, Universal ID subcomponent. The path and query portion of the URI
appear in the Pointer component of the RP data type.
7.20 SAD – STREET ADDRESS
TABLE 2-26 – STREET ADDRESS (SAD)
SEQ
1
2
3
LEN
50
DT
Usage
ST
ST
ST
Page 104
© 2012 Health Level Seven International. All rights reserved.
R
X
X
Value
Set
Component Name
Street or Mailing Address
Street Name
Dwelling Number
Comments
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Definition: This data type specifies an entity's street address and associated detail.
Usage: The SAD is used only as a component of the XAD data type.
7.21 SI – SEQUENCE ID
TABLE 2-27 – SEQUENCE ID (SI)
SEQ
1
LEN
DT
Usage
4
R
Component Name
Value
Set
Sequence ID
Comments
Non-negative integer up to 9999. May
be further constrained to limit the number
of times a segment may repeat.
Definition: A non-negative integer in the form of a NM field. The uses of this data type are defined in the chapters defining the segments
and messages in which it appears.
7.22 SN – STRUCTURED NUMERIC
TABLE 2-28 – STRUCTURED NUMERIC (SN)
SEQ
LEN
DT
Usage
Component Name
Value
Set
1
2
ST
RE
Comparator
2
3
16
1
NM
ST
RE
RE
Num1
Separator/Suffix
4
16
NM
RE
Num2
Comments
Component that must be one of ">" or
"<" or ">=" or "<=" or "=" or "<>". This
component defaults to "=" if empty.
Component that must be one of "-" or "+"
or "/" or "." or ":".
Definition: The structured numeric data type is used to unambiguously express numeric clinical results along with qualifications. This
enables receiving systems to store the components separately, and facilitates the use of numeric database queries. The corresponding
sets of values indicated with the <comparator> and <separator/suffix> components are intended to be the authoritative and complete set
of values. If additional values are needed for the <comparator> and <separator/suffix> components, they should be submitted to HL7 for
inclusion in the Standard.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 105
© 2012 Health Level Seven International. All rights reserved.
If <num1> and <num2> are both non-null, then the separator/suffix must be non-null. If the separator is "-", the data range is inclusive;
e.g., <num1> - <num2> defines a range of numbers x, such that: <num1> <=x<= <num2>.
Usage: The SN data type carries a structured numeric value. Structured numeric values include intervals (^0^-^1), ratios (^1^/^2 or
^1^:^2), inequalities (<^10), or categorical results (2^+).
7.23 ST – STRING DATA
TABLE 2-29 – STRING DATA (ST)
SEQ
1
LEN
DT
Usage
999
Value
Set
R
Component Name
Comments
String Data
Definition: The ST data type is normally used for short text strings.
Usage: No leading blanks (space characters) are permitted. Trailing blanks are permitted.
7.24 TX – TEXT DATA
TABLE 2-32 – TEXT DATA (TX)
SEQ
1
LEN
65536
DT
Usage
R
Value Set
Component Name
Text Data
Comments
Definition: The TX data type is used to carry string data intended for display purposes.
Usage: It can contain leading blanks (space characters).
7.25 VID – VERSION IDENTIFIER
TABLE 2-33 – VERSION IDENTIFIER (VID)
SEQ
1
2
3
LEN
3
DT
ID
CWE
CWE
Usage
R
X
X
Value Set
HL70104
Page 106
© 2012 Health Level Seven International. All rights reserved.
Component Name
Version ID
Internationalization Code
International Version ID
Comments
Fixed to value ‘”2.6” in this guide.
Not Supported
Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.26 XAD – EXTENDED ADDRESS
TABLE 2-34 – EXTENDED ADDRESS (XAD)
SEQ
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
LEN
50
50
60
12
3
3
2
DT
SAD
ST
ST
ST
ST
ID
ID
ST
IS
IS
ID
DR
TS
TS
CWE
ID
ID
ID
ST
ST
NM
CWE
Usage
RE
RE
RE
RE
RE
RE
X
X
RE
X
X
X
X
X
X
X
X
X
X
X
X
X
Value Set
ISO 3166-1
Component Name
Street Address
Other Designation
City
State or Province
Zip or Postal Code
Country
Address Type
Other Geographic Designation
County/Parish Code
Census Tract
Address Representation Code
Address Validity Range
Effective Date
Expiration Date
Expiration Reason
Temporary Indicator
Bad Address Indicator
Address Usage
Addressee
Comment
Preference Order
Protection Code
Comments
2nd address line
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Not Supported
Definition: This data type specifies the address of a person, place or organization plus associated information.
7.27 XCN – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
SEQ
1
LEN
20
DT
ST
Usage
RE
Value Set
Component Name
ID Number
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Comments
If this is a person, the ID must be
accompanied by an OID for the
Page 107
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
SEQ
2
3
4
LEN
50
50
DT
Usage
FN
ST
ST
RE
RE
RE
5
6
7
8
9
10
10
ST
ST
IS
IS
HD
RE
RE
X
X
RE
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1
ID
ST
ID
ID
HD
ID
CWE
DR
ID
TS
TS
ST
CWE
CWE
RE
X
X
RE
X
X
X
X
X
X
X
RE
X
X
3
5
10
Value Set
Component Name
Family Name
Given Name
Second and Further Given Names or
Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Source Table
Assigning Authority
HL70200
HL70061
HL70203
Name Type Code
Identifier Check Digit
Check Digit Scheme
Identifier Type Code
Assigning Facility
Name Representation Code
Name Context
Name Validity Range
Name Assembly Order
Effective Date
Expiration Date
Professional Suffix
Assigning Jurisdiction
Assigning Agency or Department
Comments
assigning authority (component 9). If this
is an organization, the OID for the
organization should be provided here.
Not supported
Not supported
Condition rule: Required if component 1
(ID Number) is populated.
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Usage: This data type is used where there is a need to specify the ID number and name of a person.
Page 108
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
7.28 XON – EXTENDED COMPOSITE NAME AND IDENTIFICATION NUMBER FOR ORGANIZATIONS
TABLE 2-36 – EXTENDED COMPOSITE NAME AND IDENTIFICATION NUMBER FOR ORGANIZATIONS (XON)
SEQ
1
2
3
4
5
6
LEN
100
1
DT
ST
IS
NM
NM
ID
HD
7
8
9
10
5
ID
HD
ID
ST
30
Usage
R
R
X
X
X
CE
Value Set
HL70204
X
X
X
RE
Component Name
Organization Name
Organization Name Type Code
ID Number
Check Digit
Check Digit Scheme
Assigning Authority
Identifier Type Code
Assigning Facility
Name Representation Code
Organization Identifier
Comments
Fixed to a value of “L”
Not supported
Not supported
Not supported
Condition rule: Required if component 10
(organization identifier) is populated.
Not Supported
Not supported
Not supported
Definition: This data type is used to specify the name and ID number of an organization.
7.29 XPN – EXTENDED PERSON NAME
TABLE 2-37 – EXTENDED PERSON NAME (XPN)
SEQ
1
2
3
4
5
6
7
8
9
10
11
12
13
LEN
50
50
10
10
1
DT
FN
ST
ST
ST
ST
IS
ID
ID
CWE
DR
ID
TS
TS
Usage
RE
RE
RE
RE
RE
RE
RE
X
X
X
X
X
X
Value Set
HL70200
Family Name
Given Name
Second and Further Given Names or Initials Thereof
Suffix (e.g., JR or III)
Prefix (e.g., DR)
Degree (e.g., MD)
Name Type Code
Name Representation Code
Name Context
Name Validity Range
Name Assembly Order
Effective Date
Expiration Date
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Component Name
Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Page 109
© 2012 Health Level Seven International. All rights reserved.
TABLE 2-37 – EXTENDED PERSON NAME (XPN)
SEQ
14
LEN
50
DT
ST
Usage
RE
Value Set
Component Name
Professional Suffix
Comments
Definition: This data type specifies the name of a person plus associated information.
7.30 XTN – EXTENDED TELECOMMUNICATION NUMBER
TABLE 2-37 – EXTENDED TELECOMMUNICATION NUMBER (XTN)
SEQ
1
2
3
4
5
6
7
8
9
10
LEN
3
8
100
3
5
9
5
199
4
DT
Usage
ID
ID
ST
NM
NM
NM
NM
ST
ST
X
RE
RE
R
X
X
X
X
X
X
Value
Set
HL70201
HL70202
Component Name
Telephone Number
Telecommunication Use Code
Telecommunication Equipment Type
Communication Address
Country Code
Area/City Code
Local Number
Extension
Any Text
Extension Prefix
Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
Definition: This data type specifies the telecommunications numbers for a person, place or organization plus associated information.
Page 110
© 2012 Health Level Seven International. All rights reserved.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
