Professional Documents
Culture Documents
How To Xmatch Blood-Bank 20202104 Yy
How To Xmatch Blood-Bank 20202104 Yy
Sponsored by:
Orders and Observations Work Group
Copyright © 2012 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is
strictly forbidden without the written permission of the publisher. HL7 and Health Level Seven are registered trademarks of
Health Level Seven International. Reg. U.S. Pat & TM Off.
IMPORTANT NOTES:
HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from
HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license,
please visit http://www.HL7.org/implement/standards/index.cfm.
If you are the individual that obtained the license for this HL7 Standard, specification or other
freely licensed work (in each and every instance "Specified Material"), the following describes the
permitted uses of the Material.
A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to
the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified
Material to develop and sell products and services that implement, but do not directly incorporate, the
Specified Material in whole or in part without paying license fees to HL7.
B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are
authorized, without additional charge, on a perpetual (except as provided for in the full license terms
governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal
purposes only) and share this Material with your employees and consultants for study purposes, and (b)
utilize the Material for the purpose of developing, making, having made, using, marketing, importing,
offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all
cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual
property rights of third parties (which may include members of HL7). No other license, sublicense, or
other rights of any kind are granted under this Agreement.
C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are
authorized, without additional charge, to read and use the Specified Material for evaluating whether to
implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell
products and services that implement, but do not directly incorporate, the Specified Material in whole or in
part.
NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into
products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL
MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7.
Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.
Page 2 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
Acknowledgements
Chapter Chair: Hans Buitendijk
Siemens Medical Solutions Health Services Corporation
Chapter Chair: Patrick Loyd
Gordon Point Informatics Ltd.
Chapter Chair: Austin Kreisler
SAIC - Science Applications International Corp
Chapter Chair: Ken McCaslin
Quest Diagostics, Incorporated
Chapter Chair: Rob Hausam
OntoReason
Project chair and Principal Patrick Loyd
Author: Gordon Point Informatics Ltd.
Project Chair and Coordinator: 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 Organization
Jonathan Harber* Blood Systems, Inc.
Rodeina Davis* Blood Center of Wisconsin
Melinda Bryant ITSynergistics
Amit Bhagat Blood Center of Wisconsin
Shri Potdar Mediware
Patrick Loyd* GPI
Robert Kapler ABC
Pat Distler ICCBBA
Patti Larson* Haemonetics
Ruth Harkin NY Blood Center
Peggy Dunn Puget Sound Blood Center
Goudar Shankar Carter BloodCare
Jeff Wurst BBCS
Sue McBride MAK-System
Philip Abrams Talisman
Suzanne Nagami* Kaiser Permanente
David Eide* Group Health Cooperative
Joe Foster Fenwal
Rick Stone Healthcare-ID
Troy Campbell Florida Blood Services
Bob Diol Blood Center of Wisconsin
* Denotes HL7 OO Work Group Member
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 3
January 2012 © 2012 Health Level Seven International. All rights reserved.
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
2 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
3 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
4 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
5 SEGMENT AND FIELD DESCRIPTIONS .................................................................................................... 42
5.1 Segment Attribute Table Abbreviations ................................................................................................ 42
5.2 Segment Usage Definitions .................................................................................................................. 43
5.3 MSH – Message Header Segment ....................................................................................................... 44
5.4 MSA – Acknowledgement Segment ..................................................................................................... 46
5.5 ERR – Error Segment ........................................................................................................................... 47
5.6 PID – Patient Identification Segment .................................................................................................... 48
5.7 PD1 – Patient Additional Demographic................................................................................................. 50
5.8 PV1 – Patient Visit Information ............................................................................................................. 51
5.9 OBR – Observation Request Segment ................................................................................................. 53
5.10 OBX – Observation Result Segment (Questionnaire Responses and Mini-Physical) ...................... 56
Page 4 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.11 OBX – Observation Result Segment (Donor) ................................................................................... 58
5.12 OBX - Observation Identifiers (Donor) .............................................................................................. 59
5.13 OBX – Observation Result Segment (Donation and Adverse Events) ............................................. 62
5.14 OBX - Observation Identifiers (donation and Adverse Events) ......................................................... 63
5.15 AL1 – Patient Allergy Information Segment ...................................................................................... 65
5.16 NTE – Notes and Comments Segment ............................................................................................ 66
5.17 DON - Blood Bank Donation Segment ............................................................................................. 67
5.18 BUI – Blood Unit Information Segment ............................................................................................. 69
5.19 RCP – Response Control Parameter Segment ................................................................................ 70
5.20 QPD – Query Parameter Definition Segment – For Event Q33 ........................................................ 71
5.21 QPD – Query Parameter Definition Segment – For Event Q34 ........................................................ 73
5.22 QAK – Query Acknowledgement Segment....................................................................................... 73
6 CODE SYSTEMS AND VALUE SETS ......................................................................................................... 74
6.1 Code Table Abbreviations..................................................................................................................... 75
6.2 User-Defined Table HL70001 – Administrative Sex.............................................................................. 75
6.3 User-Defined Table HL70003 – Event Type ......................................................................................... 76
6.4 User-Defined Table HL70005 – Race ................................................................................................... 76
6.5 HL7 Table HL70008 – Acknowledgement Code ................................................................................... 77
6.6 HL7 Table HL70076 – Message Type .................................................................................................. 77
6.7 HL7 Table HL70103 – Processing ID ................................................................................................... 77
6.8 HL7 Table HL70125 – Value Type........................................................................................................ 78
6.9 HL7 Table HL70136 - Yes/No Indicator ................................................................................................ 79
6.10 HL7 Table HL70155 – Accept/Application Acknowledgment Conditions .......................................... 79
6.11 User-Defined Table HL70189 – Ethnic Group .................................................................................. 80
6.12 User-Defined Table HL70190 - Address type ................................................................................... 80
6.13 HL7 Table HL70191 – Type Of Referenced Data ............................................................................. 80
6.14 HL7 Table HL70200 - Name Type .................................................................................................... 81
6.15 HL7 Table HL70201 - Telecommunication use code ........................................................................ 81
6.16 HL7 Table HL70202 - Telecommunication Equipment Type code ................................................... 81
6.17 HL7 Table HL70203 – Identifier Type ............................................................................................... 82
6.18 External Table HL70291 – Sub Type Of Referenced Data ............................................................... 83
6.19 HL7 Table HL70299 – Encoding....................................................................................................... 83
6.20 User-Defined Table HL70300 – Namespace ID ............................................................................... 83
6.21 User-Defined Table HL70305 – Person Location Type .................................................................... 84
6.22 HL7 Table HL70354 – Message Structure ....................................................................................... 84
6.23 HL7 Table HL70357 – Message Error Condition Codes................................................................... 85
6.24 Hl7 Table HL70396 – Coding System .............................................................................................. 85
6.25 User-Defined Table HL70471 – Query Name................................................................................... 86
6.26 HL7 Table HL70516 – Error Severity................................................................................................ 86
6.27 User-Defined Table HL70559 – Duration Units ................................................................................ 86
6.28 User-Defined Table HL70560 – Blood Procedure Type ................................................................... 87
6.29 User-Defined Table HL70561 – Process Interruption ....................................................................... 87
6.30 User-Defined Table HL70562 – Process Interruption Reason.......................................................... 88
6.31 User-Defined Table HL70564 – Phlebotomy Issue........................................................................... 88
6.32 User-Defined Table HL70563 – Phlebotomy Status ......................................................................... 89
6.33 User-Defined Table HL70565 – Arm Stuck ...................................................................................... 89
6.34 User-Defined Table HL70566 – Blood Unit Type ............................................................................. 89
6.35 User-Defined Table HL70567 – Weight Units................................................................................... 90
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 5
January 2012 © 2012 Health Level Seven International. All rights reserved.
6.36 User-Defined Table HL70568 – Volume Units.................................................................................. 90
6.37 User-Defined Table HL70569 – Temperature Units ......................................................................... 91
6.38 HL7 Table HL70834 – MIME Type ................................................................................................... 91
7 Data Types ................................................................................................................................................... 92
7.1 Data Types Summary ........................................................................................................................... 92
7.2 Data Type Table Abbreviations............................................................................................................. 93
7.3 CNE – Coded No Exceptions................................................................................................................ 95
7.4 CNN – Composite ID Number and Name Simplified............................................................................. 96
7.5 CQ – Composite Quantity with Units .................................................................................................... 97
7.6 CWE – Coded with Exceptions ............................................................................................................. 97
7.7 CX – Extended Composite ID with Check Digit .................................................................................... 98
7.8 DTM – Date/Time.................................................................................................................................. 99
7.9 ED – Encapsulated Data....................................................................................................................... 99
7.10 EI – Entity Identifier......................................................................................................................... 100
7.11 FN – Family Name .......................................................................................................................... 100
7.12 FT – Formatted Text Data .............................................................................................................. 101
7.13 HD – Hierarchic Designator ............................................................................................................ 101
7.14 ID – Coded Value for HL7-Defined Tables ..................................................................................... 102
7.15 IS – Coded Value for User-Defined Tables .................................................................................... 102
7.16 MSG – Message Type .................................................................................................................... 102
7.17 NM – Numeric ................................................................................................................................. 103
7.18 PT – Processing Type .................................................................................................................... 103
7.19 RP – Reference Pointer .................................................................................................................. 103
7.20 SAD – Street Address..................................................................................................................... 104
7.21 SI – Sequence ID............................................................................................................................ 105
7.22 SN – Structured Numeric ................................................................................................................ 105
7.23 ST – String Data ............................................................................................................................. 106
7.24 TX – Text Data................................................................................................................................ 106
7.25 VID – Version Identifier ................................................................................................................... 106
7.26 XAD – Extended Address ............................................................................................................... 107
7.27 XCN – Extended Composite ID Number and Name for Persons.................................................... 107
7.28 XON – Extended Composite Name and Identification Number for Organizations .......................... 109
7.29 XPN – Extended Person Name ...................................................................................................... 109
7.30 XTN – Extended Telecommunication Number ............................................................................... 110
Page 6 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
1 INTRODUCTION
1.1 PURPOSE
The HL7 Blood Bank Donation Services Implementation Guide – U.S. Realm is a messaging specification
intended to standardize the electronic transmission of information between system application
components in a Blood Bank setting. While this is U.S. Realm specific, there are no constraints that are
U.S. specific; rather the project team did not include sufficient International stakeholder representation to
assert the outcome and this Implementation Guide is Universal in nature.
This Implementation Guide is specific to the interoperability to support activities related to the registration,
screening for eligibility, donation, and collection of blood from a human. The goal of this specification is to
provide an applicable specification that can be adopted as an industry standard, thereby obviating the
need for individual vendors to define anew the specifications of each Donation Service interface required.
1.2 AUDIENCE
The standards defined in this guide are intended for use by clinical data exchange systems found in the
Blood Donation community groups listed below:
• Blood Centers in the United States of America - Any service center that performs the collection of
blood.
• Physician’s Offices – Any care practice, clinic, hospital, individual physician, or department that
orders directed or autologous (self) donations.
1.3 SCOPE
This specification focuses exclusively on the electronic transfer of information between system application
components used to support activities for the collection and donation of blood. This Implementation
Guide does not include:
• definition for maintaining a registry of providers who can ‘order’ blood donations.
• definition for communication between automated lab testing devices and Lab Information
Systems.
• definition for communicating shipping information.
Although this Implementation Guide does not include the definitions immediately foregoing in this
paragraph, reuse of the information in this document to aid activities designed to automate those
definitions is not precluded.
The remainder of this document specifies the dynamic and static aspects of this Implementation Guide.
Although this document describes the elements of HL7 messages and messaging interactions as they
relate to this specification, it does not constitute an introduction to HL7. Readers unfamiliar with HL7
should first review the HL7 2.x standard (especially Chapters 4 and 7), available to HL7 members or for
purchase at www.hl7.org.
1.4 ASSUMPTIONS
This document assumes that users have a need to electronically exchange blood donation services
information. It also assumes that the user is familiar with the HL7 v2.6 standard.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 7
January 2012 © 2012 Health Level Seven International. All rights reserved.
1.5 CONVENTIONS
This specification is based on the HL7 version 2.6 messaging standard. Because the v2.6 HL7 Standard
does not contain relevant elements to communicate blood donation information, two segments (DON –
Blood Donation Segment & BUI – Blood Unit Information) and all the message types are pre-adopted
from the HL7 v2.8 Standard.
Note that the HL7 v2.8 Standard is still in ballot along with this document and, therefore, there is some risk of change. However,
stakeholders interested in blood donation messaging based on HL7 v2.x were invited to participate with the project team to
minimize risk of change during balloting and reconciliation.
The specification defines message profiles for relevant HL7 message types. A message profile is an
unambiguous specification of an HL7 message type intended for a particular use case, as defined in
Section 2.12 of the HL7 v2.6 standard.
A message profile defines both the dynamic aspects of information interchange (i.e., the systems that
participate in such interchanges and the real-world events that trigger the interchanges) as well as the
static aspects of messaging (i.e., the structure and contents of the electronic messages that are
exchanged).
• The rules outlined in HL7 2.6, Chapter 2, section 2.12, Conformance Using Message Profiles,
were used to document the use case for, and constraints applied to, the messages described in
this guide.
• Data types have been described separately from the fields that use the data types. For details
regarding data type field lengths, please refer to section 2.3, Lengths, in this document.
Page 8 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
1.6 OPEN ISSUES
1 P. Loyd 11/8 Is this IG US Realm or Universal? Closed
> Believe US Realm; Universal can use it, but
International stakeholders were not vetted.
5 P. Loyd 11/8 Should there be a group around donation. Under what Closed
circumstances is there more than one DON? Check
the minutes to see if we have that point documented
(cause we need it).
>More than one stick, then more than one DON
PEL> fixed cardinality of group vs DON segment for
DPC and RSP
6 P. Loyd 11/8 Section 2.5 – Leave the notes to balloters from the IG Closed
where some of the materials were sourced?
>No, remove them
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 9
January 2012 © 2012 Health Level Seven International. All rights reserved.
> Map to OBX Responsible Observer, use ‘donor’
value or the staff person’s ID when appropriate
10 P. Loyd 11/8 HL7 tables need further constraining: 0008, 0125, Closed. The
0155, 0357, 0516 team reviewed
PEL> 0008, 0155, 0357, 0516 (done) these data
JH, PL> value type 0125 (from min-physical and types and has
questionnaires). What types of values do we expect? agreed that
Team> Review value types included in this profile these types will
be sufficient to
address all
required use
cases
22 P. Loyd 11/9 Namespace methodology was chosen (for now) for Closed
identifiers
23 P. Loyd 11/9 Team to check the lengths of strings (for example, last Closed
name is 999 characters, at the moment)
Page 10 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
PEL> All places where the limit was 999 has been
restricted. Needs review by team.
24 P. Loyd 11/9 What’s the strategy for optional vs. RE (see #21) Closed
28 P. Loyd 12/6 Length (query parameter) for patient id, 20 characters Closed
lastname, 50 characters
firstname, 50 characters
Include time for DOB? No, date only
31 P. Loyd 12/30 Need more information on previous name. The HL7 Closed
standard supports this with effective date ranges for
any and all names and doesn’t support a ‘soft’ concept
like ‘previous’.
JH> Will survey vendors
PEL> Selected ‘B’ and document such from the
mapping document
33 P. Loyd 12/30 Mapping for usual collection location (PV1) and Closed
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 11
January 2012 © 2012 Health Level Seven International. All rights reserved.
collection facility (PDA) seem incorrect. Review with
team at next meeting
34 P. Loyd 1/15/2011 What’s the difference between DON 28 and DON 33? Closed
Jonathan
Presented Use
Cases to
Patrick for
inclusion.
Page 12 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
2 MESSAGING INFRASTRUCTURE
2.1 DELIMITERS
This profile supports the use of the normal HL7 delimiters. It is recommended, but not required, that
implementers be able to send messages using the standard HL7 delimiters. Receivers must, however,
be capable of receiving any legal delimiters that are sent in a particular message instance.
This table is adopted from the HL7 Version v2.6 Standard which offers information regarding Best
Practice. Note that this implementation guide includes additional constraints and explanations for some of
the entries.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 13
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 2-1 – DELIMITERS
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.
Page 14 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
only snapshot processing applies. For the purpose of this guide, only snapshot processing is supported
for segments, segment groups and fields.
In the "snapshot" mode, the information contained in the set of repeating segments or segment groups from the incoming
message replaces the corresponding information in the receiving application. This is equivalent to a deletion of the prior
information followed by the addition of the newly supplied information. In this mode, everything (all repeating segments
and segment groups) must be sent with every subsequent message in the series of messages. There is no other way to
indicate which ones changed and which ones did not.
To specify "delete all of the segments in this repeating group" in the snapshot mode, send a single segment with "delete
data" (indicated by a value of "") in all fields.. This actively signals the receiver that there is information that needs to be
deleted. If no segment were sent, this would equate to "no information." No information should not signal the receiver to
take an action. There would be risk that the receiver might misinterpret the sender's intent. 1
Repetitions of fields shall not have empty repetitions followed by repetitions containing data, except
where the HL7 standard clearly reserves certain repetitions for specific purposes. For instance PID-5,
Patient Name is a repeating field, the first repetition of which is reserved by HL7 for the legal name. In
the case where a name is known for the patient, but is not the legal name, format the name field as
follows: |~lastname^firstname^mi^^^^A|.
2.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.
1
Taken from HL7 v2.6 Standard, Chapter 2, section 2.10.4.1.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 15
January 2012 © 2012 Health Level Seven International. All rights reserved.
3 MESSAGE PROFILE – BLOOD BANK DONATION PROCESS
MESSAGING
The following message profile definitions support communications between systems components often
deployed in a blood donation/collection center.
Page 16 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 17
January 2012 © 2012 Health Level Seven International. All rights reserved.
3.3 ACTORS
As mentioned previously, many of the existing systems used in the donation collection process conduct
all these actions in a single bundled system. Extension of the systems on this page is presented in this
format because there is no standard for that bundling, in any particular implementation any of the named
system components can be implemented on another system and therefore communications to that
component is necessary.
Page 18 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
3.4 DYNAMIC DEFINITION
Item Value
Profile ID USBBDon
HL7 Version 2.6
Accept Acknowledgement AL – Always
Application Acknowledgement Refer to HL7 Table 0155 – Accept/application Acknowledgment conditions for valid values.
Acknowledgement Mode Immediate
Profile Type Realm Constrainable Profile
Message Types See Section 3.5 - Interactions
Encoding A
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 19
January 2012 © 2012 Health Level Seven International. All rights reserved.
3.5 INTERACTIONS
TABLE 3-2 – INTERACTIONS
Interaction
No. Event Description Message Sending Actor Receiving Actor
1 Query for Donor Query request candidate QBP - Get Donor Donor Registration Donor Book of Record
Candidates (Q33) donor information Record Candidates System System
(Event Q33)
2 Donor Candidate Query Query response candidate RSP - Get Donor Donor Book of Record Donor Registration System
Response (K33) donor information Record Candidates System
Response (Event K33)
3 Query for Donor Record Query request donor record QBP - Get Donor Donor Registration Donor Book of Record
(Q34) Record (Event Q34) System System
4 Donor Record Query Query response donor RSP - Get Donor Donor Book of Record Donor Registration System
Response (K34) record Record Response System
(Event K34)
5 Create Donor Record Create donor record DBC – Create Donor Donor Registration Donor Book of Record
(O41) Record Message System System
(Event O41)
5 Update Donor Record Update donor book of DBU - Update Donor Donor Registration Donor Book of Record
(O42) record Record Message System System
(Event O42)
6 Registration (O43) Register donor for potential DRG - Donor Donor Registration Donor Book of Record
donation Registration (Event System System
O43)
6 Registration (O43) Register donor for potential DRG - Donor Donor Registration Donation System
donation Registration (Event System
O43)
7 Donor Eligibility Request Request to conduct Pre- DER - Donor Eligibility Donor Registration Electronic Medical
(O44) donation Tests and Request (Event O44) System Questionnaire System
Physical Exams. May also
include the questions to
ask.
7 Donor Eligibility Request Request to conduct Pre- DER - Donor Eligibility Donor Registration Mini-Physical System
Page 20 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No. Event Description Message Sending Actor Receiving Actor
(O44) donation Tests and Request (Event O44) System
Physical Exams. May also
include the questions to
ask.
8 Donor Eligibility Questionnaire questions DEO - Donor Eligibility Electronic Medical Donor Registration System
Observations (O45) and answers and mini- Observations (Event Questionnaire System
physical observations and O45)
assessments
8 Donor Eligibility Questionnaire questions DEO - Donor Eligibility Mini-Physical System Donor Registration System
Observations (O45) and answers and mini- Observations (Event
physical observations and O45)
assessments
8 Donor Eligibility Questionnaire questions DEO - Donor Eligibility Electronic Medical Donor Book of Record
Observations (O45) and answers and mini- Observations (Event Questionnaire System System
physical observations and O45)
assessments
8 Donor Eligibility Questionnaire questions DEO - Donor Eligibility Mini-Physical System Donor Book of Record
Observations (O45) and answers and mini- Observations (Event System
physical observations and O45)
assessments
9 Eligibility (O46) Communication of the DEL – Donor Eligibility Donor Registration Donor Book of Record
eligibility assessment for (EVENT O46) System System
this donation event (also
used in the case of a
deferral as well as a
successful eligibility
assessment)
9 Eligibility (O46) Communication of the DEL – Donor Eligibility Donor Book of Record Donor Registration System
eligibility assessment for (EVENT O46) System
this donation event (also
used in the case of a
deferral as well as a
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 21
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 3-2 – INTERACTIONS
Interaction
No. Event Description Message Sending Actor Receiving Actor
successful eligibility
assessment)
10 Request to Collect (O47) Donor / Medical Screener DRC – Donor Request Donor Registration Donation System
has completed the to Collect (EVENT System
questionnaire portion of the O47)
medical history
10 Request to Collect (O47) Donor / Medical Screener DRC – Donor Request Donor Book of Record Donation System
has completed the to Collect (EVENT System
questionnaire portion of the O47)
medical history
11 Donation (O48) Messages may transmit the DPR – Donation Donation System Donor Registration System
answers back, or may Procedure (EVENT
simply indicate that donor O48)
is Not Deferred (yet)
11 Donation (O48) Messages may transmit the DPR – Donation Donation System Donor Book of Record
answers back, or may Procedure (EVENT System
simply indicate that donor O48)
is Not Deferred (yet)
12 Products Collected Communication of blood Not in scope Donation System Shipping System
unit information for units
collected
12 Products Collected Communication of blood Not in scope Donor Registration Shipping System
unit information for units System
collected
12 Products Collected Communication of blood Not in scope Donor Book of Record Shipping System
unit information for units System
collected
13 Shipment Manifest Shipping manifest for blood Not in scope Shipping System Receiving System
units collected
14 Donation Request For directed and Not in scope Order Management - Donor Registration System
autologous donations, the Ordering Provider
request from an ordering
Page 22 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 3-2 – INTERACTIONS
Interaction
No. Event Description Message Sending Actor Receiving Actor
provider
14 Donation Request For directed and Not in scope Order Management - Donor Book of Record
autologous donations, the Ordering Provider System
request from an ordering
provider
15 Device Interfaces Communication between Not in scope Devices Electronic Medical
lab testing devices Questionnaire System
15 Device Interfaces Communication between Not in scope Devices Mini-Physical System
lab testing devices
16 Provider Create/Update Communication of provider Not in scope Provider Master Donor Registration System
master file updates
16 Provider Create/Update Communication of provider Not in scope Provider Master Donor Book of Record
master file updates System
16 Provider Create/Update Communication of provider Not in scope Provider Master Donation System
master file updates
16 Provider Create/Update Communication of provider Not in scope Provider Master Electronic Medical
master file updates Questionnaire System
16 Provider Create/Update Communication of provider Not in scope Provider Master Mini-Physical System
master file updates
17 O41, O42, O43, O44, O45, Acknowledgements ACK Varies Varies
O46, O47, O48
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 23
January 2012 © 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.
Abbreviation Definition
Three-character code for the segment and the abstract syntax (e.g., the square and curly braces).
• [ XXX ] Optional
• { XXX } Repeating
Segment • XXX Required
• [{ XXX }] Optional and Repeating
Note that for segment groups there is no segment code present, but the square and curly braces
will still be present.
Name Name of the segment or segment group element.
Use of the segment for this guide. Indicates if the segment is required, optional, or conditional in a
message. Legal values are:
Usage • R – Required. Must always be populated.
• RE – Required, but can be empty.
• X – Not used.
Minimum and maximum number of times the element may appear.
• [0..0] Element never present.
• [0..1] Element may be omitted and can have, at most, one occurrence.
• [1..1] Element must have exactly one occurrence.
Cardinality • [0..n] Element may be omitted or may repeat up to n times.
• [1..n] Element must appear at least once, and may repeat up to n times.
• [0..*] Element may be omitted or repeat an unlimited number of times.
• [1..*] Element must appear at least once, and may repeat unlimited number of times.
• [m..n] Element must appear at least m, and at most, n times.
Section The part of this guide that describes the segment.
Description A short description of the use of the segment.
Note: In the tables throughout this document, Yellow = This Implementation Guide does not support the
use of this item.
Page 24 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 4 -1 – MESSAGE USAGE DEFINITIONS
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 25
January 2012 © 2012 Health Level Seven International. All rights reserved.
4.1 DBC - CREATE DONOR RECORD MESSAGE (EVENT O41)
The Create Donor Record messages contain information to create a new donor book of record.
Page 26 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.2 DBU - UPDATE DONOR RECORD MESSAGE (EVENT O42)
The Update Donor Record messages contain information to update an existing donor book of record.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 27
January 2012 © 2012 Health Level Seven International. All rights reserved.
4.3 QBP - GET DONOR RECORD CANDIDATES (EVENT Q33)
This query/response is designed for interaction between a registration system and the system which contains the Donor Book of Record. The query consists of
query parameters which assist in determining if the Donor already has a record in the Donor Book or Record system. The query parameters are minimal and
number of elements returned in the query response for each candidate is minimal.
Page 28 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.4 RSP - GET DONOR RECORD CANDIDATES RESPONSE (EVENT K33)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 29
January 2012 © 2012 Health Level Seven International. All rights reserved.
4.5 QBP - GET DONOR RECORD (EVENT Q34)
This query/response is designed for interaction between a viewing system and the system which contains the Donor Book of Record. The query consists of query
parameters, and the response of the demographics for that donor.
Page 30 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.6 RSP - GET DONOR RECORD RESPONSE (EVENT K34)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 31
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 4-9 – RSP^K34 ABSTRACT MESSAGE SYNTAX
Page 32 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.7 DRG - DONOR REGISTRATION (EVENT O43)
The Donor Registration messages contain information to register a donor for a donation.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 33
January 2012 © 2012 Health Level Seven International. All rights reserved.
4.8 DER - DONOR ELIGIBILITY REQUEST (EVENT O44)
The Donor Registration messages contain minimal information about a donor registration.
Page 34 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.9 DEO - DONOR ELIGIBILITY OBSERVATIONS (EVENT O45)
Communicate both mini-physical observations and questions and answers from a donor questionnaire. Note that this message type is a specific sub-set of
the full OUL (Unsolicited Lab Result) Message. The intent is to provide for a smaller message for implementation by blood banking donation
service systems which does not contain all the information necessary for a full laboratory result. This message type should be used only when
specimen information can safely be ignored (measure of HgB via test kit with no actual specimen drawn rather a skin prick is used by the device).
If a lab result can only be safely and appropriately understood if that result contains full information (e.g. specimen), then the OUL message type
should be used and not this DEO – Donor Eligibility Observation message type.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 35
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 4-12 – DEO^O45 ABSTRACT MESSAGE SYNTAX
Page 36 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.10 DEL - DONOR ELIGIBILITY (EVENT O46)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 37
January 2012 © 2012 Health Level Seven International. All rights reserved.
4.11 DRC - DONOR REQUEST TO COLLECT (EVENT O47)
Used to communicate to a collection system that the donor is eligible and collection can begin.
Page 38 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.12 DPR - DONATION PROCEDURE (EVENT O48)
This segment contains information from the blood unit collection procedure from the donor. The Donation Segment is repeating. If there is more than one stick,
there will be a separate DON segment for each stick.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 39
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 4-15 – DPR^O48 ABSTRACT MESSAGE SYNTAX
Page 40 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
4.13 ACK – ACKNOWLEDGEMENT
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 Page 41
January 2012 © 2012 Health Level Seven International. All rights reserved.
5 SEGMENT AND FIELD DESCRIPTIONS
This messaging guide provides notes for supported fields. The following format is used in this document for listing and defining message
segments and fields. First, the message segment’s use is defined, and a segment attribute table listing all fields defined in the segment is shown.
Abbreviation Definition
Seq Sequence of the elements as numbered in the HL7 segment.
Maximum length of the element. Lengths are provided only for atomic data types.
Lengths should be considered recommendations, not absolutes. The receiver can truncate fields, components, and sub-components that are longer
Len
than the recommended length. The receiver should continue to process a message even when a field, component, or sub-component length exceeds
the maximum recommended length identified in this specification.
DT Data type used by this profile for HL7 element.
Usage of the field for this profile. Indicates if the field, component, or subcomponent is required, optional, or conditional in the corresponding
segment, field, or component. Legal values are:
• R – Required. Must always be populated.
• RE – Required, but can be empty.
• O – Optional. May optionally be populated.
• C – Conditional. Populated under specified conditions.
Usage • CE – Conditional, but can be empty.
• X – Not used for this profile.
Note: A required field in an optional segment does not mean the segment must be present in the message. Rather, if the segment
is present, the required fields within that segment must be populated. This convention applies to required components of optional
fields. If the field is populated, then the required components must be populated. The convention applies to required sub-
components of optional components, as well. If a component is populated, then the required sub-components of that component
must be populated.
Page 42 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-1 – SEGMENT ATTRIBUTES
Abbreviation 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.
Cardinality • [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 Set Note: Where a table constraint is indicated, or where HL7 Version 2.6 standards are adopted, the constrained or specified HL7
table is included below the segment table.
HL7 Element Name HL7 descriptor of the element in the segment.
Description/Comments Context and usage for the element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 43
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5 -2 – SEGMENT USAGE DEFINITIONS
O Optional 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.
C Conditional 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.
X Not supported 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.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 1 ST R [1..1] Field Separator Character to be used as the field separator for the rest of the
message.
Literal value: ‘|’ [ASCII (124)].
2 4 ST R [1..1] Encoding Characters Four characters, always appearing in the same order: |^~\&|.
Literal value: ‘^~\&’.
3 HD RE [0..1] Sending Application Field that may be used to identify the sending application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the sending application instance.
4 HD R [1..1] Sending Facility Field that uniquely identifies the facility that sends the message. If
populated, it will contain an OID that represents the sending facility.
Page 44 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
5 HD RE [0..1] Receiving Application Field that may be used to identify the receiving application uniquely
for messaging purposes. If populated, it will contain an OID that
represents the receiving application instance.
6 HD RE [0..1] Receiving Facility Field that uniquely identifies the facility that is to receive the
message. If populated, it will contain an OID that represents the
receiving facility.
7 DTM R [1..1] Date/Time Of Message Field containing the date/time the message was created by the
sending system. Format: YYYYMMDDHHMMSS[.S[S[S[S]]]]+/-
ZZZZ. Note that the time zone offset is required, and the minimum
granularity is to the second, although more precise time stamps are
allowed.
8 ST X [0..0] Security Not supported
9 MSG R [1..1] Message Type See table for each message type.
10 25 ST R [1..1] Message Control ID String that uniquely identifies the message instance from the
sending application.
11 PT R [1..1] Processing ID Field that may be used to indicate the intent for processing the
message, such as "Testing," "Development," or "Production." For
this message, the field will be fixed to the value ”P”.
12 VID R [1..1] Version ID HL7 version number used to interpret format and content of the
message. For this message, the version ID will always be 2.5.1
13 NM X [0..0] Sequence Number Not supported
14 ST X [0..0] Continuation Pointer Not supported
15 ID X [0..0] Accept Acknowledgment Not supported
Type
16 2 ID CE [0..1] HL70155 Application Condition Rule: Shall be populated with a value from HL7 table
Acknowledgment Type 0155 for the Response message.
17 ID X [0..0] Country Code Not supported
18 ID X [0..0] Character Set Not supported
19 CWE X [0..0] Principal Language Of Not supported
Message
20 ID X [0..0] Alternate Character Set Not supported
Handling Scheme
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 45
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-3 – MESSAGE HEADER SEGMENT (MSH)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
21 EI R [1..10] Message Profile Identifier Field used to reference or assert adherence to a message profile.
Message profiles contain detailed explanations of grammar, syntax,
and usage for a particular message or set of messages. This field is
allowed to repeat. The profile ID for the profile defined in this guide
should appear as a Repeat. Other profile IDs may appear in the
field, as well, in cases where more constrained profiles are created
from this profile. An OID for this profile is available once it is
assigned. The OID appearing as the literal value is an example OID
only.
Literal Value: USBBDon^^2.16.840.1.113883.19.9.7^ISO
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 2 ID R [1..1] HL70008 Acknowledgment Code Acknowledgment code indicating receipt of message. (Refer to HL7
Table 0008 - Acknowledgment code for valid values.)
2 25 ST R [1..1] Message Control ID Identifier that enables the sending system to associate this response
with the message for which it is intended. This value will be the
MSH.10 message control ID from the message being acknowledged.
3 ST X [0..0] Text Message Not Supported
4 NM X [0..0] Expected Sequence Not Supported
Number
5 ID X [0..0] Delayed Not Supported
Acknowledgment Type
6 CWE X [0..0] Error Condition Not Supported
Page 46 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.5 ERR – ERROR SEGMENT
The ERR segment is used to add error comments to acknowledgment messages.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 ELD X [0..0] Error Code and Location Not Supported
2 ERL X [0..0] Error Location Not Supported
3 CWE R [1..1] HL70357 HL7 Error Code Identifies the HL7 (communications) error code.
4 1 ID R [1..1] HL70516 Severity Identifies the severity of an application error. Knowing if something is
Error, Warning or Information is intrinsic to how an application
handles the content.
5 CWE X [0..0] Application Error Code Not Supported
6 ST X [0..0] Application Error Not Supported
Parameter
7 65536 TX R [1..1] Diagnostic Information Information that may be used by help desk or other support
personnel to diagnose a problem.
8 TX X [0..0] User Message Not supported
9 IS X [0..0] Inform Person Indicator Not supported
10 CWE X [0..0] Override Type Not supported
11 CWE X [0..0] Override Reason Code Not supported
12 XTN X [0..0] Help Desk Contact Point Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 47
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.6 PID – PATIENT IDENTIFICATION SEGMENT
The Patient Identification Segment (PID) is used to provide basic demographics regarding the donor. The subject must be a person (no animals).
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID – PID 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.
2 CX X [0..0] Patient ID Not supported
3 CX R [1..4] Patient Identifier List Field used to convey all types of patient/person
identifiers. This includes social security numbers,
driver’s license numbers, medical record numbers, etc.
The following donor identifiers are supported in this IG:
a. Donor #
b. National ID (SSN etc.)
c. Legacy ID # (Donor # from a previous blood bank
system)
d. Legacy ID # 2nd (Donor # from a previous blood
bank system)
4 CX X [0..0] Alternate Patient ID – PID Not supported
5 XPN R [1..4] Patient Name – Donor Name 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????
6 XPN RE [0..1] Mother’s Maiden Name May be included for identification purposes. Name type
code is constrained to the value "M."
Page 48 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
7 TS RE [0..1] Date/Time of Birth Donor’s date of birth. The time component is not
supported in this IG.
8 20 IS RE [0..1] HL70001 Administrative Sex Donor’s gender.
9 XPN X [0..0] Patient Alias Not supported
10 CWE RE [0..1] HL70005 Race One or more codes that broadly refer to the donor’s
race(s).
11 XAD RE [0..2] Patient Address Donor’s addresses. This IG supports only two
addresses: home and work/business
12 IS X [0..0] County Code Not supported
13 XTN RE [0..2] Phone Number – Home This IG supports only two ‘personal’ phone numbers;
Home and Mobile.
14 XTN RE [0..1] Phone Number – Business
15 CWE X [0..0] Primary Language Not supported
16 CWE X [0..0] Marital Status Not supported
17 CWE X [0..0] Religion Not supported
18 CX X [0..0] Patient Account Number Not supported
19 ST X [0..0] SSN Number – Patient Not supported
20 DLN X [0..0] Driver’s License Number – Patient Not supported
21 CX X [0..0] Mother’s Identifier Not supported
22 CWE RE [0..1] HL70189 Ethnic Group
23 ST X [0..0] Birth Place Not supported
24 ID X [0..0] Multiple Birth Indicator Not supported
25 NM X [0..0] Birth Order Not supported
26 CWE X [0..0] Citizenship Not supported
27 CWE RE [0..1] HL70172 Veterans Military Status Field is meant for military status (active, retired, etc).
Empty field = non-military donor
“A”ctive only = military donor on active duty. Field
should either contain an “A” or be null.
28 CWE X [0..0] Nationality Not supported
29 TS X [0..0] Patient Death Date and Time Not supported
30 ID X [0..0] Patient Death Indicator Not supported
31 ID X [0..0] Identity Unknown Indicator Not supported
32 IS X [0..0] Identity Reliability Code Not supported
33 TS X [0..0] Last Update Date/Time Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 49
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-6 – PATIENT IDENTIFICATION SEGMENT (PID)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
34 HD X [0..0] Last Update Facility Not supported
35 CWE X [0..0] Species Code Not supported
36 CWE X [0..0] Breed Code Not supported
37 ST X [0..0] Strain Not supported
38 CWE X [0..0] Species Code Not supported
39 CWE X [0..0] Tribal Citizenship Not supported
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 IS X [0..0] Living Dependency Not supported
2 IS X [0..0] Living Arrangement Not supported
3 XON RE [0..1] Patient Primary Facility – Usual Collection Location
4 XCN X [0..0] Patient Primary Care Provider Name & ID No. Not supported
5 IS X [0..0] Student Indicator Not supported
6 IS X [0..0] Handicap Not supported
7 IS X [0..0] Living Will Code Not supported
8 IS X [0..0] Organ Donor Code Not supported
9 ID X [0..0] Separate Bill Not supported
10 CX X [0..0] Duplicate Patient Not supported
11 CWE X [0..0] Publicity Code Not supported
12 ID RE [0..1] HL70136 Protection Indicator – Notifiable Donor “Y” Donor is notifiable
“N” Not notifiable
13 DT X [0..0] Protection Indicator Effective Date Not supported
14 XON X [0..0] Place of Worship Not supported
15 CWE X [0..0] Advance Directive Code Not supported
16 IS X [0..0] Immunization Registry Status Not supported
17 DT X [0..0] Immunization Registry Status Effective Date Not supported
18 DT X [0..0] Publicity Code Effective Date Not supported
Page 50 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-7 – PATIENT ADDITIONAL DEMOGRAPHIC (PD1)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
19 IS X [0..0] Military Branch Not supported
20 IS X [0..0] Military Rank/Grade Not supported
21 IS X [0..0] Military Status Not supported
22 DT X [0..0] Advance Directive Last Verified Date Not supported
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI X [0..0] Set ID - PV1 Not supported
2 20 IS R [1..1] HL70004 Patient Class Use a fixed value of “N” for “Not applicable”.
3 PL X [0..0] Assigned Patient Location Not supported
4 CWE X [0..0] Admission Type Not supported
5 CX X [0..0] Preadmit Number Not supported
6 PL X [0..0] Prior Patient Location Not supported
7 XCN X [0..0] Attending Doctor Not supported
8 XCN X [0..0] Referring Doctor Not supported
9 XCN X [0..0] Consulting Doctor Not supported
10 20 IS X [0..0] Hospital Service Not supported
11 PL X [0..0] Temporary Location Not supported
12 IS X [0..0] Preadmit Test Indicator Not supported
13 IS X [0..0] Re-admission Indicator Not supported
14 IS X [0..0] Admit Source Not supported
15 IS X [0..0] Ambulatory Status Not supported
16 IS X [0..0] VIP Indicator Not supported
17 XCN X [0..0] Admitting Doctor Not supported
18 IS X [0..0] Patient Type Not supported
19 CX RE [0..1] Visit Number Number assigned for each donation ‘visit’ or registration.
20 FC X [0..0] Financial Class Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 51
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-8 – PATIENT VISIT INFORMATION (PV1)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
21 IS X [0..0] Charge Price Indicator Not supported
22 IS X [0..0] Courtesy Code Not supported
23 IS X [0..0] Credit Rating Not supported
24 IS X [0..0] Contract Code Not supported
25 DT X [0..0] Contract Effective Date Not supported
26 NM X [0..0] Contract Amount Not supported
27 NM X [0..0] Contract Period Not supported
28 IS X [0..0] Interest Code Not supported
29 IS X [0..0] Transfer to Bad Debt Code Not supported
30 DT X [0..0] Transfer to Bad Debt Date Not supported
31 IS X [0..0] Bad Debt Agency Code Not supported
32 NM X [0..0] Bad Debt Transfer Amount Not supported
33 NM X [0..0] Bad Debt Recovery Amount Not supported
34 IS X [0..0] Delete Account Indicator Not supported
35 DT X [0..0] Delete Account Date Not supported
36 IS X [0..0] Discharge Disposition Not supported
37 DLD X [0..0] Discharged to Location Not supported
38 CWE X [0..0] Diet Type Not supported
39 IS X [0..0] Servicing Facility Not supported
40 IS X [0..0] Bed Status Not supported
41 IS X [0..0] Account Status Not supported
42 PL X [0..0] Pending Location Not supported
43 PL X [0..0] Prior Temporary Location Not supported
44 DTM RE [0..1] Admit Date/Time Date and time donor registered
45 TS X [0..0] Discharge Date/Time Not supported
46 NM X [0..0] Current Patient Balance Not supported
47 NM X [0..0] Total Charges Not supported
48 NM X [0..0] Total Adjustments Not supported
49 NM X [0..0] Total Payments Not supported
50 CX RE [0..1] Alternate Visit ID – Drive ID Donation Drive Identifier
51 IS X [0..0] Visit Indicator Not supported
52 XCN X [0..0] Other Healthcare Provider Not supported
Page 52 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.9 OBR – OBSERVATION REQUEST SEGMENT
The Observation Request Segment (OBR) is used to capture information about:
1. The donation service requested to be performed
2. Questions in a questionnaire (the answers are in an associated OBX)
3. Assessments being performed for a mini-physical
the donation service to be performed, the questions .
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID - OBR 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.
2 EI RE [0..1] Placer Order Number This identifier is assigned by the placer of the order. This
identifier distinguishes the placer’s order from all other
orders created by the placer where an order is
interpreted to be the testing identified in a single OBR
segment. Normally, it is a type of system identifier
assigned by the placer software application.
The Placer Order Number and the Filler Order Number
are essentially foreign keys exchanged between
applications for uniquely identifying orders and the
associated results across applications.
3 EI R [1..1] Filler Order Number 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.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 53
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
4 CWE R [1..1] Universal Service Identifier Identifier code for the requested observation/test/
battery/donation. This IG does not recommend a specific
coding system at this time.
5 ID X [0..0] Priority – OBR Not supported
6 TS X [0..0] Requested Date/Time Not supported
7 TS X [0..0] Observation Date/Time Not supported
8 TS X [0..0] Observation End Date/Time Not supported
9 CQ X [0..0] Collection Volume Not supported
10 XCN X [0..0] Collector Identifier Not supported
11 ID X [0..0] Specimen Action Code Not supported
12 CWE X [0..0] Danger Code Not supported
13 ST X [0..0] Relevant Clinical Information Not supported
14 TS X [0..0] Specimen Received Date/Time Not supported
15 SPS X [0..0] Specimen Source Not supported
16 XCN X [0..0] Ordering Provider Not supported
17 XTN X [0..0] Order Callback Phone Number Not supported
18 ST X [0..0] Placer Field 1 Not supported
19 ST X [0..0] Placer Field 2 Not supported
20 ST X [0..0] Filler Field 1 Not supported
21 ST X [0..0] Filler Field 2 Not supported
22 DTM RE [0..1] Results Rpt/Status Chng - Date/Time 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.
23 MOC X [0..0] Charge to Practice Not supported
24 ID X [0..0] Diagnostic Serv Sect ID Not supported
25 ID X [0..0] Result Status Not supported
26 PRL X [0..0] Parent Result Not supported
27 TQ X [0..0] Quantity/Timing Not supported
28 XCN X [0..0] Result Copies To Not supported
29 EIP X [0..0] Parent Not supported
30 ID X [0..0] Transportation Mode Not supported
31 CWE X [0..*] Reason for Study Not supported
32 NDL X [0..0] Principal Result Interpreter Not supported
Page 54 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-9 – OBSERVATION REQUEST SEGMENT (OBR)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
33 NDL X [0..0] Assistant Result Interpreter Not supported
34 NDL O [0..0] Technician Not supported
35 NDL X [0..0] Transcriptionist Not supported
36 TS X [0..0] Scheduled Date/Time Not supported
37 NM X [0..0] Number of Sample Containers Not supported
38 CWE X [0..0] Transport Logistics of Collected Sample Not supported
39 CWE X [0..0] Collector's Comment Not supported
40 CWE X [0..0] Transport Arrangement Responsibility Not supported
41 ID X [0..0] Transport Arranged Not supported
42 ID X [0..0] Escort Required Not supported
43 CWE X [0..0] Planned Patient Transport Comment Not supported
44 CWE X [0..0] Procedure Code Not supported
45 CWE X [0..0] Procedure Code Modifier Not supported
46 CWE X [0..0] Placer Supplemental Service Not supported
Information
47 CWE X [0..0] Filler Supplemental Service Information Not supported
48 CWE X [0..0] Medically Necessary Duplicate Not supported
Procedure Reason
49 IS X [0..0] Result Handling Not supported
50 CWE X [0..0] Parent Universal Service Identifier Not supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 55
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.10 OBX – OBSERVATION RESULT SEGMENT (QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for mini-physical
observations and assessments and questionnaire answers. For sending lab results using this segment, see Section 4.9 – DEO – Donor Eligibility
Observation message type for more information.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID – OBX 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.
2 3 ID R [1..1] HL70125 Value Type This field identifies the data type used for OBX-5.
3 CWE R [1..1] Observation Identifier 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.
4 10 ST C [0..1] Observation Sub-ID 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.
5 Var R [1..1] Observation Value Field that documents each specific value (answer, assessment,
etc.)
6 CWE CE [0..1] Units 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.
7 ST X [0..0] References Range Not supported
8 IS X [0..0] Abnormal Flags Not supported
9 NM X [0..0] Probability Not supported
10 ID X [0..0] Nature of Abnormal Test Not supported
11 ID R [1..1] HL70085 Observation Result Status Fixed to a value of “F” for Final.
Page 56 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-10 –OBSERVATION/RESULT SEGMENT (OBX) - QUESTIONNAIRE RESPONSES AND MINI-PHYSICAL
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
12 TS X [0..0] Effective Date of Reference Not supported
Range
13 ST X [0..0] User-Defined Access Checks Not supported
14 DTM RE [0..1] Date/Time of the Observation Date and time of the observation (for one example, time the
question was answered)
15 CWE X [0..0] Producer’s Reference Not supported
16 XCN RE [0..1] Responsible Observer For questions and answers, the staff person conducting the
interview. Use the value of “donor” to indicate that the donor
filled out the questionnaire without staff assistance.
17 CWE X [0..0] Observation Method Not supported
18 EI X [0..0] Equipment Instance Identifier Not supported
19 TS X [0..0] Date/Time of the Analysis Not supported
20 CWE X [0..0] Observation Site Not supported
21 EI X [0..0] Observation Instance Not supported
Identifier
22 CNE X [0..0] Mood Code Not supported
23 XON X [0..0] Performing Organization Not supported
Name
24 XAD X [0..0] Performing Organization Not supported
Address
25 XCN X [0..0] Performing Organization Not supported
Medical Director
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 57
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.11 OBX – OBSERVATION RESULT SEGMENT (DONOR)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used to donor-level
observations.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID – OBX 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.
2 3 ID R [1..1] HL70125 Value Type This field identifies the data type used for OBX-5.
3 CWE R [1..1] Observation Identifier 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.
4 ST X [0..0] Observation Sub-ID Not supported
5 Var R [1..1] Observation Value Field that documents each specific value (answer, assessment,
etc.)
6 CWE R [0..0] Units Not supported
7 ST X [0..0] References Range Not supported
8 IS X [0..0] Abnormal Flags Not supported
9 NM X [0..0] Probability Not supported
10 ID X [0..0] Nature of Abnormal Test Not supported
11 ID R [1..1] HL70085 Observation Result Status Fixed to a value of “F” for Final.
12 TS X [0..0] Effective Date of Reference Not supported
Range
13 ST X [0..0] User-Defined Access Checks Not supported
14 DTM RE [0..1] Date/Time of the Observation Date and time of the observation
15 CWE X [0..0] Producer’s Reference Not supported
16 XCN RE [0..1] Responsible Observer The staff person gathering the information from the donor.
17 CWE X [0..0] Observation Method Not supported
18 EI X [0..0] Equipment Instance Identifier Not supported
19 TS X [0..0] Date/Time of the Analysis Not supported
20 CWE X [0..0] Observation Site Not supported
21 EI X [0..0] Observation Instance Not supported
Identifier
Page 58 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX) - DONOR
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
22 CNE X [0..0] Mood Code Not supported
23 XON X [0..0] Performing Organization Not supported
Name
24 XAD X [0..0] Performing Organization Not supported
Address
25 XCN X [0..0] Performing Organization Not supported
Medical Director
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 59
January 2012 © 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
Page 60 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
OBX - OBSERVATION IDENTIFIERS (DONOR)
IMPLEMENTATION GUIDE TABLE DON0002 – DONOR OBSERVATION CODES
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 61
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.13 OBX – OBSERVATION RESULT SEGMENT (DONATION AND ADVERSE EVENTS)
The Observation/Result Segment (OBX) contains information regarding a single observation. This includes identification of the specific type of
observation, the result for the observation, when the observation was made, etc. The segment definition below is used for donation-level
observations, and donation procedure adverse events.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID – OBX 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.
2 3 ID R [1..1] HL70125 Value Type This field identifies the data type used for OBX-5.
3 CWE R [1..1] Observation Identifier 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.
4 10 ST C [0..1] Observation Sub-ID 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.
5 Var R [0..1] Observation Value Field that documents each specific value
6 CWE CE [0..1] Units 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.
7 ST X [0..0] References Range Not supported
8 IS X [0..0] Abnormal Flags Not supported
9 NM X [0..0] Probability Not supported
10 ID X [0..0] Nature of Abnormal Test Not supported
11 ID R [1..1] HL70085 Observation Result Status Fixed to a value of “F” for Final.
12 TS X [0..0] Effective Date of Reference Not supported
Range
13 ST X [0..0] User-Defined Access Checks Not supported
Page 62 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 5-10 – OBSERVATION/RESULT SEGMENT (OBX)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
14 DTM RE [0..1] Date/Time of the Observation Date and time of the adverse event or deferral assessment.
15 CWE X [0..0] Producer’s Reference Not supported
16 XCN RE [0..1] Responsible Observer For adverse events, the staff member observing the reaction or
problem. For deferral, the staff member making the final
assessment for deferral.
17 CWE X [0..0] Observation Method Not supported
18 EI X [0..0] Equipment Instance Identifier Not supported
19 TS X [0..0] Date/Time of the Analysis Not supported
20 CWE X [0..0] Observation Site Not supported
21 EI X [0..0] Observation Instance Not supported
Identifier
22 CNE X [0..0] Mood Code Not supported
23 XON X [0..0] Performing Organization Not supported
Name
24 XAD X [0..0] Performing Organization Not supported
Address
25 XCN X [0..0] Performing Organization Not supported
Medical Director
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 63
January 2012 © 2012 Health Level Seven International. All rights reserved.
OBX - OBSERVATION IDENTIFIERS (DONATION AND ADVERSE EVENTS)
IMPLEMENTATION GUIDE TABLE DON0003 – DONATION OBSERVATION CODES
Page 64 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. 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
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI R [1..1] Set ID - AL1 Sequence of AL1s should there be more than one of the
same type.
2 705 CWE X [0..0] Allergen Type Code Not Supported
3 CWE R [1..1] Allergen This IG does not recommend a specific coding system at this
Code/Mnemonic/Description 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.
4 705 CWE X [0..0] Allergy Severity Code Not Supported
5 15 ST X [0..0] Allergy Reaction Code Not Supported
6 8 DT X [0..0] Identification Date Not Supported
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 65
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.16 NTE – NOTES AND COMMENTS SEGMENT
The NTE segment defined here is commonly used for sending notes and comments. Each NTE follows the segment to which that note or
comment pertains (see Message Types section above).
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 4 SI RE [0..1] Set ID - NTE Sequence of NTEs should there be more than one of the same
type.
2 ID X [0..0] Source of Comment Not Supported
3 65536 FT R [1..1] Comment
4 CWE X [0..0] Comment Type Not Supported
5 XCN X [0..0] Entered By Not Supported
6 24 DTM RE [0..1] Entered Date/Time
7 24 DTM RE [0..1] Effective Start Date
8 DTM X [0..0] Expiration Date Not Supported
Page 66 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.17 DON - BLOOD BANK DONATION SEGMENT
The intent of this segment is to describe the actual donation procedure.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 EI C [1..1] Donation Identification Number See component mapping table below
2 CNE C [1..1] Donation Type 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.
3 DTM RE [1..1] Phlebotomy Start Date/Time
4 DTM RE [1..1] Phlebotomy End Date/Time
5 NM RE [1..1] Donation Duration
6 CNE RE [1..1] HL70559 Donation Duration Units
7 CNE RE [1..10] HL70560 Intended Procedure Type
8 CNE RE [1..10] HL70560 Actual Procedure Type
9 ID R [1..1] HL70136 Donor Eligibility Flag
10 CNE C [1..10] HL70560 Donor Eligibility Procedure Type The element is populated with the procedure type or types
for which a donor is eligible when the donor is found to be
eligible for donation.
11 DTM RE [1..1] Donor Eligibility Date
12 CNE RE [1..1] HL70561 Process Interruption
13 CNE RE [1..1] HL70562 Process Interruption Reason
14 CNE RE [1..100] HL70564 Phlebotomy Issue
15 ID RE [1..1] HL70136 Intended Recipient Blood Relative
16 XCN RE [1..1] Intended Recipient Name and ID
17 DTM RE [1..1] Intended Recipient DOB
18 XON RE [1..1] Intended Recipient Facility
19 DTM RE [1..1] Intended Recipient Procedure Date
20 XCN RE [1..1] Intended Recipient Ordering Provider
21 CNE RE [1..1] HL70563 Phlebotomy Status
22 CNE RE [1..1] HL70565 Arm Stick
23 XCN RE [1..1] Bleed Start Phlebotomist
24 XCN RE [1..1] Bleed End Phlebotomist
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 67
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-13 – DONATION SEGMENT (DON)
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
25 75 ST RE [1..1] Aphaeresis Type Machine
26 25 ST RE [1..1] Aphaeresis Machine Serial Number
27 ID RE [1..1] HL70136 Donor Reaction
28 XCN R [1..1] Final Review Staff ID This is the name of the person who reviews all the
documents to ensure that all processes have been
completed and all blanks are completed correctly
29 DTM R [1..1] Final Review Date/Time
30 NM RE [1..1] Number of Tubes Collected
31 EI RE [1..100] Donation Sample Identifier
32 XCN R [1..1] Donation Accept Staff This is the person who ultimately accepted or deferred the
donor. This may be the same person as DON-28 or DON-
33, but also may be different in the case where the
accepting or deferring Staff is acting at the direction of the
person in DON -28 or DON-33.
33 XCN RE [1..1] Donation Material Review Staff This is a person who may be a point of escalation if the
interviewer is unsure of whether to accept or defer the
donor or if the answers to the questions require escalation
(i.e. to a Supervisor, Medical Director, etc.). This may be
the same person as DON-28, but may also be different.
34 XON R [1..1] Collection Facility
Page 68 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.18 BUI – BLOOD UNIT INFORMATION SEGMENT
The intent of this segment is to describe the information associated with a blood unit, one example of which is one or more blood unit(s) resulting
from a donation.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 SI O [1..1] Set ID – BUI
2 EI R [1..1] Blood Unit Identifier The definition will be or assigned to the particular blood unit(s)
resulting from a donation. The Blood Unit Identifier field consists of
three components: DIN, the labeling standard used to identify the
blood unit and if known, the specific product code for the blood unit
to further identify type of unit (s) collected. If the donation results in
two different unit types (as specified in BUI-3), the unit can be
uniquely identified by the combination of the Blood Unit Identifier
and the Blood Unit Type. If multiple bags of the same Blood Unit
Type are collected, the product code (either a standard product code
or a locally assigned product code) is used to uniquely identify each
unit.
3 CNE R [1..1] HL70566 Blood Unit Type need specific instructions on collections vs. shipping
4 NM R [1..1] Blood Unit Weight
5 CNE R [1..1] HL70567 Weight Units
6 NM R [1..1] Blood Unit Volume
7 CNE R [1..1] HL70568 Volume Units
8 ST O [1..1] Systems should use Manufacturer and Catalogue Number from the
Container Catalog Number ISBT-128 Manufacturers Data File to determine container type.
9 ST O [1..1] Container Lot Number
10 XON RE [1..1] The Container Manufacturer should be the Manufacturer Identifier
Code specified in Table 18 (RT016) in the ISBT 128 Technical
Container Manufacturer Specification
11 NM R [1..1] Transport Temperature
12 CNE R [1..1] HL70569 Transport Temperature Units
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 69
January 2012 © 2012 Health Level Seven International. All rights reserved.
5.19 RCP – RESPONSE CONTROL PARAMETER SEGMENT
The RCP segment is used to restrict the amount of data that should be returned in response to query.
Seq Len DT Usage Cardinality Value Set HL7 Element Name Description/Comments
1 ID X [0..0] Query Priority Not Supported
2 10 CQ R [1..1] HL70126 Quantity Limited Request Fixed to a value of “RD” for record.
3 CNE X [0..0] Response Modality Not Supported
4 DTM X [0..0] Execution and Delivery Time Not Supported
5 ID X [0..0] Modify Indicator Not Supported
6 SRT X [0..0] Sort-by Field Not Supported
7 ID X [0..0] Segment group inclusion Not Supported
Page 70 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.20 QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q33
The QPD segment defines the parameters of the query.
Field Name Key/ Sort LEN TYPE Opt Rep Match Op TBL Segment Service Element
Seq Search Field Identifier Name
Name Code
1 MessageQueryName 60 CWE R N N/A 0471
2 QueryTag 32 ST R N N/A
3 DonorLastName S Y 50 ST RE N N/A PID.5 PID-5 Patient
Name
4 DonorFirstName S Y 50 ST RE N N/A PID.5 PID-5 Patient
Name
5 DonorDOB DTM RE N N/A PID.7 PID-7
Date/Time of
Birth
6 DonorSex IS RE N N/A 0001 PID.8 PID-8 Sex
Abbreviation Definition
The ordinal number of the element being discussed. Sequence 1 is always Message Query
Field Seq 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
Name
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 Page 71
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 5-17 – INPUT PARAMETER ATTRIBUTES
Abbreviation 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
Key/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
Sort
valued in Virtual Tables that are used as output specifications.
Length 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
Type 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
Opt
for backward compatibility ('B').
Repeat 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
Match Operator for this field. Note: These are defined by HL7 Table 0209 – Relational Operator, a component of
the QSC data type
TBL 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
Segment Field Name
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
Service Identifier Code 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
Element Name
'Z'-element.
Page 72 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
5.21 QPD – QUERY PARAMETER DEFINITION SEGMENT – FOR EVENT Q34
The QPD segment defines the parameters of the query.
Field Name Key/ Sort LEN TYPE Opt Rep Match Op TBL Segment Service Element Name
Seq Search Field Identifier
Name Code
1 MessageQueryName 60 CWE R N N/A 0471
2 QueryTag 32 ST R N N/A
3 DonorIdentifier 20 ST RE N N/A PID.3 PID-3 Patient
Identifier List
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 73
January 2012 © 2012 Health Level Seven International. All rights reserved.
6 CODE SYSTEMS AND VALUE SETS
Successful message implementation requires that transmitted messages (message instances) contain valid values for coded fields. It is
important to note that code sets are relatively dynamic and subject to change between publications of these implementation guides.
Every code value passed in a message instance is drawn from a code system that has a globally unique identifier, such as an OID. In
general, the coded values allowed in a field (a) may be drawn from more than one code system, and (b) may be a subset of the codes
from a given coding system. Combining (a) and (b) makes it possible for the allowed code value to be a combination of multiple subsets
drawn from multiple coding systems. In most cases, only some of the codes defined in a code system are legal for use in a particular
message.
The subsets of the codes that are legal for a particular field are identified by an HL7 construct known as a Value Set. A value set is a
collection of coded values drawn from code systems. Value sets serve to identify the specific set of coded values for the message from
the universe of coded values across all coding systems. The actual content of any Value Set is subject to continual change, and the set of
Value Sets may also change to reflect current needs.
The segment tables in previous sections identify the Value Set or Coding System used for each supported field containing a coded value.
Fields that use the data type CNE or CWE require that messages include the code, (drawn from HL7 0396) that uniquely defines the
coding system, as well as the coded value itself. Some of these pre-coordinated value sets must be updated, or new ones created, as
new needs are identified.
Value Sets are identified by a unique identifier also, but this identifier is not transmitted in the message. The identifier or code for the
coding system from which the value is derived is sent in the message. However, the value set identifier is useful and important when
vocabulary items are modified or replaced.
Page 74 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.1 CODE TABLE ABBREVIATIONS
The following sections detail the structure of each code table, including field value, description, usage, and comments. The table below details the
abbreviated terms used in the code tables, as well as the definitions associated with those abbreviations.
Abbreviation Definition
Value The actual code value to be send in conformant messages.
Len 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.
Usage • X – Not used for this profile.
Note: Codes present in the HL7-defined tables may have been constrained for use in the Implementation Guide. In those cases
where the full list of codes from an HL7 table is not supported, those codes not supported are dropped from the list in this IG (as
opposed to marking them as “X”. As always, User-defined tables contain only relevant codes to be used for this IG.
Comment Any comments specific to usage of the specific code.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 75
January 2012 © 2012 Health Level Seven International. All rights reserved.
6.3 USER-DEFINED TABLE HL70003 – EVENT TYPE
Page 76 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.5 HL7 TABLE HL70008 – ACKNOWLEDGEMENT CODE
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 77
January 2012 © 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70103 – PROCESSING ID
Page 78 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
HL7 TABLE HL70125 – VALUE TYPE
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 79
January 2012 © 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70155 – ACCEPT/APPLICATION ACKNOWLEDGMENT CONDITIONS
Value Description Usage Comment
SU Successful completion only O
Page 80 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.14 HL7 TABLE HL70200 - NAME TYPE
HL7 TABLE HL70200 - NAME TYPE
Value Description Usage Comment
B Name at Birth R For Previous Name
L Legal Name R For Donor Name
M Maiden Name R For Maiden Name
N Nickname /”Call me” Name/Street Name R For Nickname
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 81
January 2012 © 2012 Health Level Seven International. All rights reserved.
6.17 HL7 TABLE HL70203 – IDENTIFIER TYPE
HL7 TABLE HL70203 – IDENTIFIER TYPE
Value Description Usage Comment
BCT Birth Certificate R A number associated with a document identifying the event of
a person’s birth.
CZ Citizenship Card R A number assigned by a person’s country of residence to
identify a person’s citizenship.
DL Driver’s license number R
DR Donor Registration Number R
HC Health Card Number R
MI Military ID number R A number assigned to an individual who has had military duty,
but is not currently on active duty. The number is assigned by
the DOD or Veterans’ Affairs (VA).
MR Medical record number R An identifier that is unique to a patient within a set of medical
records, not necessarily unique within an application.
NI National unique individual identifier R Class: Insurance
In the US, the Assigning Authority for this value is typically
CMS, but it may be used by all providers and insurance
companies in HIPAA related transactions.
NNxxx National Person Identifier where the xxx is the R
ISO table 3166 3-character (alphabetic) country
code
PI Patient internal identifier R A number that is unique to a patient within an Assigning
Authority.
PN Person number R A number that is unique to a living subject within an Assigning
Authority.
PPN Passport number R A unique number assigned to the document affirming that a
person is a citizen of the country. In the US this number is
issued only by the State Department.
SS Social Security number O
Page 82 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.18 EXTERNAL TABLE HL70291 – SUB TYPE OF REFERENCED DATA
EXTERNAL TABLE HL70291 - SUB TYPE OF REFERENCED DATA
Value Description Usage Comment
R 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.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 83
January 2012 © 2012 Health Level Seven International. All rights reserved.
6.21 USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
USER-DEFINED TABLE HL70305 – PERSON LOCATION TYPE
Value Description Usage Comment
C Clinic R
D Department R
H Home R
N Nursing Unit R
O Provider’s Office R
P Phone R
S SNF R
Page 84 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.23 HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
HL7 TABLE HL70357 – MESSAGE ERROR CONDITION CODES
Value Description Usage Comment
0 Message accepted R Success. Optional, as the AA conveys success. Used for systems that
must always return a status code.
100 Segment sequence error R Error: The message segments were not in the proper order, or required
segments are missing.
101 Required field missing R Error: A required field is missing from a segment
102 Data type error R Error: The field contained data of the wrong data type, e.g., an NM field
contained "FOO".
103 Table value not found R Error: A field of data type ID or IS was compared against the
corresponding table, and no match was found.
200 Unsupported message type R Rejection: The Message Type is not supported.
201 Unsupported event code R Rejection: The Event Code is not supported.
202 Unsupported processing id R Rejection: The Processing ID is not supported.
203 Unsupported version id R Rejection: The Version ID is not supported.
204 Unknown key identifier R 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.
205 Duplicate key identifier R Rejection: The ID of the patient, order, etc., already exists. Used in
response to addition transactions (Admit, New Order, etc.).
206 Application record locked R Rejection: The transaction could not be performed at the application
storage level, e.g., database locked.
207 Application internal error R Rejection: A catchall for internal errors not explicitly covered by other
codes.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 85
January 2012 © 2012 Health Level Seven International. All rights reserved.
HL7 TABLE HL70396 – CODING SYSTEM
Value Description Usage Comment
a specific table within ISBT 128. will be supplied to editor.)
The variable suffix (nnnn) identifies a specific table within ISBT 128.
UCUM UCUM code set for units of
measure(from Regenstrief)
Page 86 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.28 USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
USER-DEFINED TABLE HL70560 – BLOOD PROCEDURE TYPE
Value Description Usage Comment
WBL Whole Blood R
2RC Double Red Cells R
PLS Plasma R
PLT Platelets R
PNP Platelets and Plasma R
PNR Platelets and Red Cells R
PPR Platelets, Plasma, and Red Cells R
GRN Granulocytes R
HEM Hemachromatosis R To be used as whole blood for transfusion; may not be counted as red
blood cell loss; Donor may be considered a patient.
HPC Hematopoietic Progenitor Cells R Stem Cells and other cells classified as Hematopoietic
LYM Lymphocytes R
THA Therapeutic Apheresis R
THW Therapeutic Whole Blood R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 87
January 2012 © 2012 Health Level Seven International. All rights reserved.
6.30 USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
USER-DEFINED TABLE HL70562 – PROCESS INTERRUPTION REASON
Value Description Usage Comment
NRG No reason given, donor decided to stop R
without giving a reason
PCD Phone Call-Donor R
DCW Couldn’t wait R
CFT Couldn’t follow through with donation R
(scared)
DBB Bathroom R
DNI Phlebotomy Issue R
ASC Apheresis Software Crash R
BSC Manufacturing Software Crash R
GFE General Facility Emergency R Power outage, natural disaster (tornado, flood, hurricane, etc.), air
conditioning failure, etc.
Page 88 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
USER-DEFINED TABLE HL70564 – PHLEBOTOMY ISSUE
Value Description Usage Comment
IPF Instrument Power Failure R
ACN Air Contamination R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 89
January 2012 © 2012 Health Level Seven International. All rights reserved.
USER-DEFINED TABLE HL70566 – BLOOD UNIT TYPE
Value Description Usage Comment
PLS Plasma R
PLT Platelets R
GRN Granulocytes R
PSC Peripheral Stem Cells R
LYM Lymphocytes R
Page 90 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
6.37 USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
USER-DEFINED TABLE HL70569 – TEMPERATURE UNITS
Value Description Usage Comment
degF Degrees Fahrenheit R
Cel Degrees Celsius R
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 91
January 2012 © 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.
Page 92 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
TABLE 7-1 – DATA TYPES
Data type Data Type Name Length
SN Structured Numeric
ST String 999
TX Text Data 65536
VID Version Identifier
XAD Extended Address
XCN Extended Composite ID Number and Name
XON Extended Composite Name and ID Number
for Organizations
XPN Extended Person Name
XTN Extended Telecommunication Number
Abbreviation Definition
Seq 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
Len fields, components and sub-components that are longer than the recommended length. The
receiver should continue to process a message even when a field, component, or sub-
component length exceeds the maximum recommended length identified in this specification.
DT Data type used by this profile for HL7 element.
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 93
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 7-2 – DATA TYPE ATTRIBUTES
Abbreviation 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.
Usage • 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 Note: Where a table constraint is indicated, or where HL7 Version 2.8
standards are pre-adopted, the constrained or specified HL7 table is included
below the data type table.
Component Name HL7 descriptor of the element in the data type.
Description/Comments Context and usage for the element.
Note: In the tables throughout this document, Yellow = This Interoperability Specification does not support the use of this item.
Page 94 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.3 CNE – CODED NO EXCEPTIONS
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 95
January 2012 © 2012 Health Level Seven International. All rights reserved.
7.4 CNN – COMPOSITE ID NUMBER AND NAME SIMPLIFIED
Page 96 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.5 CQ – COMPOSITE QUANTITY WITH UNITS
Page 98 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.8 DTM – DATE/TIME
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 99
January 2012 © 2012 Health Level Seven International. All rights reserved.
7.10 EI – ENTITY IDENTIFIER
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.
Page 100 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.12 FT – FORMATTED TEXT DATA
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 101
January 2012 © 2012 Health Level Seven International. All rights reserved.
7.14 ID – CODED VALUE FOR HL7-DEFINED TABLES
Page 102 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.17 NM – NUMERIC
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 103
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 2-24 – REFERENCE POINTER (RP)
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.
Page 104 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. 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
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 105
January 2012 © 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^+).
Page 106 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012
7.26 XAD – EXTENDED ADDRESS
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 107
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 2-35 – EXTENDED COMPOSITE ID NUMBER AND NAME FOR PERSONS (XCN)
Page 108 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. 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)
HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1 Page 109
January 2012 © 2012 Health Level Seven International. All rights reserved.
TABLE 2-37 – EXTENDED PERSON NAME (XPN)
Page 110 HL7 Version 2.6 Implementation Guide: Blood Bank Donation Services (US Realm), Release 1
© 2012 Health Level Seven International. All rights reserved. January 2012