Escolar Documentos
Profissional Documentos
Cultura Documentos
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 HL7s 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 HL7s 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
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
TABLE OF CONTENTS
1
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
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
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
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.
Physicians 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.
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
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
January 2012
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Query Parameters
>FN (Given Names), LN, DOB, Admin Sex for
Candidates
>For Donor Record, use only donor id
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
P. Loyd
11/8
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 9
P. Loyd
11/8
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
Closed
12
P. Loyd
11/8
Closed
13
P. Loyd
11/8
Closed
14
P. Loyd
11/8
Closed
15
P. Loyd
11/8
Need a profileID
PEL> One is recommended
Closed
16
P. Loyd
11/8
Closed
17
P. Loyd
11/8
Closed
18
P. Loyd
11/8
Closed
19
P. Loyd
11/8
Closed
20
P. Loyd
11/9
Closed
21
P. Loyd
11/9
Closed
22
P. Loyd
11/9
Closed
23
P. Loyd
11/9
Closed
Page 10
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
PEL> All places where the limit was 999 has been
restricted. Needs review by team.
24
P. Loyd
11/9
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
Closed
27
P. Loyd
11/9
Closed
28
P. Loyd
12/6
Closed
29
P. Loyd
12/6
Closed
30
P. Loyd
12/13
Closed
31
P. Loyd
12/30
Closed
32
P. Loyd
12/30
Closed
33
P. Loyd
12/30
Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 11
Page 12
P. Loyd
1/15/2011
Closed
Jonathan
Presented Use
Cases to
Patrick for
inclusion.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
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.
Suggested
Encoding
Value
Character
Segment
Terminator
<cr>
Field Separator
Component
Separator
Repetition
Separator
Escape Character
Position
Description
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 13
Subcomponent
Separator
Suggested
Encoding
Value
&
Character
Position
Description
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.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
only snapshot processing applies. For the purpose of this guide, only snapshot processing is supported
for segments, segment groups and fields.
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.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 15
Page 16
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
Page 17
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.
Page 18
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
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
3.5
INTERACTIONS
TABLE 3-2 INTERACTIONS
Interaction
No.
Event
Query for Donor
Candidates (Q33)
Description
Query request candidate
donor information
Registration (O43)
Registration (O43)
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 Registration
System
Donor Book of Record
System
Donor Registration
System
Donor Registration
System
Donor Registration
System
Donor Registration
System
Donation System
Donor Registration
System
Electronic Medical
Questionnaire System
Donor Registration
Mini-Physical System
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
(O44)
Event
Donor Eligibility
Observations (O45)
Donor Eligibility
Observations (O45)
Donor Eligibility
Observations (O45)
Donor Eligibility
Observations (O45)
Eligibility (O46)
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
Electronic Medical
Questionnaire System
Mini-Physical System
Electronic Medical
Questionnaire System
Mini-Physical 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.
Event
10
10
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
Donor Registration
System
Donation System
Donation System
DPR Donation
Procedure (EVENT
O48)
Donation System
DPR Donation
Procedure (EVENT
O48)
Donation System
Not in scope
Donation System
Shipping System
Not in scope
Donor Registration
System
Shipping System
Not in scope
Shipping System
Not in scope
Shipping System
Receiving System
Not in scope
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
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
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
Not in scope
Devices
Not in scope
Devices
Electronic Medical
Questionnaire System
Mini-Physical System
Not in scope
Provider Master
Not in scope
Provider Master
Not in scope
Provider Master
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.
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
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
January 2012
Required
Description
RE
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
Name
Message Header
[{SFT}]
Software Segment
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]
Not Supported
[1..1]
PID
[1..1]
5.6
[PD1]
Additional Demographics
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
Usage
R
Cardinality
[1..1]
Section
5.3
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
[
PID
Usage
R
Cardinality
[1..1]
Section
5.3
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.
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:
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
QPD
[1..1]
5.16
RCP
[1..1]
5.15
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
MSA
Message Acknowledgement
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
QAK
Query Acknowldgement
[1..1]
5.18
Query acknowledgement
QPD
[1..1]
5.16
Return the query parameters used for selection in this return set.
[1..1000]
[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
Page 29
2012 Health Level Seven International. All rights reserved.
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
Purpose:
Name
Message Header
Usage
R
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
QPD
[1..1]
5.17
RCP
[1..1]
5.15
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
MSA
Message Acknowledgement
[1..1]
5.4
[ERR]
Error
RE
[0..100]
5.5
QAK
Query Acknowldgement
[1..1]
5.18
Query acknowledgement
QPD
[1..1]
5.16
Return the query parameters used for selection in this return set.
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1000]
[1..1]
5.8
RE
[0..100]
5.12
RE
[0..1000]
[
PID
[{
PV1
[{NTE}]
}]
]
Usage
R
Cardinality
[1..1]
Section
5.3
[{
Donation Begin
[{DON}]
Donation
RE
[0..1]
5.13
Donation procedure
[{OBX}]
RE
[0..100]
5.10
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.
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
[1..1]
5.8
RE
[0..100]
5.12
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
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.
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
[1..1]
5.8
Donor Registration
RE
[0..100]
5.12
[1..100]
Observations Request
[1..1]
5.9
RE
[0..100]
5.12
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
RE
[0..1]
[1..1]
5.8
RE
[0..100]
5.12
[1..100]
Observations Request
[1..1]
5.9
RE
[0..100]
5.12
[1..1]
OBX
OBSERVATION Begin
Observations
[1..1]
5.10
[{NTE}]
RE
[0..100]
5.12
[
PID
[
PV1
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
ORDER_OBSERVATION Begin
OBR
[{NTE}]
[{
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 35
2012 Health Level Seven International. All rights reserved.
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
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
[1..1]
5.8
[DON]
RE
[0..1]
5.13
Donation procedure
[{NTE}]
RE
[0..100]
5.12
[
PID
[
]
Usage
R
Cardinality
[1..1]
Section
5.3
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.
Name
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
[1..1]
5.6
[PD1]
RE
[0..1]
5.7
[{OBX}]
Donor Observations
RE
[0..100]
5.10
[{NTE}]
RE
[0..100]
5.12
[{AL1}]
Allergy Information
RE
[0..100]
5.11
Allergy information
RE
[0..1]
PV1
[1..1]
5.8
Donor Registration
RE
[0..100]
5.12
ORDER_OBSERVATION Begin
Observation Request
[1..1]
[1..1]
5.9
RE
[0..100]
5.12
[
PID
[
[{NTE}]
]
]
Usage
R
Cardinality
[1..1]
Section
5.3
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
Message Header
[{SFT}]
Software Segment
Description
The message header (MSH) segment contains information
describing how to parse and process the message.
Not Supported
[UAC]
Not Supported
[1..1]
PID
[1..1]
RE
[0..1]
PV1
[1..1]
5.8
[{NTE}]
RE
[0..100]
5.12
ORDER_OBSERVATION Begin
Observations Request
[1..100]
[1..1]
5.9
RE
[0..100]
5.12
RE
[0..10]
Name
[{
Donation Begin
Usage
R
Cardinality
[1..1]
Section
5.3
[{DON}]
Donation
[1..1]
5.13
Donation procedure
[{OBX}]
RE
[0..100]
5.10
Donation observations
[{NTE}]
RE
[0..10]
5.12
[{
[1..10]
[{BUI}]
[1..1]
5.14
[{NTE}]
RE
[0..100]
5.12
}]
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Page 39
2012 Health Level Seven International. All rights reserved.
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
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
MSA
Message Acknowledgement
[1..1]
5.4
Message Acknowledgement
[{ ERR }]
Error
[0..100]
5.5
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.1
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.
Abbreviation
Len
DT
Usage
Definition
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
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.
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.
Value
RE
Required
Description
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.
Optional
Conditional
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.
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.
Cardinality
[1..1]
ST
[1..1]
HD
RE
[0..1]
HD
[1..1]
Seq
1
4
Len
DT
ST
Page 44
2012 Health Level Seven International. All rights reserved.
Value Set
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Seq
Len
DT
HD
Usage
RE
Cardinality
[0..1]
HD
RE
[0..1]
DTM
[1..1]
8
9
10
ST
MSG
ST
X
R
R
[0..0]
[1..1]
[1..1]
11
PT
[1..1]
12
VID
[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
[0..0]
16
25
Value Set
HL70155
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.
5.4
Len
DT
EI
Usage
R
Cardinality
[1..10]
Value Set
The Message Response Segment (MSA) contains the information sent as acknowledgment to the order message received by a Laboratory
Information System.
Cardinality
[1..1]
ST
[1..1]
3
4
ST
NM
X
X
[0..0]
[0..0]
ID
[0..0]
CWE
[0..0]
Seq
Len
25
DT
ID
Page 46
2012 Health Level Seven International. All rights reserved.
Value Set
HL70008
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
5.5
Seq
Len
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
[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
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
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
The Patient Identification Segment (PID) is used to provide basic demographics regarding the donor. The subject must be a person (no animals).
Seq
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
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]
XPN
RE
[0..1]
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,
drivers 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
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]
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]
Seq
8
9
10
Len
20
HL70005
HL70189
HL70172
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
Donors date of birth. The time component is not
supported in this IG.
Donors gender.
Not supported
One or more codes that broadly refer to the donors
race(s).
Donors 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
Active 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
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
Description/Comments
Not supported
Not supported
Not supported
Not supported
Not supported
Not supported
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
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
Len
5.8
DT
IS
IS
IS
DT
Usage
X
X
X
X
Cardinality
[0..0]
[0..0]
[0..0]
[0..0]
Value Set
Description/Comments
Not supported
Not supported
Not supported
Not supported
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 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.
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
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
Seq
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
EI
RE
[0..1]
EI
[1..1]
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 placers 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.
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
Seq
Len
Page 54
2012 Health Level Seven International. All rights reserved.
Value Set
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
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 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.
Seq
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
2
3
ID
CWE
R
R
[1..1]
[1..1]
10
ST
[0..1]
Observation Sub-ID
Var
[1..1]
Observation Value
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
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
[0..0]
25
XCN
[0..0]
Value Set
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.
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
Producers Reference
Responsible Observer
Observation Method
Equipment Instance Identifier
Date/Time of the Analysis
Observation Site
Observation Instance
Identifier
Seq
2
3
4
3
Len
Page 58
2012 Health Level Seven International. All rights reserved.
HL70085
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
Len
DT
CNE
XON
Usage
X
X
Cardinality
[0..0]
[0..0]
24
XAD
[0..0]
25
XCN
[0..0]
Value Set
Not supported
Not supported
Description/Comments
Not supported
Not supported
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.
Description
(drug) on the list of products which
automatically cause a donation deferral.
OBX-2 DT
DMEDN
CWE
DMEDC
CWE
DMEDO
DMEDD
OMED
ID
DTM
ID
OMEDN
CWE
OMEDC
CWE
OMEDO
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
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.
Seq
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
HL70125
2
3
ID
CWE
R
R
[1..1]
[1..1]
10
ST
[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
[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
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
[0..0]
25
XCN
[0..0]
Value Set
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.
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
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
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
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.
Seq
Len
DT
SI
Usage
R
Cardinality
[1..1]
Value Set
2
3
705
CWE
CWE
X
R
[0..0]
[1..1]
4
5
6
705
15
8
CWE
ST
DT
X
X
X
[0..0]
[0..0]
[0..0]
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
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).
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
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
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 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.
Page 67
2012 Health Level Seven International. All rights reserved.
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]
34
XON
[1..1]
Collection Facility
HL70136
Description/Comments
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
Usage
Cardinality
SI
[1..1]
Set ID BUI
EI
[1..1]
CNE
[1..1]
NM
[1..1]
CNE
[1..1]
NM
[1..1]
CNE
[1..1]
ST
[1..1]
ST
[1..1]
10
XON
RE
[1..1]
Seq
Len
Value Set
HL70566
Weight Units
Blood Unit Volume
HL70568
Volume Units
Container Catalog Number
NM
[1..1]
12
CNE
[1..1]
Transport Temperature
HL70569
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
Container Manufacturer
11
Description/Comments
Page 69
2012 Health Level Seven International. All rights reserved.
5.19
The RCP segment is used to restrict the amount of data that should be returned in response to query.
Cardinality
ID
[0..0]
CQ
[1..1]
CNE
DTM
Seq
Len
DT
Value Set
Description/Comments
Query Priority
Not Supported
[0..0]
Response Modality
Not Supported
[0..0]
ID
[0..0]
SRT
[0..0]
Sort-by Field
Not Supported
ID
[0..0]
Not Supported
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
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL Segment
Field
Search
0471
Name
MessageQueryName
60
CWE
N/A
QueryTag
32
ST
N/A
DonorLastName
50
ST
RE
N/A
PID.5
DonorFirstName
50
ST
RE
N/A
PID.5
DonorDOB
DTM
RE
N/A
PID.7
DonorSex
IS
RE
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
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.
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
Field
Seq
Sort
Key/
LEN
TYPE
Opt
Rep
Match Op
TBL
Search
MessageQueryName
60
CWE
N/A
QueryTag
32
ST
N/A
DonorIdentifier
20
ST
RE
N/A
5.22
0471
Segment
Field
Name
PID.3
Service
Identifier
Element Name
Code
PID-3 Patient
Identifier List
Len
DT
Usage
Cardinality
Value Set
ST
[0..0]
Query Tag
Query Response Status
ID
RE
[0..1]
250
CWE
RE
[0..1]
10
NM
RE
[0..1]
10
NM
RE
[0..1]
This payload
10
NM
RE
[0..1]
Hits remaining
HL70471
Not Supported
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.
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
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.
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
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.
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
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
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
Description
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.
Description
Production
Training
Usage
R
R
Comment
Description
Coded Entry
Usage
R
CWE
DT
ED
Date
Encapsulated Data
R
R
FT
NM
Numeric
RP
Reference Pointer
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
Description
Usage
SN
Structured Numeric
ST
String Data
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.
Value
Yes
No
Description
Usage
R
R
Comment
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.
Description
Successful completion only
Usage
O
Comment
Value
Description
Hispanic or Latino
Not Hispanic or Latino
Unknown
Usage
R
R
R
Comment
Value
Home
Description
Office/Business
Usage
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.
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
Value
Description
Name at Birth
Legal Name
Maiden Name
Nickname /Call me Name/Street Name
Usage
R
R
R
R
Comment
Description
Primary Residence Number
Work Number
Personal
Usage
R
R
R
Comment
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.
Description
Birth Certificate
CZ
Citizenship Card
DL
DR
HC
MI
R
R
R
R
MR
NI
NNxxx
PI
PN
Person number
PPN
Passport number
SS
Page 82
2012 Health Level Seven International. All rights reserved.
Usage
R
Comment
A number associated with a document identifying the event of
a persons birth.
A number assigned by a persons country of residence to
identify a persons citizenship.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
January 2012
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.
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
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.
Value
Description
Clinic
Department
Home
Nursing Unit
Providers Office
Phone
SNF
Usage
R
R
R
R
R
R
R
Comment
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
Value
Description
Message accepted
Usage
R
100
101
102
R
R
103
200
201
202
203
204
R
R
R
R
R
205
206
207
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.
Description
Usage
Comment
99zzz or L
UBNRCSS
UBNRCSS
IBTnnnn
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.
Description
a specific table within ISBT 128.
Usage
Comment
The variable suffix (nnnn) identifies a specific table within ISBT 128.
UCUM
Description
Query to retrieve Donor Record Candidates
Query to retrieve a Donor Record
Usage
R
R
Comment
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
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
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
Usage
R
R
R
R
R
R
R
R
R
R
R
R
R
Comment
Description
Process was not interrupted
Walk Out: Process interrupted before the Phlebotomist
inserts the needle in the Donors arm
Aborted Run: Process interrupted after the Phlebotomist
inserts the needle in the Donors 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.
Description
No reason given, donor decided to stop
without giving a reason
Phone Call-Donor
Couldnt wait
Couldnt 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
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
Description
Instrument Power Failure
Air Contamination
Usage
R
R
Comment
Description
Successful
Not Drawn
UL5
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
Value
Left Arm
Right Arm
Both Arms
Description
Usage
R
R
R
Comment
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.
Description
Plasma
Platelets
Granulocytes
Peripheral Stem Cells
Lymphocytes
Usage
R
R
R
R
R
Comment
Pound
Ounce
Kilogram
Gram
Description
Usage
R
R
R
R
Comment
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
Description
Degrees Fahrenheit
Degrees Celsius
Usage
R
R
Comment
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.
CNE
CNN
CQ
CWE
CX
DTM
Date/Time
ED
Encapsulated Data
EI
Entity Identifier
FN
Family Name
FT
HD
Hierarchic Designator
ID
IS
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
SN
Structured Numeric
ST
String
TX
Text Data
VID
Version Identifier
XAD
Extended Address
XCN
XON
XPN
XTN
Length
999
65536
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.
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: 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
LEN
30
200
DT
ST
ST
Usage
RE
RE
Value Set
20
ID
CE
HL70396
4
5
6
ST
ST
ID
X
X
X
7
8
ST
ST
X
X
ST
Component Name
Identifier
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.
LEN
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 persons 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
LEN
DT
16
Usage
Value
R
RE
UCUM
NM
CWE
Set
Comments
Component
Name
Quantity
Units
LEN
1
2
30
200
ST
ST
RE
RE
20
ID
CE
4
5
6
ST
ST
ID
X
X
X
ST
ST
ST
RE
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
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.
LEN
30
2
3
4
5
6
7
8
9
10
DT
Usage
ST
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
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
LEN
24
DT
Usage
Value Set
Comments
Component
Name
Date/Time
Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]
LEN
DT
Usage
HD
RE
Value Set
Component
Name
Source Application
ID
HL70191
Type of Data
18
ID
RE
HL70291
Data Subtype
ID
HL70299
Encoding
65536
TX
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.
LEN
DT
Usage
30
ST
20
IS
999
ST
ID
Value
Set
HL70300
HL70301
Component Name
Comments
Entity Identifier
Namespace ID
Universal ID
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.
LEN
50
DT
Usage
ST
ST
ST
ST
R
X
X
X
ST
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
LEN
DT
65536
Usage
R
Component Name
Value
Set
Comments
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.
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.
LEN
DT
Usage
Variable
Component Name
Value
Set
Comments
LEN
DT
Usage
20
Component Name
Value
Set
Comments
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
DT
16
Usage
Component Name
Value
Set
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.
SEQ
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.
LEN
999
2
2.1
20
DT
Usage
Value
Set
Component Name
ST
Pointer
HD
Application ID
IS
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.
LEN
DT
Usage
Value
Set
Component Name
2.2
999
ST
2.3
6
11
ID
ID
R
RE
HL70301
HL70834
Universal ID Type
Type of Data
32
ID
RE
HL70291
Subtype
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.
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
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.
LEN
DT
Usage
Component Name
Value
Set
ST
RE
Comparator
2
3
16
1
NM
ST
RE
RE
Num1
Separator/Suffix
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^+).
LEN
DT
Usage
999
Value
Set
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.
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).
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
LEN
50
50
60
12
3
3
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.
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
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
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
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.
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
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.
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