IHE PCD TF Vol2
IHE PCD TF Vol2
Volume 2
10 IHE PCD TF-2
Transactions
15
25 Please verify you have the most recent version of this document, which is published here.
CONTENTS
1 Introduction ................................................................................................................................ 8
30 1.1 Introduction to IHE ............................................................................................................. 8
1.2 Intended Audience .............................................................................................................. 8
1.3 Overview of Technical Framework Volume 2 ................................................................... 8
1.4 Comment Process................................................................................................................ 9
1.5 Copyright Licenses ............................................................................................................. 9
35 1.5.1 Copyright of Base Standards ....................................................................................... 9
1.6 Trademark ........................................................................................................................... 9
1.7 Disclaimer Regarding Patent Rights ................................................................................... 9
1.8 History of Document Changes .......................................................................................... 10
2 Conventions ............................................................................................................................. 11
40 2.1 Transaction Modeling and Profiling Conventions ............................................................ 11
2.2 Additional Standards Profiling Conventions .................................................................... 11
2.3 Use of Coded Entities and Coding Schemes..................................................................... 11
3 IHE PCD Transactions ............................................................................................................. 12
3.1 Communicate PCD Data [PCD-01] .................................................................................. 12
45 3.1.1 Scope.......................................................................................................................... 12
3.1.2 Use Case Roles .......................................................................................................... 12
3.1.3 Referenced Standards ................................................................................................ 13
3.1.4 Messages .................................................................................................................... 13
3.1.4.1 DOR communicates with DOC .......................................................................... 13
50 3.1.4.1.1 PCD-01 Communicate PCD Data (ORU^R01^ORU_R01) static definition
................................................................................................................... 14
3.1.4.1.2 Trigger events ............................................................................................. 15
3.1.4.1.3 Message Semantics ..................................................................................... 16
3.1.4.1.4 Expected Actions ........................................................................................ 16
55 3.1.5 Security Considerations ............................................................................................. 16
3.2 [PCD-02] Reserved ........................................................................................................... 17
3.3 Communicate Infusion Order [PCD-03] ........................................................................... 17
3.3.1 Scope.......................................................................................................................... 17
3.3.2 Use Case Roles .......................................................................................................... 17
60 3.3.3 Referenced Standards ................................................................................................ 17
3.3.4 Messages .................................................................................................................... 17
3.3.4.1 PCD-03 Communicate Infusion Order (RGV^O15^RGV_O15) static definition
............................................................................................................................ 18
3.3.4.2 RGV^O15^RGV_O15 Pharmacy/Treatment Give Message ............................. 18
65 3.3.4.3 Trigger Events .................................................................................................... 20
3.3.4.4 Message Semantics ............................................................................................. 20
3.3.4.4.1 MSH – Message Header Segment .............................................................. 20
3.3.4.4.2 PID - Patient Identification Segment .......................................................... 22
3.3.4.4.3 PV1 Patient Visit Segment ......................................................................... 22
70 3.3.4.4.4 ORC - Common Order Segment................................................................. 22
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 2 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 3 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 4 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 5 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 6 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 7 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1 Introduction
280 This document, Volume 2 of the IHE Patient Care Device (PCD) Technical Framework, defines
transactions used in IHE Patient Care Device profiles.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 8 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1.6 Trademark
IHE® and the IHE logo are trademarks of the Healthcare Information Management Systems
340 Society in the United States and trademarks of IHE Europe in the European Community. They
may only be used with the written consent of the IHE International Board Operations
Committee, which may be given to a Member Organization in broad terms for any use that is
consistent with the IHE mission and operating principles.
1
HL7 is the registered trademark of Health Level Seven International.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 9 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
a license may be required, for conducting inquiries into the legal validity or scope of Patents
350 Claims or determining whether any licensing terms or conditions provided in connection with
submission of a Letter of Assurance, if any, or in any licensing agreements are reasonable or
non-discriminatory. Users of the specifications in this document are expressly advised that
determination of the validity of any patent rights, and the risk of infringement of such rights, is
entirely their own responsibility. Further information about the IHE International patent
355 disclosure process including links to forms for making disclosures is available at
http://www.ihe.net/Patent_Disclosure_Process. Please address questions about the patent
disclosure process to the secretary of the IHE International Board: [email protected].
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 10 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2 Conventions
365 This document has adopted the following conventions for representing the framework concepts
and specifying how the standards upon which the IHE PCD Technical Framework is based
should be applied.
None.
2
DICOM is the registered trademark of the National Electrical Manufacturers Association for its standards
publications relating to digital communications of medical information.
3
CDA is the registered trademark of Health Level Seven International.
4
LOINC® is registered United States trademarks of Regenstrief Institute, Inc.
5
SNOMED CT is a registered trademark of the International Health Terminology Standards Development
Organisation, all rights reserved.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 11 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.1.1 Scope
This transaction is used to communicate PCD Data from:
400 • A Device Observation Reporter (DOR) to a Device Observation Consumer (DOC).
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 12 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.1.4 Messages
435 The following interaction diagrams illustrate potential implementations.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 13 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 14 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 15 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
While a DOR may be implemented directly on a medical device, it is more often implemented on
a gateway or intermediary device as an application which implements the DOR, receiving data
465 from one or more patient care devices using either standards-based or proprietary protocols
which are outside the current scope of the IHE PCD TF.
In general, the DOR sends periodic reports at an interval of between several times per minute
(high acuity) and a maximum interval of 24 hours (chronic, home health) with a typical interval
of 1 minute. The minimum and maximum intervals are configured at implementation. The DOR
470 may also send aperiodic reports for "event type" information. The DOR shall not do interpolation
of data received from the PCD source.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 16 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.3.4 Messages
515 The following interaction diagram illustrates the implementation.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 17 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 18 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 19 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
530
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 20 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
IOP IOC
1. IOP opens a
RGV^O15 Message
Network Connection
on the IOC’s port
1. The IOP sends a RGV^O15 message on the IOC’s port 3000 with MSH-15=”AL” and
MSH-16=”AL”.
2. The IOC receives the message on port 3000 and transmits an ACK^O15 to the IOP on the
560 same network connection.
IOP IOC
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 21 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
After completing application processing, the IOP does not transmit an application
acknowledgement.
If the IOP wants to always receive an application acknowledgement (RRG) message in addition
570 to the accept acknowledgement, the IOP must populate MSH-16 with “AL” (always). If the IOP
cannot process application acknowledgement messages, the IOP must populate MSH-16 with
“NE” (never). The IOP must populate MSH-16 with “ER” (error) when the system only wants to
receive an application acknowledgement message when the IOC detects an error.
The table below identifies the possible values for MSH-16:
This profile recommends “AL” (always) to receive complete messaging processing confirmation.
If this support is not feasible, this profile recommends that the IOP value the application
acknowledgement field with “ER” (error/reject), so that the IOC will only send an application
580 error when it is unable to process the requested order.
This profile recommends that the IOC value the application acknowledgement field with “NE”
on a RRG^O16, so that the IOP will only send an accept acknowledgement and not an
application acknowledgement. Note that the IOP is responsible for sending (or not sending) an
acknowledgement as specified by the IOC.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 22 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
600 The following describes the IHE PCD usage of those fields which have a usage other than X in
the above table.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 23 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Definition: This field is the identifier of the primary additive or principal ingredient of the
615 IV medication to be administered to the patient.
Subfields CWE-1 "Identifier" and CWE-2 "Text" are required for each identifier.
Typically, "Identifier" would be populated with a value such as an NDC or another value
known to both the Infusion Order Programmer and the Infusion Order Consumer. "Text"
would typically be populated with the generic name of the medication. The information
620 provided in either Identifier or Text is used to match the ordered medication to the
onboard drug library.
RXG-5 Give Amount – Minimum
Definition: This field contains the volume of fluid to be administered (VTBI). This
volume is the actual fluid volume that the clinician intends to administer (not necessarily
625 the volume contained in the bag, bottle, syringe, or other fluid container).
Required for LVP when TQ1 segment is not present. Optional for PCA and Syringe.
Must be empty when ORC-1 = “XO”.
When this field is empty, there should be no implication made about the volume of fluid
to be administered.
630 RXG-6 Give Amount - Maximum
See HL7 V2.6 Section 4.14.6.6 for details. The PCD TF does not further constrain this
field.
RXG-7 Give Units
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^
635 <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate
Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding
System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field contains the coded units for the Give Amount. The preferred format
is an MDC value; UCUM values are also acceptable.
640 Required for LVP when TQ1 segment is not present; Optional for PCA and Syringe.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 24 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 25 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Required for LVP and Syringe; Optional for PCA. If present for PCA, contains the basal
or continuous rate value.
RXG-16 Give Rate Units
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^
680 <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate
Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding
System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field contains the coded version of the units portion of the rate, dose rate,
or dose to be administered.
685 If the infusion order specifies a rate, such as normal saline to infuse at 75 mL/hr, this
field represents the rate units (e.g., "mL/hr").
If the infusion order specifies a dose rate, such as dopamine to infuse at 5 mcg/kg/min,
this field represents the dose rate units (e.g., "mcg/kg/min").
If the infusion order specifies a dose, such as ceftriaxone 2 g, this field represents the
690 dose units (e.g., “g”).
When a dose is specified the TQ1 segment must be present to indicate the time period
that the dose is to be infused over.
The preferred format is an MDC value; UCUM values are also acceptable.
Required for LVP and Syringe; Optional for PCA. If present for PCA, contains the basal
695 or continuous rate units value.
Examples:
265266^MDC_DIM_MILLI_L_PER_HR^MDC
265619^MDC_DIM_MICRO_G_PER_KG_PER_MIN^MDC
700 263872^MDC_DIM_X_G^MDC
ml/h^ml/h^UCUM
ug/kg/min^ug/kg/min^UCUM
g^g^UCUM
This field contains the coded version of the units portion of the main ingredient in the
infusion; e.g., for dopamine 800 mg in 250 mL D5W, the field would represent ‘mg".
715 The preferred format is an MDC value; UCUM values are also acceptable:
Examples:
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 26 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
263890^MDC_DIM_MILLI_G^MDC
mg^mg^UCUM
740 Definition: This field contains the coded units for the Give Drug Strength Volume. The
preferred format is an MDC value; UCUM values are also acceptable.
The PCD TF requires that the first three components of RXG-24 contain one of the
following sets of values:
745 • 263762^MDC_DIM_MILLI_L^MDC
• mL^mL^UCUM
RXG-27 to 30
755 These fields are not supported by the PCD TF.
780
RXG segment population for Ampicillin:
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 28 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Fluid orders
"Plain" IV fluids do not contain an additive. The BCMA is not required to populate RXG-17, 18,
795 23, and 24 for these orders.
Examples:
Dextrose 5% 1000 mL
Sodium Chloride 0.9% 250 mL
Orders with multiple additives
800 Some infusion orders may contain multiple additives, for example, total parenteral nutrition
(TPN) solutions are made up of one or more base solutions and as many as 10 or 12 additives.
The BCMA is not required to populate RXG-17, 18, 23, and 24 for these orders.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 29 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
810
TQ1-1 Set ID
See HL7 v2.6 Section 4.5.4.1 for details. The PCD TF does not further constrain this
field.
TQ1-2 Quantity
815 See HL7 v2.6 Section 4.5.4.2 for details. The PCD TF does not further constrain this
field.
TQ1-3 Repeat Pattern
See HL7 v2.6 Section 4.5.4.3 for details. The PCD TF does not further constrain this
field.
820 TQ1-4 Explicit Time
See HL7 v2.6 Section 4.5.4.4 for details. The PCD TF does not further constrain this
field.
TQ1-5 Relative Time and Units
See HL7 v2.6 Section 4.5.4.5 for details. The PCD TF does not further constrain this
825 field.
TQ1-6 Service Duration
See HL7 v2.6 Section 4.5.4.6 for details. The PCD TF does not further constrain this
field.
TQ1-7 Start date/time
830 See HL7 v2.6 Section 4.5.4.7 for details. The PCD TF does not further constrain this
field.
TQ1-8 End date/time
See HL7 v2.6 Section 4.5.4.8 for details. The PCD TF does not further constrain this
field.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 30 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This field specifies the duration of the infusion. Along with the dose or the volume to be
administered the rate can be calculated by the infuser.
The only acceptable time values for this field are seconds, minutes, and hours. To specify
multiple components of time, this field can be repeated two additional times.
855
Unit of Time MDC Code
Hour 264384&MDC_DIM_HR&MDC
Minute 264352&MDC_DIM_MIN&MDC
Second 264320&MDC_DIM_X_SEC&MDC
Examples:
90 Seconds:
90^264320&MDC_DIM_X_SEC&MDC
860
2 Hours 45 Minutes:
2^264384&MDC_DIM_HR&MDC~45^264352&MDC_DIM_MIN&MDC
870
The following describes the IHE PCD usage of the fields in the above table.
RXR-1 Route
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^
<Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate
875 Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding
System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field is the route of administration. The PCD TF requires that this field be
valued as one of the following: ^IV^HL70162 for Intravenous, ^EP^HL70162 for Epidural,
^SC^HL70162 for Subcutaneous, ^NG^HL70162 for Nasogastric, ^GTT^HL70162 for
880 Gastrostomy Tube or ^IT^HL70162 for Intrathecal.
RXR-2 Administration Site
See HL7 V2.6 Section 4.14.2.2 for details. The PCD TF does not further constrain this
field.
RXR-3 Administration Device
885 Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^
<Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate
Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding
System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field contains the type of pump used to administer the drug, if known by
890 the BCMA system. The PCD TF requires that this field be valued as ^IVP^HL70164 for
LVP pumps, ^PCA^HL70164 for PCA pumps, or ^SYR^HL70164 for Syringe pumps.
The following entry should be added to HL7 user-defined table #0164:
Value Description
SYR Syringe Pump
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 32 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
900 Definition: This field identifies whether the infusion is to be administered as a primary
infusion or as an IV piggyback or secondary infusion. The TF requires that this field be
valued as ^IV^HL70165 for a primary infusion or ^IVPB^HL70165 for an IV piggyback
or secondary infusion. This field is optional for PCA.
The following entry should be added to HL7 user-defined table #0165:
905
Value Description
IV IV Primary
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 33 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
9 5 NM X [0..0] Probability
The following describes the IHE PCD PIV Profile’s usage of those fields which have a usage
930 other than X in the above table.
OBX-1 Set ID
This field contains the sequence number of the OBX in this message; i.e., 1st OBX Set
ID = 1, 2nd OBX set ID = 2, etc., regardless of whether the OBX refers to a device or a
metric value.
935 OBX-2 Value Type
The PCD PIV Profile constrains this field as follows:
If OBX-3 refers to a pump ID this field must be empty.
If OBX-3 refers to a patient parameter that conveys a numeric quantity (e.g., patient
weight), this value is restricted to NM.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 34 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
940 If OBX-3 refers to an infusion order step type this field must be “ST”..
If OBX-3 refers to a pump programming parameter, this value should identify the data
type of the value in OBX-5 Observation Value.
OBX-3 Observation Identifier
The PCD PIV Profile constrains the value of this field to one of the following:
945 Pump ID
69986^MDC_DEV_PUMP_INFUS_VMD^MDC
Patient parameter
68063^MDC_ATTR_PT_WEIGHT^MDC
950 68060^MDC_ATTR_PT_HEIGHT^MDC
188744^MDC_AREA_BODY_SURF_ACTUAL^MDC
965
OBX-4 Observation Sub-ID
The PC PIV Profile does not further constrain this field.
OBX-5 Observation Value
If OBX-3 refers to a pump ID, this field must be empty.
970 If OBX-3 refers to a patient parameter, this field contains the parameter value.
If OBX-3 refers to an infusion order step type, the field contains the enumerated value
If OBX-3 refers to a pump programming parameter, this field contains the parameter
value.
OBX-6 Units
975 The PCD PIV Profile constrains the value of this field based on the value in OBX-3.
If OBX-3 refers to a pump ID, this field must be empty.
If OBX-3 refers to a patient parameter, this field contains the coded units for the
parameter. The preferred format is an MDC value; UCUM values are also acceptable.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 35 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
When OBX-3 refers to weight, the first three components of OBX-6 must contain one of
980 the following sets of values:
263872^MDC_DIM_X_G^MDC
263875^MDC_DIM_KILO_G^MDC
g^g^UCUM
kg^kg^UCUM
985 When OBX-3 refers to height, the first three components of OBX-6 must contain one of
the following sets of values:
263441^MDC_DIM_CENTI_M^MDC
cm^cm^UCUM
When OBX-3 refers to BSA, the first three components of OBX-6 must contain one of
990 the following sets of values:
263616^ MDC_DIM_SQ_X_M^MDC
m2^m2^UCUM
If OBX-3 refers to an infusion order step type, this field must be empty.
If OBX-3 refers to a pump programming parameter, this field contains the units for the
995 value in OBX-5 Observation Value.
OBX-7 References Range:
The PCD PIV Profile does not further constrain this field.
OBX-8 Abnormal Flags
The PCD PIV Profile does not further constrain this field.
1000 OBX-10 Nature of Abnormal Test
The PCD PIV Profile does not further constrain this field.
OBX-11 Observation Result Status
The PCD PIV Profile does not further constrain this field.
OBX-14 Date/Time of the Observation
1005 The PCD PIV Profile does not further constrain this field.
OBX-15 Producer’s ID
The PCD PIV Profile does not further constrain this field.
OBX-16 Responsible Observer (XCN)
The PCD PIV Profile does not further constrain this field.
1010 OBX-17 Observation Method
The PCD PIV Profile does not further constrain this field.
OBX-18 Equipment Instance Identifier
See Appendix B.8 for description of usage of OBX-18.
If OBX-3 refers to a pump ID, the following applies.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 36 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1015 o For backward compatibility, when used to contain a pump ID, the OBX-18
convention used in previous Trial Implementation versions of the Point-of-Care
Infusion Verification Supplement may be used by agreement between sending and
receiving systems, but this usage is deprecated and should not be used in new
systems. The former language is reproduced here: "If OBX-3 refers to the pump ID,
1020 the ID is placed in the ‘Universal ID’ component (EI-3), and the device or
manufacturer name is placed in the ‘Universal ID Type’ component (EI-4). The pump
ID is a unique alphanumeric identifier and may optionally include the pump channel.
The format of the identifier is vendor-specific. A typical value could be a serial
number for a single-channel pump, or a serial number followed by the channel
1025 number or letter for a multi-channel pump. Note that this specification differs from
the usage of OBX-18 in IHE PCD DEC Profile."
o New applications should conform to the general specification for OBX-18 (Appendix
B.8). The pump ID (vendor-specific format, which may optionally include the pump
channel as before) should be placed in EI-1, and EI-3 and EI-4 should identify the
1030 manufacturer of the pump according to an accepted Universal ID system.
o If OBX-3 refers to a patient parameter this field must be empty.
If OBX-3 refers to a pump programming parameter this field must be empty.
OBX-19 Date/Time of the Analysis
The PCD PIV Profile does not further constrain this field.
1035 OBX-20 Observation Site
The PCD PIV Profile does not further constrain this field.
OBX-21 to 25
OBX fields 21 to 25 are not supported by PCD PIV.
3.3.4.4.10 Rate change, titration, Bolus from existing infusion, and Multistep
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 37 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
• The EHR workflow provides the nurse the capability to administer the bolus from the
same bag or syringe using the PIV [PCD-03] transaction to send the bolus order to the
1050 pump.
• No assumption is made about the behavior of the pump once the bolus has been
delivered. Depending on the pump type or model it may stop, alarm, or resume delivering
the underlying infusion.
OBX segment
• Include an OBX segment specifying the order type of bolus (clinician dose) where
• OBX-5 = MDCX_INFUSION_ORDER_TYPE. This term has enumerations “clinician-
1070 dose”, “loading-dose”, and “continuous”.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 38 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
• When RXG-15 and RXG-16 specify a dose, include an OBX segment specifying the rate
where OBX-5 = MDC_FLOW_FLUID_PUMP.
When the IPEC or DEC profiles contain information about a bolus from an existing infusion,
1075 note that the PCD-01 and PCD-10 messages contain bolus information in the Clinician Dose Info
section.
In the OBR segment, OBR-2 Placer Order Number contains the order ID of the bolus as a
“child” order ID. OBR-29 Parent is used to contain the order ID for the parent (i.e., the existing
infusion).
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 39 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1115
[{ SFT }] Software X 2
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 41 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
TQ1 Timing/Quantity X 4
TQ1 Timing/Quantity X 4
[{ RXC }] Pharmacy/Treatment X 4
Component
] --- GIVE end
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 42 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This section corresponds to transaction [PCD-04] of the IHE Technical Framework. Transaction
[PCD-04] is used by the Alert Reporter (AR), Alert Consumer (ACON) and the Alert Manager
(AM) Actors.
Alert Reporter
(AR)
Report Alert
3.4.4 Messages
AR AM/ACON
1185 Alert Reporter sends Report Alert to Alert Manager and/or Alert Consumer as an HL7 ORU
message.
1190
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 44 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Common HL7 segments are defined in Appendix B Common Message Segments. There are
1195 sections discussing considerations specific to [PCD-04] where applicable.
AR ACON AM
While there can be multiple OBR segments per [PCD-04] transaction (in support of inclusion of
1200 alert common containment and evidentiary data) there is at most one alert per [PCD-04]
transaction.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 45 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
A single Report Alert [PCD-04] transaction contains at most one alert for a given patient and
1205 there must be an OBR preceding each group of OBX segments.
See Appendix B for details of the contents of each segment in the [PCD-04] transaction.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 46 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 47 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.5.1 Scope
This transaction is used by the Alert Manager (AM) to report one or more dissemination status
1255 updates back to the Alert Reporter.
Report
Alert Status
3.5.4 Messages
1270
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 48 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
AR AM AC
Opt
PCD-05 Report Alert
Status
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 49 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1305
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 50 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
While there can be multiple OBR segments per transaction there is at most one alert on which
status is reported per transaction.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 51 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 52 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.6.1 Scope
This transaction is used by Alert Manager (AM) to disseminate the alert to the Alert
Communicator (AC).
Disseminate
Alert
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 53 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 54 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
In planning the use of this transaction, implementers should assure that regulatory requirements
1380 and institutional policy regarding the protection of personal health information are properly
accounted for including any need for authentication or encryption of the communications.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 55 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.7.1 Scope
This transaction is used by Alert Communicator to report one or more dissemination status
1410 updates and/or replies to the Alert Manager (AM). A single [PCD-06] transaction from the Alert
Manager to the Alert Communicator can result in numerous [PCD-07] transactions from the
Alert Communicator back to the Alert Manager.
Report
Dissemination Alert
Status
1415
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 56 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3.7.4 Messages
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 57 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1440 A single [PCD-04] to [PCD-06] transaction may go through multiple communications status
updates as the alert is communicated to the endpoint user or application. Which of the status
updates are possible depend on the capabilities of the Alert Communicator and endpoint. Some
endpoint devices are output only and do not support two-way capabilities, while other devices
and services offer transmission confirmation. More advanced communications endpoints offer
1445 two-way capabilities allowing the operator of the endpoint to accept or cancel the alert.
An Alert Communicator actor might maintain internal alert dissemination recipient lists in
additional to the dissemination recipient mappings of the Alert Manager. This might be the case
if the Alert Communicator is a commercial message dissemination service provider. The Alert
Manager actor might not be aware of all of the individual recipients in such lists. This may result
1450 in additional PCD-07 Report Dissemination Alert Status transactions being sent by the Alert
Communicator to the Alert Manager for which there was no recipient specific PCD-06
transaction from the Alert Manager to the Alert Communicator. These additional PCD-07
transactions may result in additional PCD-05 Report Alert Status transactions being sent from
the Alert Manager to the Alert Reporter.
1455 Detailed reason for status can optionally be included in the WCTP errorText element to account
for messages not reaching the endpoint, or being rejected by the endpoint, because the device is
known to be offline or in a busy or do not disturb state. See details in WCTP interface
specification.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 59 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1495 assessment, following ISO 80001, will determine the actual security and safety controls
employed.
3.9.1 Scope
In the Communicate IDC Observation transaction, the Implantable Device – Cardiac – Reporter
sends the observation as an unsolicited HL7 ORU message to the Implantable Device – Cardiac
1505 – Consumer.
Communicate IDC
Observation
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 60 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Role Receives the HL7 ORU message and provides some implementation-specific
processing. This may include creation of reports, integration of information into
electronic health records, or creation of derived data (trends, analyses,
reformatted data, population statistics, etc.). If needed, it will reconcile patient
identification using an implementation-specific mapping function.
1510
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 61 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The Implantable Device – Cardiac – Reporter initiates the HL7 ORU message to the Implantable
1530 Device – Cardiac – Consumer following an implanted cardiac device interrogation.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 62 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 63 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 64 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
1560
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 65 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Name Seq DT Len Opt Rep Min Max Tbl Fixed Ex Val
Value
given name 3 ST 30 O 0 1 Marcus
second and 4 ST 30 O 0 1 A
further given
names or
initials
thereof
suffix (e.g., 5 ST 20 O 0 1 III
JR or III)
prefix (e.g., 6 ST 20 O 0 1 DR
DR)
Visit Number 19 CX 250 O False 0 1
ID number 1 ST 15 O 0 1 123456
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
1565 Because this is an unsolicited observation and the Implantable Device – Cardiac – Reporter will
not be aware of an associated order, this segment is optional. The Implantable Device – Cardiac
– Reporter may want to track the interrogation as a visit using this segment. If information is
provided here it will match corresponding information provided in the OBX segments.
PV1-7 Attending Doctor will optionally be captured by the Implantable Device – Cardiac –
1570 Reporter. If present, PV1-7.1 Attending Doctor ID Number will be a unique identifier for each
doctor in the context of the Implantable Device – Cardiac – Reporter, not the Implantable Device
– Cardiac – Consumer.
PV1-19 Visit Number, ID Number will be a unique identifier generated by the Implantable
Device – Cardiac – Reporter for each visit.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 66 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Name Seq DT Len Opt Rep Min Max Tbl Fixed Ex Val
Val
Filler Order 3 EI 424 R False 1 1
Number
entity identifier 1 ST 199 O 0 1 123456
Universal 4 CWE 478 R False 1 1
Service
Identifier
identifier 1 ST 20 R 1 1 Remote
text 2 ST 199 O 0 1
Observation 7 TS 26 C False 0 1
Date/Time
time 1 DTM 24 R 1 1 20040328
134623.1
234+0300
Observation 8 TS 26 O False 0 1
End Date/Time
time 1 DTM 24 R 1 1 20040328
134623.1
234+0300
Results 22 TS 26 C False 0 1
Rpt/Status
Chng -
Date/Time
Time 1 DTM 24 R 1 1 20040328
134623.1
234+0300
Result Status 25 ID 1 C False 0 1 0123 F
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
OBR-2 Placer Order Number will usually be empty given that this is an unsolicited order.
1585 OBR-3 Filler Order Number will contain a unique identifier for the observation / interrogation
session generated by the Implantable Device – Cardiac – Reporter.
OBR-4.1-2 Universal Service ID, Identifier and Text can identify unique OBR segments that
partition observations. The values for this field will be taken from the 11073_10103
MDC_IDC_SESS_TYPE enumerator MDC_IDC_ENUM_SESS_TYPE.
1590 OBR-25 Result Status values will be one of the values in Table 3.9.4.1.2.4-2.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 67 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 68 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
Note: The Structured Numeric type (SN) is used for numeric terms that require qualifications. SN types may be qualified as
1605 >Num1 or <Num1 to express a ‘greater than’ or ‘less than’ relationship using the ‘comparator’ character > or <
respectively. Alternatively, a numeric ratio between two values Num1 and Num2 may be expressed using the
Separator/Suffix characters ‘/’ (solidus) or ‘:’ (either character may be used).
OBX-3.1 Observation Identifier, Identifier shall be <Code> [numeric] as defined in Annex C.3
1610 ‘Expanded Terms’ of IEEE 11073-10103 (see 3.9.3 Referenced Standards).
OBX-3.2 Observation Identifier, shall be <Reference ID> as defined in Annex C.3 ‘Expanded
Terms’ in IEEE 11073-10103 (see 3.9.3 Referenced Standards)
OBX-3.3 Observation Identifier, Name of Coding System shall be MDC to reference the group
of medical device communication standards (IEEE 11073-1010x)
1615 OBX-4 Observation Sub-ID – If a value is provided here the embedded PDF will contain data
related to a specific episode or EGM being referenced via grouping to other episode related data
elements having the same Sub-ID in OBX-4 inside this message.
OBX-5 Observation Value – This is the actual value of the observation.
If OBX-2 is of type CWE then
1620 OBX-5.1 shall be <Code> [numeric] as defined in Annex D.3 ‘enumerations’ or Annex E.3
‘vendor enumerations’ of IEEE 11073-10103 (see 3.9.3 Referenced Standards) .
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 69 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1640 OBX-11 Observation Result Status – This field holds the value from the table HL7 Table 0085 -
Observation result status codes interpretation. Valid values are following: F, P, R, S, & X. The
value N or X denotes a missing or null value, and in this case the OBX-5 will be empty.
OBX-14 Date/Time of Observation – This field is required when the observation reported is
different from the OBR report header. If an observation method is reported in OBX-17 the date
1645 will represent end date/time of the reported time interval.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 70 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
OBX-18 Equipment Instance Identifier – A unique identifier for the equipment or software that
was responsible for the production of the observation
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 71 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Name Seq DT Len Opt Rep Min Max Tbl Fixed Ex Val
Value
Time 1 DTM 24 R 1 1 200403281
34623.123
4+0300
Note: Field names are in Roman type, relevant component names within a field are listed underneath in italic type.
OBX-2 If sending an encapsulated PDF the value will be ED. If referencing an external report
1660 the value will be RP.
OBX-3 Value is a report ID from the LOINC coding system, and will be set to 18750-
0^Cardiac Electrophysiology Report^LN.
OBX-4 If a value is provided here the embedded PDF will contain data related to a specific
episode or EGM being referenced via grouping to other episode related data elements having the
1665 same Sub-ID in OBX-4 inside this message.
OBX-5 If referencing an external document the Observation Value will contain a reference
pointer to the external document.
OBX-5.1 If sending an encapsulated PDF the Type of Data component will have the value
"Application"
1670 OBX-5.2 If sending an encapsulated PDF the Data Subtype component will have the value
"PDF".
OBX-5.3 Will be empty
OBX-5.4 If sending an encapsulated PDF the Encoding component will have the value
"Base64".
1675 OBX-5.5 If sending an encapsulated PDF the Data component contains the encapsulated Base64-
encoded PDF/A document in accordance with ISO 19005-1.
Notes: 1. An actor participating in this transaction must support encapsulated data with a length beyond the nominal 65536
byte limit of the OBX-5.
2. The base64 encoded stream must not include CR/LF characters, which are forbidden within HL7 field text streams.
1680 Breaking a base64 encoded stream into lines of 76 characters or less is used for email in accordance with RFC822, but
is not applicable to encapsulated data in HL7.
The attached PDF or externally referenced report will contain in its content the device ID, patient ID and name if
known, and the dates of the procedure and document.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 72 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
NTE-3 Comments – Contains any notes, comments needed that are not included as part of an
observation.
Communicate Infusion
Event Data
1710
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 73 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 74 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Device Device
Observation Observation
Reporter Consumer
(DOR) (DOC)
1725
1730
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 75 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
See “ISO/IEEE Nomenclature mapping to HL7 OBX-3” in the PCD TF-2: Appendix A.1 for
1755 further information on the mapping rules.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 76 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Appendices
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 77 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The mapping from 11073 to HL7 will be described by focusing on the Medical Package defined
by the Medical Device System shown in Figure A-1: System Package Model and elaborated in
1770 Figure A-2: Medical Package Model.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 78 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The HL7 OBX segment provides two fields which are used in mapping the objects shown in
Figure A-2: Medical Package Model; these are OBX-3 Observation Identifier and OBX-4
1775 Observation Sub-Id.
OBX-3 is expressed as an HL7 Coded Element With Exceptions (CWE) data type and the details
of mapping the 11073 MDC to the HL7 CWE datatype are described in Appendix A.1 ISO/IEEE
Nomenclature mapping to HL7 OBX-3.
OBX-4 is used to express the containment level of a particular item expressed in OBX-3. This is
1780 done by defining the nodes of the <MDS> <VMD> <CHAN> <METRIC> hierarchy of the
containment tree as a set of ordinal numbers expressed in a dotted notation such that each OBX-3
is expressed unambiguously in terms of its containment as defined by OBX-4. This may be
supplemented by a further level or levels to distinguish attributes or other subordinate structures
as may be specified in particular PCD profiles. See under OBX-4 in Appendix B for the details
1785 of the "dotted notation" used to express this containment.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 79 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
For example the OBX-4 for the <VS Mon> <ECG> <Ctach> <HR> would be expressed as
1.2.1.3.
1790 NOTE: The ordinal numbers in an OBX-4 are not normative for a given parameter (identified in
OBX-3) and may vary between implementations. Each OBX-4 Sub-Id must be unique within a
given containment and message but the numbers and mappings may change between messages.
In OBX-2 the valid HL7 types for the mapping are NM, ST, SN, CWE, CF (String may have
some implied structure)
1795 The specification of the containment tree provides a mechanism to address dynamic
configuration of a PCD. For example, a patient monitor may have one or more "plug-ins" which
may be added to and removed from the patient monitor as the patient’s clinical condition
changes. These should be individually identifiable by a unique device instance identifier. When a
plug-in is removed, the ordinal numbers previously assigned to that plug-in should be reserved.
1800 Addition of a new plug-in with a different unique device instance identifier shall result in the
assignment of ordinal numbers which have not been reserved. Replacement of the "known" plug-
in after its removal shall result in the re-assignment of the same reserved ordinal number to the
plug-in that it formerly had. If the DOR system cannot distinguish individual instances of a
module, it may treat modules that are functionally equivalent as though they were the same
1805 module for the purposes of the above scheme.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 80 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1810 Table A.1-1: HL7 Component Table - CWE - Coded With Exceptions
SEQ LEN DT Usage Card. TBL# Component Comments Sec Ref
Name
1 20 ST R [1..1] Identifier Nomenclature 2.A.74
Code
2 199 ST R [1..1] Text Reference ID 2.A.74
3 20 ID R [1..1] 0396 Name of "MDC" 2.A.35
Coding System
4 20 ST RE [0..1] Alternate 2.A.74
Identifier
5 199 ST RE [0..1] Alternate Text 2.A.74
6 20 ID RE [0..1] 0396 Name of 2.A.35
Alternate
Coding System
7 10 ST X [0..0] Coding System 2.A.74
Version ID
8 10 ST X [0..0] Alternate 2.A.74
Coding System
Version ID
9 199 ST X [0..0] Original Text 2.A.74
Definition: This data type transmits codes and the text associated with the code.
Where:
Nomenclature Code is the string representation of the decimal value corresponding to the context free 32 bit representation of
the Nomenclature Code
1815 [context-free] Nomenclature Code = (Code Block number * 2**16) + [context-sensitive], where [context-sensitive] is an
offset, reflecting a particular variant of an associated "discriminator". The Reference ID is also modified to reflect the
variant.
For example, for the "Device Type" Nomenclature, the Device Type discriminator is as follows:
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 81 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1820 Nomenclature codes are obtained from IEEE-11073-10101 Medical Device Communications –
Nomenclature where available. Additional codes that are not yet standardized are contained in
the Rosetta Terminology Mapping (see IHE PCD Technical Framework Volume 3).
The context-free nomenclature code for a term in code block number 1 whose term code=4104 is
equal to ((1 * 2**16) + 4104) = 1*65536 + 4104 = 69640 (which uniquely identifies the SpO2
1825 monitor term) with a Reference ID of MDC_DEV_ANALY_SAT_O2. The context-sensitive
form for the variant "MDS” is “MDC_DEV_ANALY_SAT_O2_MDS (appending the suffix
"MDS"), and the Term Code is 69640+1 = 69641 (adding the Term Code Offset to the base
Term Code).
The OBX-3 representation is “69641^MDC_DEV_ANALY_SAT_O2_MDS^MDC"
1830 The Virtual Medical Device variants are: MDC_DEV_ANALY_SAT_O2_VMD 69642, and
"69642^ MDC_DEV_ANALY_SAT_O2_VMD^MDC" in OBX-3 representation.
To distinguish between periodic and aperiodic data, map from the IEEE 11073 Metric Access to
HL7 and code in OBX-17. This is used where you want to distinguish periodic, aperiodic etc.
Metric Category also provides distinction between manual and automatic.
1835 Examples of device data (as opposed to patient data) that may be included to allow a receiving
system to have a better record of the nature and status of a device are:
MDC_ATTR_SYS_TYPE is used to describe the type of the PCD such as monitor, ventilator,
infusion pump, and shall be mapped at the MDS level in the OBX with the value described by
OBX-3.
1840 MDC_ATTR_ID_MODEL is used to provide device vendor/model and shall be mapped at the
MDS level in the OBX with the value described by OBX-3.
The unique identification of the particular instance of the device is put in OBX-18.
MDC_ATTR_VMS_MDS_STAT describes states - disconnected, configuring, operating,
terminating, disassociated, reconfiguring.
1845 For PCDs with complex operation states such as an infusion pump with a set of states like
"Stopped", "Infusing Primary", "Infusing Secondary", "Bolus", etc., or a ventilator with states
"Standby", "Ventilating", etc., the Device Operational Status Enumeration Object is mapped to
OBX-3.
See the Rosetta Terminology Mapping documents referenced in IHE PCD Technical Framework
1850 Vol. 3 for further examples of device data.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 82 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 83 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The intention of this field is to uniquely identify the software application implementing
1870 the PCD actor sending this message. For valid methods of accomplishing this, see
Hierarchic Designator (HD) Data Type, Appendix Section C.6.
MSH-4 Sending Facility
Components: <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
For the IHE PCD Technical Framework, when populated, this field shall be implemented
1875 as:
First component (required): Namespace ID. The name of the organizational entity
responsible for the DOR, typically the provider institution or department operating the
DOR.
Second component (optional): The Universal ID (see HL7 v. 2.7 Ch. 2) of the
1880 organizational entity responsible for the DOR.
Third component (optional): The Universal ID Type. The codification of these three
components is entirely site-defined. It may be detailed in the national extensions of this
framework.
MSH-5 Receiving Application (HD)
1885 Components: <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>
For the IHE PCD Technical Framework, when populated, this field shall be implemented
as:
First component (required): Namespace ID. The name of the organizational entity
responsible for the receiving application.
1890 Second component (optional): The Universal ID (see HL7 v. 2.7 Ch. 2) of the
organizational entity responsible for the receiving application.
Third component (optional): The Universal ID Type. The codification of these three
components is entirely site-defined. It may be detailed in the national extensions of this
framework.
1895 This field is not required for IHE PCD compliance, but should be populated at the option
of the organization operating the system if the field serves a desired function, such as
facilitating the routing of messages.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 84 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
1900 For the IHE PCD Technical Framework, when populated, this field shall be implemented
as:
First component (required): Namespace ID. The name of the organizational entity
responsible for the receiving facility.
Second component (optional): The Universal ID (see HL7 v. 2.7 Ch. 2) of the
1905 organizational entity responsible for the receiving facility.
Third component (optional): The Universal ID Type. The codification of these three
components is entirely site-defined. It may be detailed in the national extensions of this
framework.
MSH-7 Date/Time of Message:
1910 The IHE PCD TF requires this field be populated with:
Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]
Time zone qualification of the date/time is required. The IHE PCD TF uses the IETF
RFC3339 “Unknown Local Offset Convention” to make it possible to distinguish
between the case where UTC is the preferred reference point for the specified, denoted
1915 with +0000, and the case where the UTC time is known, but the offset to local time is
unknown, denoted with -0000. This distinction is sometimes important in devices.
MSH-7 shall be used only to provide time a message is created by the sending system,
which is different from, and not be interpreted as, the time an observation is taken. See
Section B.8.7 Time Stamps and Time Synchronization for a discussion of general
1920 considerations on time stamps in IHE PCD messages.
MSH-9 Message Type
Components: <Message Code (ID)> ^ <Trigger Event (ID)> ^ <Message Structure (ID)>
Definition: This field contains the message type, trigger event, and the message structure
ID for the message. All three components are required.
1925 Its content is defined within each transaction-specific section of this document.
For [PCD-01], this field must contain ORU^R01^ORU_R01.
The PCD PIV Profile requires that this field be valued as follows:
• RGV^O15^RGV_O15 for the IOP to IOC message that initiates the [PCD-03]
transaction
1930 • ACK^O15^ACK for the IOC to IOP accept acknowledgment message
• RRG^O16^RRG_O16 for the IOC to IOP application acknowledgment message
• ACK^O16^ACK for the IOP to IOC acknowledgment of the IOC to IOP
application acknowledgment message
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 85 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Definition: This data type indicates whether to process a message as defined in HL7
1945 Application (level 7) processing rules.
The IHE PCD Technical Framework requires the first component Processing ID be
valued based on HL7 Table 0103. Use of the second component Processing Mode is
optional but if used is based on HL7 Table 0207.
The value in production systems should be P (Production). When it is desired to
1950 recognize and isolate test data, the value D (Debugging) may be used.
MSH-12 Version ID
Components: <Version ID (ID)> ^ <Internationalization Code (CWE)> ^ <International
Version ID (CWE)>
Definition: This field is matched by the receiving system to its own version to be sure the
1955 message will be interpreted correctly.
The PCD TF is based on HL7 V2.6. Where specific elements of later versions are
required, they have been used and their usage flagged.
Although HL7 allows international affiliate versions to be specified the IHE PCD
Technical Framework uses only the core version (first component of the field).
1960 MSH-13 Sequence Number (ID), required but may be empty:
Definition: A non-null value in this field implies that the sequence number protocol is in
use. The sequence number protocol is not used in IHE PCD.
MSH-15 Accept Acknowledgement Type
Definition: This field identifies the conditions under which accept acknowledgments are
1965 required to be returned in response to this message. Required. Refer to HL7 Table 0155 -
Accept/application acknowledgment conditions for valid values. The receiving system
must send (or not send) acknowledgements as specified by this field.
In [PCD-01], [PCD-04], and [PCD-05] transactions, this field shall be valued as AL.
In [PCD-03] transactions, see Section 3.3.4.4.1
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 86 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Definition: This field contains the principal language of the message. Codes come from
ISO 639.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 87 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
For PCD TF, this field is required in non-ACK messages to allow identification of a
specific message profile, particularly for testing purposes (it is superfluous and therefore
2015 not required in ACK messages). PCD message profiles are assigned ISO OIDs by the
PCD Technical Committee and the appropriate Message Profile Identifiers are to be used
here in conformant messages. When multiple message profiles are listed in this field they
should be (vendor specific, country specific) constraints of the PCD profile. Note that the
overriding of PCD profile constraints is only allowed in national extensions to this
2020 framework.
Assigned OIDs for PCD messages (note that for convenience of reference this table
includes OIDs for some messages that are not yet in Final Text status and are therefore
not described in this Final Text Technical Framework document):
2025
The ISO OID in the table should be used as the universal ID (EI-3). The Universal ID
Type (EI-4) for ISO OIDs is “ISO”. In IHE PCD profiles, the Entity Identifier (EI-1) is
optional and may contain a human-readable name for the profile in the form
“IHE_PCD_XXX” where XXX identifies the IHE PCD transaction, for example,
2030 IHE_PCD_001 for [PCD-01]. Namespace Identifier (EI-2) is also optional, but may
contain “IHE PCD” to identify the source of the profile for a human reader. It is
emphasized that these suggested values are only for human readability and shall play no
role in processing. Processing which depends on the Message profile identifier in the
receiving application or in a test system shall base its recognition of the profile solely on
2035 the ISO OID (Universal ID, EI-3).
Example: IHE_PCD_001^IHE PCD^1.3.6.1.4.1.19376.1.6.4.4.1^ISO
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 88 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2045
MSA-2 Message Control ID
Definition: This field contains the message control ID from the MSH-10 - Message
Control ID of the incoming message for which the acknowledgement is sent.
MSA-3 Text Message
2050 See the ERR segment.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 89 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2055 Notes: ERR-1 is included in HL7 v2.6 for backward compatibility only. Within the context of IHE PCD, this field shall not be
used.
ERR-3 and ERR-4 are required by HL7 v2.6
Use of Error Segment in the PIV Profile. This list of error codes that can occur during the
2060 processing of a PCD-03 message is consolidated from participating pump vendors. The
application acknowledgment from the IOC should contain the Code and Text in ERR-5.1 and
ERR-5.2 respectively. ERR-5.9 can also be used to contain additional text related to the error.
Note that there should be no expectation that each pump vendor or pump model will support all
of the codes in this list.
2065
Code Text Example
9003 Missing required program parameter(s) e.g., Give Amount Minimum (RXG-5) - volume
(ParameterName1, ParameterName2, ...) to be infused - is missing
9005 Parameter (ParameterName) outside of e.g., ordered rate greater than pump maximum
allowable range (MinValue to MaxValue)
9007 Infuser is offline or unable to connect to infuser e.g., infuser not on network or weak wireless
signal
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 90 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
9008 Invalid units for parameter (ParameterName) e.g., Give Strength Volume Units (RXG-24)
contains a medication unit value instead of
volume units
9009 Dose/Rate Units do not match drug library e.g., ordered units = mL/hr; drug library units
=mcg/kg/min
9010 Unable to match medication to drug library e.g., Medication does not exist in drug library
9011 Patient weight mismatch e.g., patient weight known by pump differs from
weight sent in [PCD-03]
9013 Unable to program medication as piggyback e.g., medication not configured for piggyback
administration in drug library
9014 Dose rate or VTBI exceeds maximum e.g., greater than pump maximum
9016 Other error Used when other errors are not applicable
9017 Infuser cannot accept program Infuser is in a state where it cannot accept
program; e.g., alarming or in standby
9018 Parameter (ParameterName) does not match e.g., Give Strength Units (RXG-18) = mg, drug
drug library library = mEq
9020 Patient height missing Drug is BSA-based, but patient height OBX is
missing
9021 Care area or profile mismatch Care area or profile not cleared on pump; or
pump is set to a different care area
9022 Requested infusion program is stale The value of ORC.9 is older than what the IOC
will allow to program the pump
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 91 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
9024 Drug library hard limit exceeded e.g., dose exceeds maximum allowable for
medication
9025 Lockout interval missing Lockout Interval is required when Patient Dose is
present
9026 Dose limit missing PCA dose limit is required but missing
9027 Patient BSA missing Drug is BSA-based but BSA OBX is missing
9028 Tubing, cassette, or syringe not installed on Used when required by pump
pump
9029 Care area or profile not selected Used when required by pump
9034 Not enough fluid or medication in container to Applies to bolus from existing infusion only
deliver bolus
9035 Parent order ID does not match the currently Applies to bolus from existing infusion only
programmed order
9036 Medication does not match the currently Applies to bolus from existing infusion only
programmed order
9037 Medication concentration does not match the Applies to bolus from existing infusion only
currently programmed order
9038 Bolus order type is not supported ORC-1 = “CH” not supported by pump
9039 Medication does not support bolus Medication in drug library not configured for
bolus
9040 Bolus dose units do not match the currently e.g., “mg” instead of “mL”
programmed order
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 92 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
9042 Medication is not configured for loading dose Applies to multistep infusion only
9043 Medication does not support multistep Applies to multistep infusion only
9044 Multistep order type is not supported Applies to multistep infusion only
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 93 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
NTE-1 Set ID
This field may be used where multiple NTE segments are used in a message. Their
numbering must be described in the application message definition.
2090 NTE-3 Comment
This field contains the text of the comment. This text may be formatted. In order to delete
an existing comment, the field shall contain empty quotation marks: "“.
Comment text of identical type and source shall be included in the same occurrence of an
NTE segment, and not be split over multiple segments.
2095 NTE Notes and Comment Segment in PCD-04 Message
By site-specific agreement between implementers of the Alert Reporter and Alert
Manager Actors, additional information not provided for in other segments may be
included in the NTE Notes and Comment segments. Site or system specific indications
are optionally passed in this manner to the Alert Manager for us by its message
2100 dispatching logic, or to pass additional information through the Alert Manager to the
Alert Communicator to communications endpoints.
Optional ad-hoc annotation text to be included in the alert notification text message sent
from the ACM Alert Manager to the ACM Alert Communicator is to be included in an
occurrence of an NTE segment in association with the OBX segment which identifies the
2105 alert indication. This text doesn’t replace any alert notification text synthesized by the
ACM AM from alert data provided to the ACM Alert Manager by the Report Alert PCD-
04 message.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 94 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 95 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The following describes the IHE PCD usage of those fields which have a usage other than X in
2135 the above table and have IHE PCD usage notes added to the general definitions in the HL7 2.6
standard.
PID-3 Patient Identifier List
Definition: This field contains the list of identifiers (one or more) used by the healthcare
facility to uniquely identify a patient (e.g., medical record number, billing number, birth
2140 registry, national unique individual identifier, etc.). In Canada, the Canadian Provincial
Healthcare Number is used in this field.
Component PID-3.1 (in terms of the CX data type, CX-1) "ID number", is required
except where noted under particular transactions. PID-3.4 (CX-4) "Assigning authority",
and PID-3.5 (CX-5) "Identifier Type Code" are required for each identifier if they are
2145 known (for example if they are ordinarily included in ADT messages at the institution),
but may be empty if they are not known. See Appendix CX Data Type. Note that PID-3.4
is an Entity Identifier data type, so it may have subcomponents.
The workflow and mechanism by which patient identification is bound to the data from a
particular PCD device is outside of the scope of the IHE PCD Framework. Common
2150 implementations employ either automated or manual entry based on information provided
by an authoritative source of patient identity.
The IHE PCD recognizes that it is critical for data to be associated with the correct
patient, thus the general rule that at least PID-3 and PID-5 be available for at least two-
factor patient identification, but that there are also situations like emergency admissions
2155 where it may be desirable to collect data before an authoritative patient identification is
available, for later association with the patient’s other data. Only after appropriate study,
risk analysis, and defined risk mitigation measures determined by the provider institution
in consultation with the manufacturers of the systems involved, a defined method for
deferred association of patient data could be designed. In such a case, these fields, instead
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 96 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2160 of being populated with authoritative patient identity information, could be populated
with agreed-on special values (like an automatically generated “stat admit” patient
identifier and a well-known special value in PID-5 indicating the temporary situation)
pending the later human-validated merging of the data.
The IHE PCD recognizes that for some use cases, such as medication administration,
2165 additional identification information or other patient demographic information is required
in addition to an organizationally assigned unique identifier. Patient name, date of birth,
gender, and other information are commonly used to provide the additional patient
identification context for these use cases. Additional patient demographic information is
provided by the fields of the PID segment and the patient location, which is often a key
2170 element in PCD communications, is provided in the PV1-3 element.
PID-5 Patient Name
Definition: This field contains the names of the patient; the primary or legal name of the
patient is reported first. Therefore, the name type code in this field should be "L - Legal"
if such a name is available. If no name is available, the name type code should be "U –
2175 unspecified", and the other components should be empty. All other codes in HL7 Table
0200 – Name Type are also acceptable. Note that "last name prefix" is synonymous to
"own family name prefix" of previous versions of HL7, as is "second and further given
names or initials thereof" to "middle initial or name". Multiple given names and/or
initials are separated by spaces.
2180 The workflow and mechanism by which patient name is bound to the data from a
particular PCD device is outside of the scope of this version of the IHE PCD Framework.
Common implementations employ either automated or manual entry based on
information provided by an authoritative source of patient identity. The workflow and
transactions to bind patient name are included on the IHE PCD Roadmap for
2185 consideration in future versions of the IHE PCD Framework.
See Appendix C.8 XPN Type for further information.
PID-6 Mother’s Maiden Name
Definition: This field contains the family name under which the mother was born (i.e.,
before marriage). It is used to distinguish between patients with the same last name.
2190 See Appendix C.8 XPN Type for further information.
PID-7 Date/Time of Birth
See Appendix C.4, DTM – date/time for further information on how the specification of
times in IHE PCD differs from the HL7 v. 2.6 representation
PID-8 Administrative Sex
2195 Definition: This field contains the patient’s sex. Refer to HL7 User-defined Table 0001 -
Administrative Sex for suggested values.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 97 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2205
PID-11 Patient Address
Components: <Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State
or Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address
Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code
2210 (IS)> ^ <Census Tract (IS)> ^ <Address Representation Code (ID)> ^
<Address Validity Range (DR)> ^ <Effective Date (DTM)> ^ <Expiration Date
(DTM)>
Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street
Name (ST)> & <Dwelling Number (ST)>
2215 Subcomponents for Address Validity Range (DR): <Range Start Date/Time (DTM)> & <Range
End Date/Time (DTM)>
Subcomponents for Range Start Date/Time (DTM): <Time (DTM)> & <Degree of Precision
(ID)>
Subcomponents for Range End Date/Time (DTM): <Time (DTM)> & <Degree of Precision (ID)>
2220 Subcomponents for Effective Date (DTM): <Time (DTM)> & <Degree of Precision (ID)>
Subcomponents for Expiration Date (DTM): <Time (DTM)> & <Degree of Precision (ID)>
Definition: This field contains the mailing address of the patient. Address type codes are
defined by HL7 Table 0190 - Address Type. The PCD only requires the first, third,
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 98 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
fourth, and fifth components to be valued with the mailing address and the Address Type
2225 to be valued as M.
PID-13 Phone Number – Home
Definition: This field contains the patient’s personal phone numbers. This data type is
usually in a repeatable field, to allow a list of numbers. The PCD requires the sequence to
be the primary number (for backward compatibility). The PCD constrains this field to 2
2230 repetitions to allow for a phone number and an email address.
See Appendix C.9 XTN Data Type for further information.
PID-15 Primary Language
See HL7 V2.6 Section 3.4.2.15 for details. The PCD TF requires the use of ISO639 for
the codes.
2235 PID-16 Marital Status
See HL7 V2.6 Section 3.4.2.16 for details. The PCD TF does not further constrain this
field.
PID-17 Religion
See HL7 V2.6 Section 3.4.2.17 for details. The PCD TF does not further constrain this
2240 field.
PID-18 Patient Account Number
See HL7 V2.6 Section 3.4.2.18 for details. The PCD TF does not further constrain this
field. Additional requirements may be documented in Regional or National appendices to
the IHE PCD Technical Framework.
2245 PID-20 Driver’s License Number – Patient
See HL7 V2.6 Section 3.4.2.20 for details. The PCD TF does not further constrain this
field.
PID-21 Mother’s Identifier
See HL7 V2.6 Section 3.4.2.21 for details. The PCD TF does not further constrain this
2250 field.
PID-22 Ethnic Group:
See HL7 V2.6 Section 3.4.2.22 for details. The PCD TF does not further constrain this
field.
PID-23 Birth Place
2255 See HL7 V2.6 Section 3.4.2.23 for details. The PCD TF does not further constrain this
field.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 99 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 100 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
use this field to determine how to apply the transaction to their systems. If the receiving
system (such as an enterprise master patient index) already has a record for the person
with a later last update date/time, then the EMPI receiving system could decide not to
apply the patient’s/person’s demographic and identifying data from this transaction.
2295 See Appendix C.4 DTM – date/time for PCD constraints.
PID-34 Last Update Facility
See HL7 V2.6 Section 3.4.2.34 for details. The PCD TF does not further constrain this
field.
PID-35 Species Code
2300 See HL7 V2.6 Section 3.4.2.35 for details. The PCD TF does not further constrain this
field.
PID-36 Breed Code
See HL7 V2.6 Section 3.4.2.36 for details. The PCD TF does not further constrain this
field.
2305 PID-37 Strain
See HL7 V2.6 Section 3.4.2.37 for details. The PCD TF does not further constrain this
field.
PID-38 Production Class Code
See HL7 V2.6 Section 3.4.2.38 for details. The PCD TF does not further constrain this
2310 field.
PID-39 Tribal Citizenship (CWE)
See HL7 V2.6 Section 3.4.2.39 for details. The PCD TF does not further constrain this
field.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 101 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 102 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
facility ID must be unique across facilities at a given site. This field is required for HL7
2360 implementations that have more than a single healthcare facility with bed locations, since the
same <point of care> ^ <room> ^ <bed> combination may exist at more than one facility.
Details of the PV1 segment as used in the IHE PCD Technical Framework are given in Table
B.6-1: HL7 Attribute Table - PV1 - Patient Visit.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 103 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2365
PV1-2 Patient Class
Definition: This field is used by systems to categorize patients by site. It does not have a
consistent industry-wide definition. It is subject to site-specific variations. Refer to Table
B.6-2 HL7 User-defined Table 0004 - Patient Class for IHE PCD suggested values.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 104 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2375 nursing station for inpatient locations, or clinic or department, for locations other than
inpatient.
For IHE PCD usage, see Appendix C.7 PL Data Type.
PV1-19 Visit Number
IHE PCD definition: This field contains the unique number assigned to each patient visit.
2380 PV1-44 Admit Time / Date
HL7 Definition: This field contains the admit date/time. It is to be used if the event
date/time is different than the admit date and time, i.e., a retroactive update. This field is
also used to reflect the date/time of an outpatient/emergency patient registration. IHE
PCD does not further constrain this field.
2385 PV1-51 Visit Indicator
HL7 definition: This field specifies the level on which data are being sent. It is the
indicator used to send data at two levels, visit and account. IHE PCD implementations
shall send an ‘A’ or no value when the data in the message are at the account level, or ‘V’
to indicate that the data sent in the message are at the visit level.
2390 The value of this element affects the context of data sent in PV1, PV2 and any associated
hierarchical segments (e.g., DB1, AL1, DG1, etc.).
2400
PV1-3 Assigned Patient Location (PL)
This field contains the location associated with the alert. It is typically a location
established by an external system such as ADT, as in the patient assigned bed location as
used in association with a patient station of a nurse call system. This may not be the
2405 current location of the relevant patient.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 105 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 106 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This field is conditionally required as described in HL7, where the placer id may be sent
in either the ORC or the OBR segment. If the observation is in response to an order, then
the ordering application’s placer number and naming system should be returned here. If
2435 there is no placer number, for example in a "standing" order that is documented as a
hospital specific protocol, then the Device Observation Reporter may assign one and send
it here as specified in HL7.
The PCD TF requires at a minimum that Entity Identifier (EI-1) and Namespace ID (EI-
2) be valued and recommends that the Namespace Id (EI-2) shall refer to the locally
2440 unique application identifier assigned to the Device Observation Reporter application
implementing IHE PCD actors which fill the role of an ordering application such as the
DOR. In order to avoid conflicting Ids in any context, it is desirable, though not required,
that the assigning application be identified according to a Universal ID system by giving
a value for Universal ID (EI-3) and Universal ID type (EI-4). If EI-3 and EI-4 are valued,
2445 then EI-2 (Namespace ID) is not required.
See Appendix C.5 EI Data Type for further information.
See HL7 V2.6 Section 7.4.1.2 for details. The PCD TF does not further constrain this
field.
OBR-3 Filler Order Number
2450 Definition: This field is the order number associated with the filling application. This is a
permanent identifier for an order and its associated observations. It is a special case of the
Entity Identifier data type. The first component (EI-1, Entity Identifier) is a string that
identifies an order detail segment (e.g., OBR). It is assigned by the order filler (receiving)
application. This string must uniquely identify the order (as specified in the order detail
2455 segment) from other orders in a particular filling application (e.g., patient monitoring
gateway). This uniqueness must persist over time. The second through fourth components
contain the filler application ID, in the form of the HD data type. The second component
(Namespace ID, EI-2) is a user-defined coded value that uniquely defines the application
from other applications on the network. The Namespace ID of the filler order number
2460 always identifies the actual filler of an order.
The PCD TF requires that the Universal ID (EI-3) be valued with a Unique ID for the
application identifier assigned to the application implementing IHE actors supporting the
role of an order filler such as the DOR (Device Observation Reporter). The Universal ID
Type (EI-4) shall be valued with the appropriate type notation corresponding to the
2465 Unique ID. The preferred Universal ID type for IHE PCD is the EUI-64 code. The
Universal ID type (EI-4) is then "EUI-64". In cases where an EUI-64 is not available, less
preferred Universal IDs for the application may be used as detailed in Appendix C.5 EI
Data Type. For compatibility with older receiving systems, the PCD TF recommends that
the Entity Identifier (EI-1) be valued with a duplicate of the Universal ID as in EI-3. The
2470 Namespace ID (EI-2) is not required but for backward compatibility may be valued with
a "legacy" locally unique identifier for the filler application.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 107 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
In some contexts, the service identifier used in this field may usefully contain information
on which the receiving system can base decisions about further processing for the
2500 message, including not processing the message if the content is not wanted (e.g.,
waveform information that the receiving system is not able to use).
Local codes are permissible if no appropriate SNOMED CT term can be used, but users
of this Technical Framework who encounter a situation where a new type of service
related to patient care devices is identified should submit a description of the service to
2505 the PCD Technical Committee so that provisional codes can be defined, and permanent
codes requested from an appropriate standards development organization.
An accepted "legacy" usage is for OBR-4 to contain an EUI-64 identification for the
sending system. This was required in previous versions of this Technical Framework.
This is acceptable as a local code for a "service" that consists of sending the PCD data
2510 that the particular system is configured to send and which is understood by the receiving
system, by local agreement.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 108 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 109 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<effectiveTime>
2560 <low value="20100101091820.000+0000" inclusive="true" />
<high value="20100101091830.000+0000" inclusive="false" />
</effectiveTime>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 110 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 111 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 112 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2655
PRT-1 Participation Instance ID (EI) 02379
This field contains a unique identifier of the specific participation record.
PRT-2 Action Code (ID) 00816
For the PCD-04 message this field shall contain the value AD indicating Add.
2660 PRT-3 Action Reason (CWE) 02380
For the PCD-04 message this field is optional.
PRT-4 Participation (CWE) 02381
For [PCD-04] this field shall contain Alert Reporter indicating Alert Recipient. This is an
addition to HL7 v2.8 Table 0912 specifically for the PCD-04 message such that PRT
2665 segment occurrences identifying alert recipients can be unambiguously identified for
processing, independent of unrelated to alert processing PRT segments containing RCT
(indicating Result Copies To).
PRT-5 Participation Person (XCN) 02382
This is the identification of the person that is the recipient of the alert notification. If this
2670 field is populated it shall unambiguously resolve to one person. If this field is populated
and PRT-15 is not populated it presumes the Alert Manager will internally resolve the
person to their currently assigned endpoint communication device or devices.
PRT-6 Participation Person Provider Type (CWE) 02383
For the PCD-04 message this field is optional.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 113 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 114 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
It is important to note that the values used for the OBX fields depend upon whether the OBX is
2710 being used to provide information about the device(s) from which measurements are derived or
to provide information related to the measurement metrics and related information. The IHE
PCD TF defines the appropriate coding for usage in a device related or metric related context.
Each OBX shall be coded for a specific context – device related or metric related.
2715
OBX-1 Set ID - OBX
This field contains the sequence number of the OBX in this message; i.e., 1st OBX Set
ID = 1, 2nd OBX set ID = 2, etc., regardless of whether the OBX refers to a device or a
metric value.
2720 OBX-2 Value Type
Condition Predicate: must be valued if the value of OBX-11 is not X.
The Value Type field shall be filled according to HL7 Version 2.6 standard (table 0125).
For example, if the result is ">300" the Value Type "SN" (Structured Numeric) SHALL
be used instead of the "ST" (String) value type that was used in previous versions of
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 115 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2725 HL7. For example, if reporting a displayed I:E ratio of 1:2, the Value Type "SN"
(Structured Numeric) MAY be used in lieu of the "NM" (Numeric) datatype, e.g.,
|^1^:^2|, to express the ratio in a clinically familiar format (the "ST" value type SHALL
NOT be used in this case). See the details and the examples in the HL7 V2.6 (7.4.2). For
an observation that consists of a time measurement (e.g., bleeding time) the TM Value
2730 Type is preferred to NM but this is not made mandatory.
Refer to TF-3 for details of the data types used in the mappings.
OBX-3 Observation Identifier
Identifies the type of device providing the related values. This is required if structured
device (and if relevant, subdevice) identification is provided in the message. For the PCD
2735 TF, this shall be used for all devices capable of providing structured device information.
For the IHE PCD transactions, implementations shall use the terms defined in the current
version of the Harmonized Rosetta Terminology (Volume 3 of the Technical Framework
contains further details and references on the Rosetta Terminology Mapping as well as
important information on system responsibilities regarding terminology). The Rosetta
2740 codes are based on terms from the ISO/IEEE 11073 Nomenclature where available, and
where the Nomenclature does not currently contain a matching term, gives provisional
vendor-neutral terms to be submitted to the IEEE 11073 Upper Layers Committee as
suggestions for adoption into the Nomenclature. If term cannot be found in this way and a
matching term is available in LOINC, then the next preference is to use the LOINC term.
2745 If LOINC also does not support a term then SNOMED CT or another coding scheme
recognized by the HL7 standard takes precedence if a matching term is available. In the
cases where such resources are not explicitly identified by standards, implementations
may, by local arrangement, utilize any resource (including proprietary or local) to achieve
compatibility among the systems involved, provided also that any licensing/copyright
2750 requirements are satisfied
In the case where the nomenclature term does not convey the distinction between an
observation measurement and a setting for a quantity that may be either, see OBX-17
Observation Method for a way of encoding the distinction.
In the case where the nomenclature item does not distinguish between a manually
2755 initiated (episodic) measurement and one that is automatically initiated on a schedule
(periodic measurement), the OBX-17 Observation Method may also be used to add this
information.
OBX-4 Observation Sub-ID
This field shall be used to distinguish between multiple OBX segments and represent the
2760 hierarchical (containment) relations among the segments. It does so by providing an
unambiguous mapping from observation contained in the OBX segment to the IEEE
11073 containment tree for the Medical Device System sourcing the observation (see
Appendix A Mapping ISO/IEEE 11073 Domain Information Model to HL7).
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 116 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 117 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
2845 Expected future usage, not supported in current version of the Technical Framework: If it
is desired to add OBX segments giving values for attributes of an MDS, VMD, or channel, that
is, information about the MDS, VMD or channel itself rather than a contained metric (for
example, the battery state of a portable monitor which applies to the whole device rather than to
a particular metric, or the off-on state of a module corresponding to a VMD), the OBX segments
2850 giving the information should immediately follow the relevant 'device-related' OBX segment,
and should have as its OBX-4 value the OBX-4 value of the relevant MDS, VMD, or channel,
followed by a non-zero facet number. Multiple attributes of this kind shall have distinct facet
numbers.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 119 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3. The sequences of MDS, VMD, Channel, and Metric numbers in the OBX-4 value shall
be in dictionary (lexicographic) order following the usual mathematical definition (see,
for example, https://en.wikipedia.org/wiki/Lexicographical_order). An acceptable
variation is to include all device-related OBX segments with their OBX-4 values in
2890 dictionary order, followed by all metric OBX segments in lexicographic order – this also
achieves the design goal of having all references from metric OBX segments to device-
related segments be references to information sent earlier in the data stream.
4. If follows from this and the structure and rules already given for OBX-4 components, that
the metric OBX segments follow their corresponding device-related OBX segments.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 120 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
State, and Evidentiary Data that must be conveyed in associated additional OBX segments
beyond the first. They shall be in Facet value sequential ascending order.
As of IEEE 11073-10101a the ACM Profile now has official MDC codes and REFIDs for the
alert basic containment observations. Use of these official values is required for implementations
2915 going forward. Use of <FACET> is retained for backward compatibility for existing
implementations.
The FACET are identified by their associated OBX-3 Observation Identifier. Refer to the OBX-3
Value column in Table B.8.5-1 for the value of OBX-3. For identification of physiological
(numeric) alarms versus technical (non-numeric) alarms refer to the value of OBX-8 Abnormal
2920 Flags for the Event Identification Facet.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 121 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 122 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
*Alarm Priority and Alert Type inclusion location is either-or. Either both are indicated in components of the same OBX-8
Abnormal Flags field of the OBX segment occurrence associated with the alert indication or both as separate OBX
2925 segment occurrences, one for MDC_ATTR_ALERT_TYPE and one for MDC_ATTR_ALARM_PRIORITY. The
OBX-8 components approach is deprecated. All new implementations are to use the separate OBX segments approach.
The effectivity is such that the Alert Manager shall implement the new approach in addition to the original approach.
The new approach takes precedent over the original approach. If both approaches are present, the Alert Manager shall
ignore the original approach.
2930 Table B.8.5-2: Report Alert PCD-04 Facet Usage by Alert Type
Facet Usage by Alert Type
Facet Name
Alarm Alarm
Advisory
Physiologic Technical
Event Identification R R R
Source Identification R R R
Event Phase R R R
Alert State R R R
Inactivation State R R R
Alarm Priority* R R R
Alert Type* R R R
Table B.8.5-3: ISO 60601-1-8 Alarm condition and alarm signal states mapping to IHE
ACM PCD-04 attributes
ISO 60601-1-8 ISO Value IHE ACM PCD-04 IEEE 11073-10101a attribute and value
Alarm Condition 68482^MDC_ATTR_ALARM_STATE^MDC (multiple is ok)
State
Off (off – need to CP ACM/PCD TF to add value)
Inactive Inactive
Active Active
Latched Latched (may be indicated with other enumeration values)
Alarm condition 8485^MDC_ATTR_ALERT_TYPE^MDC
type
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 123 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
ISO 60601-1-8 ISO Value IHE ACM PCD-04 IEEE 11073-10101a attribute and value
Physiological SP – Physiological
Technical ST – Technical
(Information?) SA – Advisory [alert, but not an alarm]
Alarm type class Indicated in alert indication MDC/REFID
Threshold
Event
Alarm Limit Indicated in the alert indication MDC/REFID
Violation
High
Low
event description
Alarm Condition 68484^MDC_ATTR_ALARM_PRIORITY^MDC
Priority
High PH – High
Medium PM – Medium
Low PL – Low
Information (PI – need to CP ACM/PCD TF to add value)
(not-indicated) PN – Not Indicated
(not-known) (PU – need to CP ACM/PCD TF to add value)
Alarm signal 68483^MDC_ATTR_ALARM_INACTIVATION_STATE^MDC
inactivation state
none (enable?) enabled (note the “d” on the end)
audio-paused audio-paused
audio-off audio-off
alarm-paused alarm-paused
alarm-off alarm-off
acknowledged alert-acknowledged – per ACM/PCD TF CP #126
Phase is not an 68481^MDC_ATTR_EVENT_PHASE^MDC
attribute
tpoint, start, start_only, continue, end, present, update, escalate, inactivate,
acknowledged – per ACM/PCD TF CP #126, deescalate, reset, stop,
(ACM/PCD TF CP to add information or maybe no_alert phase indication
for signaling of AIS updates not in the presence of active alerts)
Source is an 68480^MDC_ATTR_ALERT_SOURCE^MDC
implied attribute
VMD, plus preferably CHAN
observation field is variable, depending upon OBX-3-value type. This field may repeat
2945 for multipart, single answer results with appropriate data types, e.g., CWE, TX, and FT
data types.
When the Observation Value is numeric, IHE PCD adopts the convention that the number
of digits to the right of the decimal point shall reflect the precision ascribed by the device
to the measurement and such digits shall not be arbitrarily dropped from string
2950 representations of the value. So if the measurement has, say, two significant digits after
the decimal point and happens to include one or more trailing zeros, the string
representing the measurement shall include the trailing zeros to reflect precision, even
though they do not change the numeric value.
For the PCD TF this field is required for metric related segments and is null for device
2955 related segments.
OBX-5 Observation Value in PCD-04 and other Alert Communications transactions
This field contains the value observed by the Alert Reporter. Its meaning differs
according to the facet identified in OBX-4 Sub-ID (see above). The following sections
give the details for each facet.
2960 In all cases, OBX-2-value type contains the data type for this field according to which
observation value is formatted. It is not a required field because some systems will report
only the abnormal flags for the observation (OBX-8). The length of the observation field
is variable, depending upon OBX-3-value type. This field may repeat for multipart, single
answer results with appropriate data types, e.g., CWE, TX, and FT data types.
2965 Event Identification Facet
The identity of alerts is represented by event codes from ISO/IEEE 11073-10101
nomenclature for alerts (Block E).
For the ACM Profile in the PCD-04 message, the OBX instance associated with the
Event Identification Facet (where OBX-5 is equal to
2970 196616^MDC_EVT_ALARM^MDC or the identification of the physiologic limit exceed
for physiologic alarms), can be followed by an optional OBX instance to communicate
Alert Reporter Actor originated display text/print text. The MDC and REFID are defined
in IEEE 11073-10101B [Editor’s note: preliminary MDC is 0, preliminary REFID is
MDCX_ATTR_ALERT_ANNOTATION]. The data type for the OBX-5 value shall be
2975 either string (ST) or formatted text (FT). The permits inclusion of text formatting
indications or the inclusion of characters from international character sets. The Alert
Manager will optionally use the Alert Reporter provided text as a suffix to the Alert
Manager synthesized alert text to be included in the alert text to be communicated to the
Alert Communicator alert notification recipients. The Alert Manager (AM) shall include
2980 a separator character (commonly space) or character sequence (commonly space dash
space) between the Alert Manager (AM) synthesized text and the Alert Reporter (AR)
provided annotation text.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 125 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This capability permits the Alert Reporter to contribute text specifically for inclusion into
the Alert Manager synthesized alert notification text. This can be useful in the case of
2985 textual information not well integrated into an HL7 standard data item. It can also be used
as a foreign language mapping of the alert reason for which the Alert Manager requires
abstraction. This abstraction is meaningful in scenarios where the Alert Reporter, the
alerting medical device, and the alert notification recipients are in one country, and the
Alert Manager is centralized in a different country.
2990 The alert notification text is expected to be rapidly actionable. To that end the additional
text supplied by the AR should be relatively short.
The AR provided additional text is not expected to be utilized for communicating alert
remedies. Remedies would be expected to utilize a distinctly different MDC and REFID.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 126 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Values in the “Assigned” column are in the 11073 standard. “Future assignments” indicates
3010 values in common use not yet in the 11073 standard.
The EventCurrentPhase identifies the state transition or state that the current alert message is
indicating: a tpoint event is a time point event with no duration, a continue event indicates that
3015 this message does not represent a state transition but rather reports the continuation of an event
that started at some previous time. An update indicates a change other than a state transition in a
previously reported alert, such as a further change in an out-of-limit metric. The phases escalate
and de-escalate represent changes in alert priority as assessed by the patient care device.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 127 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
State transitions
3020 A message representing an alert is sent aperiodically, when the alert undergoes a state transition
that may be significant for notification (alert start, alert end, escalation or de-escalation of
priority as evaluated by the alert source).
By site agreement, messages representing current state of alerts may optionally also be sent at
other times, as for example on a periodic timed basis, or when systems are restarted and a list of
3025 currently active alerts is sent out by the Alert Reporter to refresh the Alert Manager.
Alert current state facet
The value of the AlertState facet reflects whether the alert condition currently exists (inactive or
active) or if the alert condition formerly existed, does not now exist, but is “latched” or held by
the alert source so that caregivers may be notified of transient but significant conditions.
3030
class ACM V6.0 - 2016
«enumeration»
«enumeration» «enumeration»
Ev entCurrentPhase
AlarmState AlarmInactiv ationStateIEEE
tpoint
inactive enabled
start
active audio-paused
continue
latched audio-off
end
alarm-paused
notes update
alarm-off
Sent as OBX-5 escalate
Observation Value of a notes de-escalate
child OBX segment of the Pertains to a set of device alarms - reset
alarm bundle individual, group, system notes
Sent as OBX-5 Observation Value of a Sent as OBX-5 Observation Value of a
child OBX segment of the alarm bundle child OBX segment of the alarm bundle
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 128 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
• audio-off
If neither 'alarm-paused' nor 'alarm-off' is included, the visual alarm indication is assumed to be
3045 enabled regardless of whether 'enabled' is also present.
If neither 'audio-paused' nor 'audio-off' is included, the aural alert indication is assumed to be
enabled regardless of whether 'enabled' is also present.
If the optional state indication ‘acknowledged’ is included, it indicates that the alert has been
acknowledged at the alert source device. This indication offers no assurance of a resolution time
3050 for the active alert. This is independent of ‘audio-paused’ and ‘audio-off’ and is a latched status
indication until the alert ends.
OBX-6 Units
See HL7 2.6 Section 7.4.2.6 for further information.
For the PCD TF:
3055 Condition predicate: If OBX-5 is populated with a numeric value then OBX-6 must
contain an appropriate value. For Device Related if OBX-7 is being used for operating
range then populate.
The units used should be in conformance with the Rosetta Terminology (see PCD TF-3
for further details and references). The preferred format is an MDC value, secondly a
3060 UCUM value.
OBX-7 Reference Range
For metric related segments, this should be used to provide the value ‘alarm’ ranges set
with respect to the observed value metric in this OBX, although this is not strictly a
reference range in the sense of the examples given in HL7.
3065 For device related segments this may be used to provide the device measurement range
capability – NOT the metric value ‘alarm’ ranges which shall be in the appropriate
observed value metric OBX, as indicated above.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 129 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Further details of missing or invalid data can be given with codes based on nullFlavors:
6
The HL7 V2.6 IS data type is limited to 5 chars and so these mnemonics cannot be used. Although HL7 V2.7
replaces the IS datatype with the CWE datatype and longer mnemonics we need to restrict this to be compatible with
HL7 V2.6 for now. OBX-8 can be a repeated field with ~ separators.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 130 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3085
This is a repeatable field and values from the above tables may be combined by entering them as
repetitions of the field, for example, a field value of 'H~PH~SP' would signify a physiological
measurement with an abnormally high value, constituting a high priority alert condition.
OBX-8 Abnormal Flags in PCD-04 and other Alert Communications transactions
3090 The following abbreviations in the OBX-8 Abnormality Flags field can be used to indicate the
type of abnormality, its priority as indicated by the alert source, and whether the alert is a
physiological alarm based on monitoring observations from the patient, or a technical alarm
indicating a condition of the patient care device and not the patient which nonetheless requires
caregiver action, an advisory, or a combination if simultaneous.
3095
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 131 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3100
This is a repeatable field and values from the above table may be combined by entering them as
repetitions of the field, for example, a field value of 'H~PH~SP' would signify a physiological
measurement with an abnormally high value, constituting an alert that is a high priority
physiological alarm condition. These values shall be recorded in the OBX-8 field of the OBX
3105 segment occurrence associated with the OBX segment identified by the Facet value (1)
associated with Event Identification.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 132 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 133 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
OBX-14 unless they have a time stamp of their own in OBX-14. Channel-level OBXs
with filled OBX-14 fields establish a default time stamp for their contained metric
observations.
3140 For the PCD TF the value is the same as OBX-19 Date/Time of the Analysis, but should
be used in preference to OBX-19 if time of the particular observation is relevant and is
different than OBR-7 (that is, in the case of an episodic observation). The OBX-14 time
stamp may be duplicated in OBX-19 if local needs dictate.
OBX-16 Responsible Observer
3145 For the PCD TF:
The identifier values for the Operator ID field may null, if unknown or unspecified at the
sending device.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 134 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This field can convey the distinction between measurements (AMEAS or MMEAS)
settings (MMEAS or MSET), as well as whether the measurement or setting was initiated
3165 by an operator (MMEAS, as in an episodic measurement, MSET, as in a manual setting)
or automatically, as in a periodic measurement (AMEAS).
If omitted, the default value is AMEAS.
OBX-18 Equipment Instance Identifier
This field identifies the Equipment Instance (e.g., infusion pump, physiological monitor)
3170 responsible for the production of the observation. This is to provide specific traceability
for the source of the observation, and so identification should identify the equipment at
the lowest practical subsystem level where this applies: for example, the individual
removable module in a physiological monitor. This allows an observation or a trouble
indication to be traced to its source as specifically as possible.
3175 Future implementation note: as of HL7 V2.7, this field is retained for backward
compatibility only. This field will be represented through the PRT segment. Future
versions of the IHE PCD Technical Framework will require the use of this segment,
which will also provide for including the Unique Device Identification adopted by the
U.S. F.D.A. and being considered by regulatory agencies in other jurisdictions.
3180 For the PCD TF:
The preferred format is an EUI-64 Device ID. The Device Identifier should be globally
unique.
Every device be should be identified by a universally unique identifier in the format
specified by IEEE for the EUI-64 identifier (e.g., "1234567890ABCDEF"). To allow the
3185 Observation Reporting interface to be employed with ‘legacy’ Devices, this field may
also be populated by a combination of serial number, model, and manufacturer (see
Section C.5 EI Data Type for details of how this may be done). If the EUI-64 identifier is
available, it should be recorded in the ‘universal ID’ component of this field. If it is not
available, the manufacturer’s unique device identifier (e.g., serial number) should be
3190 recorded in ‘Entity Identifier’ component (EI-1), with the model identification in the
Namespace ID (EI-2), and the manufacturers identity in the universal ID (EI-3) using an
OID or URI scheme (which should be identified in the universal ID type, EI-4).
Note that OBX-18 is repeatable, and HL7 suggests that where a hierarchical
identification of the equipment is desired (e.g., module or VMD within Medical Device
3195 System) that the lowest-level equipment be sent first, followed by higher levels in
succession.
A permissible optimization is to not send the full hierarchy with every observation, but
rather the identification should be sent at the highest level of device related OBX
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 135 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
possible: i.e., MDS, then VMD, and then Channel. Inheritance should be assumed; i.e.,
3200 for multivalued results from the same Device, this field is required only in the first OBX
segment.
For metric related data this field is not required – unless no device hierarchy, and
therefore related OBXs, is being declared; in which case the device ID should be
provided here if available. Inheritance should be assumed; i.e., for multivalued results
3205 from the same Device, this field is required only in the first OBX segment.
Device identifiers shall be reported in OBX-18, data type ‘EI’ (Entity Identifier), for the
MDS level for PCD devices and DEV_SPEC_PROFILE for PHD devices.
|0123456789ABCDEF^^0123456789ABCDEF^EUI-64|
See the discussion of the EI data type in Appendix C.5 for further details and examples.
OBX-19 Date/Time of the Analysis
Conditional Predicate: May be used if duplicate of OBX-14 is needed in this field by
3230 receiving system.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 136 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
For the PCD TF use OBX-14 preferentially if device time is relevant. Information in
OBX-14 may be duplicated here if local needs dictate.
OBX-20 Observation Site
Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^
3235 <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate
Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding
System Version ID (ST)> ^ <Original Text (ST)>
Definition: This field typically contains the body site(s) where the measurement being
reported was obtained. This field should not be used for a specimen source or specimen
3240 collection site.
This information is of particular importance if the clinical meaning of a value is modified
either directly by the site (for example, is the temperature central or peripheral?) or if the
site of one measurement impacts the value of another measurement (for example, is the
finger SpO2 probe on the same arm as the NIBP cuff?). In most cases these observations
3245 are performed directly upon the patient and do not involve a specimen.
Any nationally recognized coding system might be used for this field including
SNOMED or MDC; alternatively, the HL7 Table 0163 may be used. Veterinary medicine
may choose the tables supported for the components of this field as decided by their
industry.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 137 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Notes:
Status column gives Presence Qualifier, M: mandatory, O: option, C: conditional.
The dotted numbers represent the object hierarchy value of OBX-4 and are provided as example values only.
3275 a. DTMDOR is the datetime of the DOR, reported with an IHE PCD modification of the HL7 V2.6 ‘date/time’ data type
differing in the specification of the time zone offset. See Appendix C.4 for details. A time stamp resolution of at least
one second and a time zone offset are required, e.g., YYYYMMDDHHMMSS[.S[S[S[S]]]]+/-ZZZZ (required items
shown in bold font).
b. Within the time scope of each OBR and the time interval expressed in [OBR-7, OBR-8), time discontinuities in the
3280 MDC_ATTR_TIME_ABS displayed time are prohibited. Discontinuities due to daylight savings or other clock
adjustments require that data on the new displayed timeline shall be sent as a separate OBR.
c. The OBR establishes the default time context for all its child OBXs, but can be overridden by a time stamp in OBX-14.
d. The time interval specified by [OBR-7, OBR-8) is a mathematically ‘closed’ interval for OBR-7 and ‘open’ for OBR-8.
A datum that occurs exactly at the time specified by OBR-8 would be sent in the next time epoch. This allows
3285 subsequent OBR segments to represent a continuous sequence of time. For encoding a simple set of episodic
measurement, if there is no logical "end" of the observation period, OBR-8 may be set to the message creation time to
indicate the logical upper limit for the contained observations.
HL7 time stamps sent in MSH-7, OBR-7, OBR-8 and OBX-14 should in most situations be
3290 ‘consistent time’ based on NTP or any other reference time source that provides traceability to
NTP when this is feasible. As a consequence, it is strongly encouraged that the gateway or
application device (AHD) support synchronized time as an NTP or SNTP (or other time service)
client so that it can (1) apply consistent time stamps to the data reported over the WAN interface
and (2) provide a time synchronization service to the agents connected to it.
3295 The MDC_ATTR_TIME_ABS (in OBX-3) observation provides traceability between the
displayed time shown on the device, as a DTM datatype in OBX-5, and the corresponding
gateway or AHD time reported in OBX-14.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 138 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 139 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Table B.8.9-1: OBX-5 Values for Device and/or DOR Synchronization Protocol
OBX-5 values (choice of one) Synchronization Protocol Part::Co Default
de
532224^MDC_TIME_SYNC_NONE^MDC An uncalibrated and unsynchronized local 8::7936 ± 300 s (5 min)
clock source
––––––^MDC_TIME_SYNC_EBWW^MDC A manually set time, by ‘eyeball and –:–––– ± 120 s (2 min)
wristwatch’8
532225^MDC_TIME_SYNC_NTPV3^MDC Network Time Protocol Version 3.0 8::7937 calculate
(RFC1305)
532226^MDC_TIME_SYNC_NTPV4^MDC Network Time Protocol Version 4.0 (under 8::7938 calculate
dev)
532227^MDC_TIME_SYNC_SNTPV4^MDC Simple Network Time Protocol v4 8::7939 estimate
(RFC2030)
532228^MDC_TIME_SYNC_SNTPV4330^M Simple Network Time Protocol v4 8::7940 estimate
DC (RFC4330)
532229^MDC_TIME_SYNC_BTV1^MDC Bluetooth Medical Device Profile 8::7941 not absolute9
––––––^MDC_TIME_SYNC_NCK^MDC HL7 V2 ‘NCK’ System Clock Segment in –:–––– + 5 s, - 0 s
NMD msg
––––––^MDC_TIME_SYNC_GPS^MDC Global Positioning Service (GPS) –:–––– calculate
8
The ‘EBWW’ code was defined in ISO/IEEE 11073-30200, indicating a local time-of-day clock that was manually
set by the ‘eyeball and wristwatch’ method.
9
The synchronization accuracy of the Bluetooth BTV1 clock to an absolute time reference should be reported using
MDC_ATTR_TIME_HI_RES, and OBX-5 should contain the value of the BTV1 clock.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 140 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The following describes the IHE PCD usage of those fields which have a usage other than X in
3325 the above table.
ORC-1 Order Control
Definition: Determines the function of the order segment. The PCD TF requires that this
field be valued as RE, XO, or CH according to the table below when the
RGV^O15^RGV_O15 Pharmacy/Treatment Give Message is used to send information
3330 from the Infusion Order Programmer (IOP) to the Infusion Order Consumer (IOC).
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 141 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3350 See HL7 V2.6 Section 4.5.1.3 for details. The PCD TF does not further constrain this
field.
ORC-4 Placer Group Number
See HL7 V2.6 Section 4.5.1.4 for details. The PCD TF does not further constrain this
field.
3355 ORC-5 Order Status
See HL7 V2.6 Section 4.5.1.5 for details. The PCD TF does not further constrain this
field.
ORC-6 Response Flag
See HL7 V2.6 Section 4.5.1.6 for details. The PCD TF does not further constrain this
3360 field.
Definition: This field relates a child to its parent when a parent-child relationship exists.
The parent-child mechanism is described under HL7 Table 0119 - Order control codes .
3370 The first component has the same format as ORC-2-placer order number (Section 4.5.1.2,
"Placer Order Number (EI) 00216"). The second component has the same format as
ORC-3-filler order number 4.5.1.3Filler Order Number (Section , "(EI) 00217"). The
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 142 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
components of the placer order number and the filler order number are transmitted in sub-
components of the two components of this field.
3375 ORC-8-parent is the same as OBR-29-parent. If the parent is not present in the ORC, it
must be present in the associated OBR. (This rule is the same for other identical fields in
the ORC and OBR and promotes upward and ASTM compatibility.) This is particularly
important when results are transmitted in an ORU message. In this case, the ORC is not
required and the identifying filler order number must be present in the OBR segments.
3380 ORC-9 Date/Time of Transaction
The time in this field should be the time the clinician initiated the program request, not
the time the IOP generated the message. The IOC may use this field to determine if the
request is stale or too old.
See HL7 V2.6 Section 4.5.1.9 for details. The PCD TF does not further constrain this
3385 field.
ORC-10 Entered By
See HL7 V2.6 Section 4.5.1.10 for details. The PCD TF does not further constrain this
field
ORC-11 Verified By
3390 See HL7 V2.6 Section 4.5.1.11 for details. The PCD TF does not further constrain this
field.
ORC-12 Ordering Provider
See HL7 V2.6 Section 4.5.1.12 for details. The PCD TF does not further constrain this
field.
3395 ORC-13 Enterer's Location
See HL7 V2.6 Section 4.5.1.13 for details. The PCD TF does not further constrain this
field.
ORC-14 Call Back Phone Number
See HL7 V2.6 Section 4.5.1.14 for details. The PCD TF does not further constrain this
3400 field.
ORC-15 Order Effective Date/Time
See HL7 V2.6 Section 4.5.1.15 for details. The PCD TF does not further constrain this
field.
ORC-16 Order Control Code Reason
3405 See HL7 V2.6 Section 4.5.1.16 for details. The PCD TF does not further constrain this
field.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 143 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Definition: This field contains the identity of the caregiver who initiated the event.
3425 Subfield XCN-1 "ID number" is required for each identifier.
ORC-20 Advanced Beneficiary Notice Code
See HL7 V2.6 Section 4.5.1.20 for details. The PCD TF does not further constrain this
field.
ORC-21 Ordering Facility Name
3430 See HL7 V2.6 Section 4.5.1.21 for details. The PCD TF does not further constrain this
field.
ORC-22 Ordering Facility Address
See HL7 V2.6 Section 4.5.1.22 for details. The PCD TF does not further constrain this
field.
3435 ORC-23 Ordering Facility Phone Number
See HL7 V2.6 Section 4.5.1.23 for details. The PCD TF does not further constrain this
field.
ORC-24 Ordering Provider Address
See HL7 V2.6 Section 4.5.1.24 for details. The PCD TF does not further constrain this
3440 field.
ORC-25 Order Status Modifier
See HL7 V2.6 Section 4.5.1.25 for details. The PCD TF does not further constrain this
field.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 144 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3465
ORC-2 Placer Order Number (EI) 00216
This field is the placer application's order number.
ORC-12 Ordering Provider (XCN) 00226
This field contains the identity of the person who is responsible for creating the request
3470 (i.e., ordering physician). ORC-12-ordering provider is the same as OBR-16-ordering
provider. If the ordering provider is not present in the ORC, it may be present in the
associated OBR. This is particularly important when results are transmitted in an ORU
message. In this case, the ORC is not required and the identifying filler order number
may be present in the OBR segment.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 145 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3505 Definition: This field contains the identity of the caregiver who initiated the event.
Subfield XCN-1 "ID number" is required for each identifier.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 146 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
B.10.2 Future PRT segment use to support Unique Device Identifiers in the PCD
Profiles
Because of the importance of the recently defined Unique Device Identifier from the US FDA,
which was developed with extensive international consultation and is thus likely to be of
3530 international importance as well, the IHE PCD Technical Committee is preparing to enable the
use of this device identification in addition to the IEEE EUI-64 it has previously prescribed for
device identification. This relies on changes and additions to the PRT segment added in HL7
version 2.8.2.
In future versions of this Technical Framework, the PRT segment will be used to convey device
3535 identification information formerly in the OBX-18 field of the OBX segment, which from V2.7
of HL7 is retained for backward compatibility only. The material discussed under PRT-10 and
PRT-16-20 below covers semantics to support inclusion of the FDA Universal Device Identifier
(UDI). The use of UDI is not yet required in this version of the Technical Framework but are
expected to be required when the requirement is considered timely by the IHE PCD Technical
3540 and Planning Committees. In this revision, this information is informative only and this use of
the PRI segment is not required in order to make a valid message in the current version of this
Technical Framework. Implementers should take note and prepare to support this segment.
Implementers should consider supporting this optional usage as soon as is practicable for them,
to prepare for early testing. For a Device Observation Consumer, it is advisable as a first step to
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 147 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3545 check at a minimum that the PRT segments are accepted without causing unexpected behavior or
error messages even if they are not yet semantically processed.
Definition: This field contains a unique identifier of the specific participation record.
In the case of waypoints tracked for a shipment, it identifies the waypoint.
3555 Condition: The identifier is required for traceability
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 148 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
For the Report Alert Status [PCD-05] transaction this is the unique ID of the
disseminated message and all status updates on the dissemination should use the same ID
value.
PRT-2 Action code (ID) 00816
3560 Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 –
Problem/goal action code HL7 Table 0287 – Problem/goal action code for valid values.
For the Report Alert [PCD-04] transaction the PRT-2 Action code is always AD
indicating Add.
For the Report Alert Status [PCD-05] transaction the PRT-2 Action Code is AD
3565 indicating Add for the first status update and UP indicating Update for all others.
PRT-3 Action Reason (CWE) 02380
Components:<Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate
Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding
System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System
3570 Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier
(ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding
System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding
System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^
<Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^
3575 <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System
OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate
Value Set Version ID (DTM)>
Definition: This field indicates the reason why the person, organization, location, or
device is assuming (or changing) the role (e.g., shift change, new primary nurse, etc.).
3580 For the Report Alert [PCD-04] transaction the PRT-3 Action Reason, Text, is not
populated.
For the Report Alert Status [PCD-05] transaction the PRT-3 Action Reason, Text, is the
Report Dissemination Alert Status [PCD-07] status text value, and the Coding System is
IHE_PCD_ACM.
3585 Alert Communicator (AC) status values correlated from the Report Dissemination Alert
Status [PCD-07] status values to be returned to the Alert Manager (AM) resulting from
Disseminate Alert [PCD-06] from Alert Manager (AM) to Alert Communicator (AC) and
transcribed into PRT-3-2 Text.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 149 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Definition: This field indicates the functional involvement with the activity being
3605 transmitted (e.g., Case Manager, Evaluator, Transcriber, Nurse Care Practitioner,
Midwife, Physician Assistant, etc.). Refer toHL7 Table 917 for valid values.
For the Report Alert [PCD-04] transaction the presence of one or more PRT segments
containing PRT-4 Participation Identifier, Text is RCT (indicating Result Copies To)
indicates Alert Reporter direct indication of additional recipients.
3610 For the Report Alert [PCD-04] transaction the PRT-4 Participation Identifier, Text is RO
(indicating Responsible Observer).
For the Report Alert Status [PCD-05] transaction the PRT-4 Participation Identifier, Text
is RO (indicating Responsible Observer), and Alternative Identifier is AAP for Alert
Acknowledging Provider.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 150 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 151 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 152 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
3680 Subcomponents for Assigning Jurisdiction (CWE): <Identifier (ST)> & <Text (ST)> &
<Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate
Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System
Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original
Text (ST)> & <Second Alternate Identifier (ST)> & <Second Alternate Text
3685 (ST)> & <Name of Second Alternate Coding System (ID)> & <Second Alternate
Coding System Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID
(ST)> & <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)>
& <Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)>
& <Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
3690 OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Assigning Agency or Department (CWE): <Identifier (ST)> & <Text
(ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> &
<Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding
System Version ID (ST)> & <Alternate Coding System Version ID (ST)> &
3695 <Original Text (ST)> & <Second Alternate Identifier (ST)> & <Second
Alternate Text (ST)> & <Name of Second Alternate Coding System (ID)> &
<Second Alternate Coding System Version ID (ST)> & <Coding System OID
(ST)> & <Value Set OID (ST)> & <Value Set Version ID (DTM)> & <Alternate
Coding System OID (ST)> & <Alternate Value Set OID (ST)> & <Alternate
3700 Value Set Version ID (DTM)> & <Second Alternate Coding System OID (ST)> &
<Second Alternate Value Set OID (ST)> & <Second Alternate Value Set
Version ID (DTM)>
Definition: This field contains the identity of the person who is represented in the
participation that is being transmitted.
3705 If this attribute repeats, all instances must represent the same person.
Condition: At least one of the Participation Person, Participation Organization,
Participation Location, or Participation Device fields must be valued.
For the Report Alert [PCD-04] transaction the PRT-5 participation Person is the
identification of an additional recipient of the dissemination of the alert. The PRT-15
3710 Participation Telecommunication Address may also be used if only a PIN/Carrier
destination is known.
For the Report Alert Status [PCD-05] transaction the PRT-5 Participation Person is the
identification of the person that was the participating recipient of the message.
Definition: This field contains a code identifying the provider type for the participating
person. This attribute correlates to the following master file attribute: STF-4 Staff Type.
Coded values from the correlated master file table are used; the user defined master file
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 153 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3730 table is used as the coding system for this attribute. For example, if you are using values
from STF-2 Staff Type, the coding system would be HL70182 which is the table number
for the user defined Staff Type table. This field is included in this segment to support
international requirements. When ROL is used in an encounter message, it is not intended
as a master file update.
3735 Condition: This field may only be valued if PRT-5 Participation Person is valued.
For the Report Alert Status [PCD-05] transaction this field is not populated.
PRT-7 Participation Organization Unit Type (CWE) 02384
Components:<Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate
Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding
3740 System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System
Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier
(ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding
System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding
System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^
3745 <Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^
<Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System
OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate
Value Set Version ID (DTM)>
Definition: This field identifies the environment in which the participant acts in the role
3750 specified in PRT-3 Action Reason. In the case of a person, the environment is not the
specialty for the provider. The specialty information for the provider is defined in the
PRA segment.
This attribute is included in the PRT segment to allow communication of this data when
the participant information may not have been communicated previously in a master file
3755 or to provide better context. Refer to User-defined table 0406 - Organization unit type.
This field is included in this segment to support international requirements, and is not
intended as a master file update.
Condition: This field may only be valued if PRT-5 Participation Person is valued.
For the Report Alert Status [PCD-05] transaction this field is not populated.
3760 PRT-8 Participation Organization (XON) 02385
Components:<Organization Name (ST)> ^ <Organization Name Type Code (CWE)> ^ <WITHDRAWN
Constituent> ^ <Identifier Check Digit (NM)> ^ <Check Digit Scheme (ID)>
^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning
Facility (HD)> ^ <Name Representation Code (ID)> ^ <Organization
3765 Identifier (ST)>
Subcomponents for Organization Name Type Code (CWE): <Identifier (ST)> & <Text (ST)>
& <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate
Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System
Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original
3770 Text (ST)> & <Second Alternate Identifier (ST)> & <Second Alternate Text
(ST)> & <Name of Second Alternate Coding System (ID)> & <Second Alternate
Coding System Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID
(ST)> & <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)>
& <Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)>
3775 & <Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Assigning Authority (HD): <Namespace ID (CWE)> & <Universal ID
(ST)> & <Universal ID Type (ID)>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 154 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
3780 Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
3785 Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
3790 Subcomponents for Assigning Facility (HD): <Namespace ID (CWE)> & <Universal ID (ST)>
& <Universal ID Type (ID)>
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
3795 & <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
3800 <Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 155 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
3835 <Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
3840 <Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Bed (HD): <Namespace ID (CWE)> & <Universal ID (ST)> & <Universal
ID Type (ID)>
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
3845 Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
3850 Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
3855 Subcomponents for Facility (HD): <Namespace ID (CWE)> & <Universal ID (ST)> &
<Universal ID Type (ID)>
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
3860 & <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
3865 <Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Building (HD): <Namespace ID (CWE)> & <Universal ID (ST)> &
<Universal ID Type (ID)>
3870 Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
3875 of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
3880 OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Floor (HD): <Namespace ID (CWE)> & <Universal ID (ST)> & <Universal
ID Type (ID)>
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
3885 & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
3890 <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Comprehensive Location Identifier (EI): <Entity Identifier (ST)> &
3895 <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 156 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Subcomponents for Assigning Authority for Location (HD): <Namespace ID (CWE)> &
<Universal ID (ST)> & <Universal ID Type (ID)>
Subcomponents for Namespace ID (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
3900 & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
3905 <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Definition: This field specifies the physical location (e.g., nurse station, ancillary service
3910 location, clinic, or floor) that is participating. If either PRT-5 Participation Person or
PRT-8 Participation Organization is valued, it reflects the location of the individual or
organization participating as identified in PRT-4 Participation. Otherwise, the location is
directly participating as identified in PRT-4 Participation.
If this attribute repeats, all instances must represent the same organization.
3915 Condition: At least one of the Participation Person, Participation Organization,
Participation Location, or Participation Device fields must be valued.
For the Report Alert Status [PCD-05] transaction this field is optional.
PRT-10 Participation Device (EI) 02348
Components:<Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^
3920 <Universal ID Type (ID)>
Definition: Identifier for the device participating. This may reflect an unstructured or a
structured identifier such as FDA UDI, RFID, IEEE EUI-64 identifiers, or bar codes.
If this attribute repeats, all instances must represent the same device.
Condition: At least one of the Participation Person, Participation Organization,
3925 Participation Location, or Participation Device fields must be valued.
For the Report Alert Status [PCD-05] transaction the Entity Identifier is the PIN/Carrier
or device communication ID and namespace ID is the Alert Communicator (AC) or Alert
Manager (AM) ID.
Future implementation notes: as of HL7 V2.7, identifying devices in the OBX-18 field of
3930 the OBX segment is retained for backward compatibility only. This field will be
represented through the PRT segment. Future versions of the IHE PCD Technical
Framework will require the use of this segment, which will also provide for including the
Unique Device Identification adopted by the U.S. F.D.A. and being considered by
regulatory agencies in other jurisdictions.
3935 If this field contains an FDA UDI, it shall contain the entire Human Readable Form of
the UDI. For example, a GS1-based UDI would be represented as follows:
|(01)00643169001763(17)160712(21)21A11F4855^^2.16.840.1.113883.3.3719^ISO|
A HIBCC-based example would be represented as follows:
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 157 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
|+H123PARTNO1234567890120/$$420020216LOT123456789012345/SXYZ45678901
3940 23 45678/16D20130202C^^2.16.840.1.113883.3.3719^ISO
An ICCBBA-based example would be represented as follows:
|=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032\T\,10000000
00000XYZ123^^2.16.840.1.113883.3.3719^ISO|
Or for ICCBBA for blood bags only an example would be represented as follows:
3945 |=)1TE123456A\T\)RZ12345678^^2.16.840.1.113883.3.3719^ISO|
The identifier root shall be the OID assigned to UDI. For example, for FDA UDIs the
root shall be 2.16.840.1.113883.3.3719, and the extension shall be the Human Readable
Form appropriate for the style of content. When captured as a simple string, the string
shall be the Human Readable Form appropriate for the style of content. The content style
3950 can be determined from the leading characters of the content:
UDIs beginning with:
‘(‘ are in the GS1 Human Readable style;
‘0-9’ are a GS1 DI (containing only the DI value, no PI or GS1 AI);
‘+‘ are in the HIBCC Human Readable style;
3955 ‘=‘ or ‘&’ are in the ICCBBA Human Readable style.
Note: If “&” is used in the UDI while one of the delimiters in MSH.2 includes “&” as
well, it must be properly escaped per Chapter 2.7.
The exchange of UDI sub-elements in PRT-16 through PRT-21 is not required when the
full UDI string is provided in PRT.10. Whether to include some or all these fields as well
3960 when PRT-10 is present with a UDI that the rules are subject to specific implementation
guides that will have to consider the patient safety implications of potentially conflicting
data.
When a UDI is provided and sub-elements are also provided, then for those sub-elements
that are valued, the content must match the content encoded in the UDI if it is encoded
3965 within the UDI.
Caution: The UDI may contain personally identifying information in the form of the
device serial number which may be used to link to other information on a patient.
Standard practice for exchanging potentially identifying content should be exercised
when exchanging UDIs which contain a serial number.
3970 Note: PRT.10 is a repeating field. Additional device identifiers, such as an IEEE EUI-64
may also be contained in this field.
PRT-11 Participation Begin Date/Time (DTM) 02387
Definition: This field contains the date/time when the participation began.
In the case of waypoints, this reflects the time a shipment arrives at the waypoint.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 158 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
3975 For the Report Alert Status [PCD-05] transaction this field contains the time of the
dissemination status or response update.
PRT-12 Participation End Date/Time (DTM) 02388
Definition: This field contains the date/time when the participation ended.
In the case of waypoints, this reflects the time a shipment departs from the waypoint.
3980 For the Report Alert Status [PCD-05] transaction this field is not populated.
PRT-13 Participation Qualitative Duration (CWE) 02389
Components:<Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate
Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding
System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System
3985 Version ID (ST)> ^ <Original Text (ST)> ^ <Second Alternate Identifier
(ST)> ^ <Second Alternate Text (ST)> ^ <Name of Second Alternate Coding
System (ID)> ^ <Second Alternate Coding System Version ID (ST)> ^ <Coding
System OID (ST)> ^ <Value Set OID (ST)> ^ <Value Set Version ID (DTM)> ^
<Alternate Coding System OID (ST)> ^ <Alternate Value Set OID (ST)> ^
3990 <Alternate Value Set Version ID (DTM)> ^ <Second Alternate Coding System
OID (ST)> ^ <Second Alternate Value Set OID (ST)> ^ <Second Alternate
Value Set Version ID (DTM)>
Definition: This field contains the qualitative length of time for participation (e.g., until
the next assessment, four days, until discharge, etc.).
3995 For the Report Alert Status [PCD-05] transaction this field is not populated.
PRT-14 Participation Address (XAD) 02390
Components:<Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State or
Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address
Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code
4000 (CWE)> ^ <Census Tract (CWE)> ^ <Address Representation Code (ID)> ^
<WITHDRAWN Constituent> ^ <Effective Date (DTM)> ^ <Expiration Date (DTM)>
^ <Expiration Reason (CWE)> ^ <Temporary Indicator (ID)> ^ <Bad Address
Indicator (ID)> ^ <Address Usage (ID)> ^ <Addressee (ST)> ^ <Comment (ST)>
^ <Preference Order (NM)> ^ <Protection Code (CWE)> ^ <Address Identifier
4005 (EI)>
Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street
Name (ST)> & <Dwelling Number (ST)>
Subcomponents for County/Parish Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name
of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text
4010 (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID
(ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
4015 <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Census Tract (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
4020 Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
4025 Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 159 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
4030 Subcomponents for Expiration Reason (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
4035 of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
4040 OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Protection Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
4045 <Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
4050 <Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Address Identifier (EI): <Entity Identifier (ST)> & <Namespace ID
(IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>
Definition: This field contains addresses associated with the participation. The address
4055 can repeat to indicate alternate addresses or an alternate expression of the same address.
Condition: The address must be present if the Participation is Performing Organization
Medical Director.
For the Report Alert Status [PCD-05] transaction this field is not populated.
PRT-15 Participation Telecommunication Address (XTN) 02391
4060 Components:<WITHDRAWN Constituent> ^ <Telecommunication Use Code (ID)> ^
<Telecommunication Equipment Type (ID)> ^ <Communication Address (ST)> ^
<Country Code (SNM)> ^ <Area/City Code (SNM)> ^ <Local Number (SNM)> ^
<Extension (SNM)> ^ <Any Text (ST)> ^ <Extension Prefix (ST)> ^ <Speed
Dial Code (ST)> ^ <Unformatted Telephone number (ST)> ^ <Effective Start
4065 Date (DTM)> ^ <Expiration Date (DTM)> ^ <Expiration Reason (CWE)> ^
<Protection Code (CWE)> ^ <Shared Telecommunication Identifier (EI)> ^
<Preference Order (NM)>
Subcomponents for Expiration Reason (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
4070 & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
4075 <Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
Subcomponents for Protection Code (CWE): <Identifier (ST)> & <Text (ST)> & <Name of
4080 Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)>
& <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)>
& <Alternate Coding System Version ID (ST)> & <Original Text (ST)> &
<Second Alternate Identifier (ST)> & <Second Alternate Text (ST)> & <Name
of Second Alternate Coding System (ID)> & <Second Alternate Coding System
4085 Version ID (ST)> & <Coding System OID (ST)> & <Value Set OID (ST)> &
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 160 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<Value Set Version ID (DTM)> & <Alternate Coding System OID (ST)> &
<Alternate Value Set OID (ST)> & <Alternate Value Set Version ID (DTM)> &
<Second Alternate Coding System OID (ST)> & <Second Alternate Value Set
OID (ST)> & <Second Alternate Value Set Version ID (DTM)>
4090 Subcomponents for Shared Telecommunication Identifier (EI): <Entity Identifier (ST)>
& <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 161 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
than waiting to queue up multiple PRT segments into a single [PCD-05] transaction which might
delay providing alert status back to the Alert Reporter.
PRT-2 Action Code (ID) 00816
4165 For the PCD-04 and PCD-05 message this field shall contain the value AD indicating Add.
PRT-3 Action Reason (CWE) 02380
For the PCD-04 message this field is optional.
PRT-4 Participation (CWE) 02381
For [PCD-04] and [PCD-05] this field shall contain AR indicating Alert Recipient. This is an
4170 addition to HL7 v2.8 Table 0912 specifically for the PCD-04 message such that PRT segment
occurrences identifying alert recipients can be unambiguously identified for processing,
independent of unrelated to alert processing PRT segments containing RCT (indicating Result
Copies To).
PRT-5 Participation Person (XCN) 02382
4175 This is the identification of the person that is the recipient of the alert notification. If this field is
populated it shall unambiguously resolve to one person. If this field is populated and PRT-15 is
not populated it presumes the Alert Manager will (in the case of [PCD-04]) or has (in the case of
[PCD-05]) internally resolved the person to one or more of their currently assigned endpoint
communication devices.
4180 PRT-11 Participation Begin Date/Time (DTM) 02387
For the PCD-05 message this field contains the timestamp of the message dissemination status or
operator response.
PRT-15 Participation Telecommunication Address (XTN) 02391
This field optionally contains the telecommunication identification of the alert notification
4185 recipient’s telecommunication device (phone #, carrier and PIN, etc.). If this field is populated it
shall unambiguously resolve to one endpoint communication device. If this field is not populated
then PRT-5 Participation Person shall be populated and it is presumed the Alert Manager will
internally resolve the person to their currently assigned endpoint communication device or
devices.
4190 If the field value represents a telecommunications carrier identification and PIN reference the
carrier identification string goes in the fourth component Communication Address and the PIN
string goes in the seventh component Local Number. If the field value represents a telephony dial
string it can either be split into its XTN data type components or it can be a dial string in the
twelfth component Unformatted Telephone number.
4195 In the case of an outsourced Alert Communicator as a notification service (answering machine
service, help desk, etc.) the telecommunication carrier identification and PIN reference may not
be known by the Alert Manager in which case this field might not be populated.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 163 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4205
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 164 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Note: HL7 Ch. 2A calls for a length limit of 20 on component 1 of CWE, but some codes required in this Technical
Framework are longer, hence this deviation.
4230
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 165 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The constraints above particularly apply to the Patient Identifiers carried in the PID segment.
4235 In the context of this PCD Framework, the Assigning Authority and the Identifier Type Code are
considered to be important components for disambiguating identifiers, so these should be
included whenever they are known.
A common value of the Identifier Type Code for a Patient Identifier assigned by the healthcare
organization (PID-5) is "PI". Other values are defined in Table 0203 of HL7 2.6 section 2.A.14.5
4240 Example: 12345^^^Saint-John Hospital^PI
4255
Definition: The Entity Identifier defines a given entity uniquely within a specified series of
identifiers. A piece of equipment or an information system would be an example of an entity to
be uniquely identified. In addition to the unique identifier in the first component, called
somewhat confusingly by the same name as the data type itself, the Entity Identifier, the EI data
4260 type has 3 additional components that identify the ‘assigning authority’ that assigned the Entity
Identifier. These function quite similarly to the three components of the Hierarchical Designator
data type (see Appendix C.6, HD Data Type).
Identifiers do not serve their purpose if they cannot be used to distinguish unambiguously all of
the entities of a particular kind in the context in which they are applied. The HL7 specification
4265 discusses two kinds of identifiers: local and universal. Local identifiers only need to be unique
within a limited scope agreed to by the sending and receiving systems, say, a particular hospital.
The limitations of such a scheme are obvious: once you try to use such an identifier outside of its
scope, another identifier in the wider scope may conflict with it (if, say, Alice Hospital and Barry
Hospital merge and both have a monitor identified as "Monitor101").
4270 A sort of intermediate but still local kind of identifier supplements the Entity Identifier with a
Namespace ID. So the merged hospital could use a Namespace ID of "AH" for equipment names
created in Alice Hospital and "BH" for ones from Barry Hospital. But as you go to wider scopes,
such as a statewide reporting system, this intermediate system could still result in identifier
clashes.
4275 Universal identifiers avoid this problem by always including a unique identifier for the 'assigning
authority' that created and manages the Entity Identifier. A Universal ID system must have a
foolproof method for unambiguously identifying the 'assigning authority' over a 'universal' scope.
Just allowing every assigning authority to name itself can still lead to name clashes. But there are
a number of well-defined identifier systems that are designed to always yield unique identifiers.
4280 One that is familiar to programmers is the GUID, which gives a long hexadecimal number that
can be generated on any suitably programmed computer with virtual certainty that the same
number will not have been, and will not in the future be, generated by that computer or any other
computer. EUI-64, ISO OIDs and URIs identifiers are other identifier schemes also are created
according to well-defined rules such that each identifier system is intended to avoid applying the
4285 same identifier to the more than one entity no matter how wide the scope of applicability is.
In other contexts in PCD profiles, the ‘assigning authority’, as identified by Namespace ID (EI-
2), Universal ID (EI-3), and Universal ID type (EI-4) is required. Assigning authorities in PCD
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 167 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 168 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Refer to discussion and examples of the use of Entity Identifiers to identify equipment sourcing
medical device data in the description of HL7 field OBX-18 in Appendix B.8.
IHE PCD constrains the length of the first component to 20 characters. National extensions can
4330 extend this length up to a maximum of 199.
The Namespace ID (HD-1) in HL7 in general may be populated with a strictly local identifier,
which only needs to be understood in the same way by the individual sending and receiving
4355 applications. Where it is possible, IHE PCD discourages the use of such local identifiers and
instead encourages the use of "Universal" types of identifier, specified by Universal ID and
Universal ID Type, which carry a semantic context that can be understood widely in a context
not limited to a single institution, with no risk of conflicting duplicate identifiers if the Universal
ID system is used properly. The Universal ID (HD-2) should be a well-formed identifier
4360 according to a generally recognized system of identification such as the IEEE EUI-64 for
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 169 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
hardware or software systems, or an ISO OID. The Universal ID type (HD-3) specifies which
Universal ID system the Universal ID (HD-2) is drawn from.
The PCD TF requires that a field of Data Type HD be populated with:
• Either "Namespace ID" (HD-1) alone, which in this case contains a local identifier of the
4365 assigning entity.
• Or, preferably, with a recognized system of Universal IDs such as an EUI-64 or an ISO
OID as Universal IDs. See the discussion under EI data type, Appendix Section C.5 for
the application of Universal ID systems in IHE PCD profiles (note that the component
names Namespace ID, Universal ID, and Universal ID Type are the same in HD and EI
4370 data types, but since the EI data type has an extra component, Entity Identifier, at the
beginning, the component numbers are not the same between HD and EI).
4375 IHE PCD Definition: This data type is used to specify a patient location within a healthcare
institution, or other setting where healthcare is provided. Which components are valued depends
on the needs of the site. For example, for a patient treated at home, only the person location type
is valued.
Component 1: Point of Care (IS), required but may be empty:
4380 HL7 definition: This component specifies the code for the point where patient care is
administered. It is related to PL.6 Person Location Type (e.g., nursing unit or department
or clinic). After floor, it is the most general patient location designation.
HL7 user-defined table 0302 does not suggest any values. The codification of points of
care will be defined at the site level in acute care settings.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 170 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4410 National extensions of this profile may further constrain on extend this table.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 171 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 172 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
This data type is usually in a repeatable field, to allow a list of names. Examples: Legal name,
display name.
4440 Subfield 1 "Family Name" is required if known to the sender.
Subfield 7 "Name Type Code" is required. The PAM Profile allows these values from HL7 Table
0200 – Name type:
4445 This table may be further defined and restrained in national extensions of this profile.
Subfields 6 (Degree) and 10 (Name Validity Range) are deprecated in HL7 v2.6, therefore not
supported by the PCD profile.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 173 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4450
Subfield 2 "Telecommunication Use Code" is required and is valued as either PRN "Primary
Residence Number" or NET "Network (email) address. See HL7 Table 201.
Subfield 3 "Telecommunication Equipment Type" is required and is valued as PH "Telephone",
Internet "Internet Address: Use Only If Telecommunication Use Code Is NET", or X.400 "X.400
4455 email address: Use Only If Telecommunication Use Code Is NET". See HL7 Table 202.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 174 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Appendix D Reserved
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 175 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4475
4480
4485
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 176 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
MSH|^~\&|PAT_DEVICE_PHILIPS_C|Philips|||20150122182658+0000||ORU^R01^ORU_R01|HP01221826
4490 58686QQ000CND119C0WS61|P|2.6|||AL|NE||8859/1|EN^English^ISO639||IHE_PCD_001^IHE
PCD^1.3.6.1.4.1.19376.1.6.1.1.1^ISO
PID|||HO2009001^^^^MR||Hon^Albert^""^^^^L||19610101|M
PV1||I|HO Surgery^OR^1
OBR|1||201512218265601|69965^MDC_DEV_MON_PHYSIO_MULTI_PARAM_MDS^MDC|||20150122182656
4495 OBX|1|ST|69965^MDC_DEV_MON_PHYSIO_MULTI_PARAM_MDS^MDC|1.0.0.0|||||||X|||||||e86c094f-
f751-4acf-92b2-38f11c1f6f57-Device
OBX|2|ST|70686^MDC_DEV_PRESS_BLD_NONINV_VMD^MDC|1.1.0.0|||||||X|||||||0600dc750001
OBX|3|ST|70675^MDC_DEV_PULS_CHAN^MDC|1.1.1.0|||||||X
OBX|4|NM|150021^MDC_PRESS_BLD_NONINV_SYS^MDC|1.1.1.5|117|266016^MDC_DIM_MMHG^MDC|90-
4500 160||||X|||20150122115000
OBX|5|NM|150022^MDC_PRESS_BLD_NONINV_DIA^MDC|1.1.1.6|82|266016^MDC_DIM_MMHG^MDC|||||X||
|20150122115000
OBX|6|NM|150023^MDC_PRESS_BLD_NONINV_MEAN^MDC|1.1.1.7|90|266016^MDC_DIM_MMHG^MDC|||||X|
||20150122115000
4505 OBX|7|ST|4262^MDC_DEV_ECG_VMD^MDC|1.2.0.0|||||||X|||||||0600dc750001
OBX|8|ST|4263^MDC_DEV_ECG_CHAN^MDC|1.2.1.0|||||||X
OBX|9|NM|147842^MDC_ECG_CARD_BEAT_RATE^MDC|1.2.1.1|80|264864^MDC_DIM_BEAT_PER_MIN^MDC|5
0-120||||X
OBX|10|NM|147232^MDC_ECG_TIME_PD_QT_GL^MDC|1.2.1.14|360|264338^MDC_DIM_MILLI_SEC^MDC|||
4510 ||X
OBX|11|NM|147236^MDC_ECG_TIME_PD_QTc^MDC|1.2.1.15|416|264338^MDC_DIM_MILLI_SEC^MDC|<500
||||X
OBX|12|NM|151562^MDC_RESP_RATE^MDC|1.2.1.19|30|264928^MDC_DIM_RESP_PER_MIN^MDC|8-
45||||X
4515 OBX|13|ST|184327^MDC_ECG_STAT_RHY^MDC|1.2.1.21|MDC_ECG_SINUS_RHY||||||X
OBX|14|ST|69642^MDC_DEV_ANALY_SAT_O2_VMD^MDC|1.3.0.0|||||||X|||||||0600dc750001
OBX|15|ST|70771^MDC_DEV_ANALY_PERF_REL_CHAN^MDC|1.3.1.0|||||||X
OBX|16|NM|150456^MDC_PULS_OXIM_SAT_O2^MDC|1.3.1.1|99|262688^MDC_DIM_PERCENT^MDC|90-
100||||X
4520 OBX|17|NM|150448^MDC_PULS_OXIM_PERF_REL^MDC|1.3.1.3|3.9|262656^MDC_DIM_DIMLESS^MDC|||||
X
4530
4535
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 177 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
MSH|^~\&|ACME_Gateway^080019FFFE3ED02D^EUI-64|ACME
Healthcare|||20110602050000+0000||ORU^R01^ORU_R01|0104ef190d604db188c3|P|2.6|||AL|NE||U
NICODE UTF-8|||PCD_DEC_001^IHE PCD^1.3.6.1.4.1.19376.1.6.1.1.1^ISO
PID|||12345^^^A^MR||BEDS^TEDSONS^^^^^L
4540 PV1||U|COLWELL^^SOLAR
OBR|1|080019FFFE3ED02D20110602045842^ACME_Gateway^080019FFFE3ED02D^EUI-
64|080019FFFE3ED02D20110602045842^ACME_Gateway^080019FFFE3ED02D^EUI-
64|182777000^monitoring of patient^SCT|||20110602045842+0000
OBX|1||69965^MDC_DEV_MON_PHYSIO_MULTI_PARAM_MDS^MDC|1.0.0.0|||||||X
4545 OBX|2||70686^MDC_DEV_PRESS_BLD_NONINV_VMD^MDC|1.16.0.0|||||||X
OBX|3||70687^MDC_DEV_PRESS_BLD_NONINV_CHAN^MDC|1.16.1.0|||||||X|||20110602045842
OBX|4|NM|150021^MDC_PRESS_BLD_NONINV_SYS^MDC|1.16.1.1|111|mm[Hg]^mm[Hg]^UCUM|||||R|||20
110602045842||||080019FFFE3ED02D172.16.172.135^GATEWAY_ACME
OBX|5|NM|150022^MDC_PRESS_BLD_NONINV_DIA^MDC|1.16.1.2|60|mm[Hg]^mm[Hg]^UCUM|||||R|||201
4550 10602045842||||080019FFFE3ED02D172.16.172.135^GATEWAY_ACME
OBX|6|NM|150023^MDC_PRESS_BLD_NONINV_MEAN^MDC|1.16.1.3|80|mm[Hg]^mm[Hg]^UCUM|||||R|||20
110602045842||||080019FFFE3ED02D172.16.172.135^GATEWAY_ACME
OBX|7|NM|149546^MDC_PULS_RATE_NON_INV^MDC|1.16.1.4|63|{beat}/min^{beat}/min^UCUM|||||R|
||20110602045842||||080019FFFE3ED02D172.16.172.135^GATEWAY_ACME
4555
E.2.1 Storyboard
Objects Attributes
Patient Legal Name: John Doe
ID: 98765
Sex: M
Date of birth: January 1, 1966
Weight: 85.0 kg
Nurse Jane Adams
ID: N0001
Medication Example 1 Example 2
ID: 1234 ID: 5678
Name: Dopamine Name: Normal Saline
Volume to be infused: 250 mL Volume to be infused: 500 mL
Concentration: 400 mg / 250 mL Rate: 13.3 mL/hr
Dose: 10 mcg/kg/min
Pump ID: A0001
4560
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 178 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
RGV
IOP Order
IOC
Response/Ack
to Order Pump
4565
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 179 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
RGV
IOP IOC
Application Ack (RRG)
Pump
4570
RGV
IOP Order
IOC
Response/Ack
to Order Pump
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 180 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
E.2.3 Messages
Example 1
Order #12345 for Patient ID 98765 (John Doe), Dopamine, volume to be infused 250 ml at 10
4575 mcg/kg/min, concentration of 400 mg in 250 ml, patient weight 85.0 kg, Pump ID A0001,
administered by nurse N0001.
Communicate Infusion Order
MSH|^~\&|IOPVENDOR^1234560000000001^EUI-
64|IOPVENDOR|IOCVENDOR^6543210000000001^EUI-64|IOCVENDOR|20080101123456-
0600||RGV^O15^RGV_O15|1|P|2.5|||AL|ER||ASCII|EN^English^ISO659||IHE_PCD_PIV_001
PID|||98765^^^IHE^PI||Doe^John^^^^^L||19660101000000-0600|M
ORC|RE|12345|||||||||||||||||N0001
RXG|1|||1234^Dopamine|250||263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM ||||||||10|3
475^ug/kg/min^UCUM^265619^MDC_DIM_MICRO_G_PER_KG_PER_MIN^MDC|400|1746^mg^UCUM
^263890^MDC_DIM_MILLI_G^MDC|||||250|263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM
RXR|IV||IVP
OBX|1||69986^MDC_DEV_PUMP_INFUS_VMD^MDC||||||||X|||||||^^A0001^PUMPVENDOR
OBX|2|NM|68063^MDC_ATTR_PT_WEIGHT^MDC||85.0|kg^kg^UCUM^263875^MDC_DIM_KILO_G^MDC
Accept Acknowledgement
MSH|^~\&|IOCVENDOR^6543210000000001^EUI-64|IOCVENDOR|IOPVENDOR^1234560000000001^EUI-
64|IOPVENDOR|20080101123456-
0600||ACK^O15^ACK|1|P|2.5||||||ASCII|EN^English^ISO659||IHE_PCD_PIV_001
MSA|CA|1
4580
Example 2
Order #12345 for Patient ID 98765 (John Doe), Normal Saline, volume to be infused 500 ml at
rate of 13.3 ml/hr, Pump ID A0001, administered by nurse N0001.
Communicate Infusion Order
MSH|^~\&|IOPVENDOR^1234560000000001^EUI-64|IOPVENDOR|IOCVENDOR^6543210000000001^EUI-
64|IOCVENDOR|20080101123456-
0600||RGV^O15^RGV_O15|2|P|2.5|||AL|ER||ASCII|EN^English^ISO659||IHE_PCD_PIV_001
PID|||98765^^^IHE^PI||Doe^John^^^^^L||19660101000000-0600|M
ORC|RE|12345|||||||||||||||||N0001
RXG|1|||5678^Normal Saline|500||263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM
||||||||13.3|3122^mL/h^UCUM^265266^MDC_DIM_MILLI_L_PER_HR^MDC
RXR|IV||IVP
OBX|1||69986^MDC_DEV_PUMP_INFUS_VMD^MDC||||||||X|||||||^^A0001^PUMPVENDOR
4585
Accept Acknowledgement
MSH|^~\&|IOCVENDOR^6543210000000001^EUI-64|IOCVENDOR|IOPVENDOR^1234560000000001^EUI-
64|IOPVENDOR|20080101123456-
0600||ACK^O15^ACK|102|P|2.5||||||ASCII|EN^English^ISO659||IHE_PCD_PIV_001
MSA|CA|
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 181 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The infusion server cannot find the give code id in the infusion formulary. The infusion server
issues an application acknowledgment reject message to the IOP.
4590
Application Acknowledgment
MSH|^~\&|IOCVENDOR^6543210000000001^EUI-64|IOCVENDOR|IOPVENDOR^1234560000000001^EUI-
64|IOPVENDOR|20080101123456- 0600||
RRG^O16^RRG_O16|102|P|2.5||||||ASCII|EN^English^ISO659||IHE_PCD_PIV_001
MSA|AR|102
ERR|||207^ Application internal error|F|9010^Unable to match medication to drug library
MSH|^~\&|MINDRAY_EGATEWAY^00A037EB2175780F^EUI-
64|MINDRAY|AM_PHILIPS_IEM^00095CFFFE741952^EUI-64|PHILIPS|20120111150457-
0600||ORU^R40^ORU_R40|1|P|2.6|||AL|NE||UNICODE UTF-8|||IHE_PCD_ACM_001^IHE
PCD^1.3.6.1.4.1.19376.1.6.4.4.1^ISO
PID|||HO2009001^^^Hospital^PI||Hon^Albert^^^^^L||18991230|M
PV1||I|HO Surgery^OR^1
OBR|1|1^MINDRAY_EGATEWAY^00A037EB2175780F^EUI64|↵
1^MINDRAY_EGATEWAY^00A037EB2175780F^EUI64|
196616^MDC_EVT_ALARM^MDC|||20120111150457-
0600||||||||||||||||||||||^1&MINDRAY_EGATEWAY&00A037EB2175780F&EUI-64
OBX|1|ST|196670^MDC_EVT_LO^MDC|1.3.1.150456.1|Low
SpO2|||L~PM~SP|||F|||20120111150457-0600||||F1519EFX^SHENZHEN_DEVICE^mindray.com^DNS
OBX|2|NM|150456^MDC_PULS_OXIM_SAT_O2^MDC|1.3.1.150456.2|88|262688^MDC_DI
M_PERCENT^MDC|90-96||||F|||20120111150457-0600
OBX|3|ST|68481^MDC_ATTR_EVENT_PHASE^MDC|1.3.1.150456.3|start||||||F
OBX|4|ST|68482^MDC_ATTR_ALARM_STATE^MDC|1.3.1.150456.4|active||||||F
OBX|5|ST|68483^MDC_ATTR_ALARM_INACTIVATION_STATE|1.3.1.150456.5|enabled|||||F
Note: The use of DNS as the standards base indication for OBX-18 Equipment Instance Identifier is acceptable for
Connectathon use; however, in live deployments it would be expected to be a formally registered value, such as an
EUI-64.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 182 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4620 Infusion Pump, Fluid Line Occlusion, Technical Alarm Indication, End
MSH|^~\&|PAT_DEVICE_BBRAUN^0012211839000001^EUI-
64|BBRAUN|AM_Philips_IEM^00095CFFFE741952^EUI-64|Philips|20120109175426-
0600||ORU^R40^ORU_R40|6346172846620706282|P|2.6|||AL|NE||ASCII|EN^English^ISO639||
IHE_PCD_ACM_001^IHE PCD^1.3.6.1.4.1.19376.1.6.1.4.1^ISO
4625 PID|||HO2009003^^^AA1^PI||Hon^Amy^^^^^L|Coburn^^^^^^L|19610301000000-
0600|F
PV1||I|HO 3 West ICU^10^1
OBR|1|634617284662070628^PAT_DEVICE_BBRAUN^0012211839000001^EUI-
64|P6013_4^PAT_DEVICE_BBRAUN^0012211839000001^EUI-
4630 64|196616^MDC_EVT_ALARM^MDC|||20120109175426-
0600||||||||||||||||||||||^E0001_27&PAT_DEVICE_BBRAUN&0012211839000001&EUI-64
OBX|1|CWE|196616^MDC_EVT_ALARM^MDC|1.0.0.0.1|196940^MDC_EVT_FLUID_LINE_OCCL^MDC^^^^^^O
cclusion|||ST|||F|||||||P6013^^0012210000000000^EUI-64
OBX|2|CWE|68480^MDC_ATTR_ALERT_SOURCE^MDC|1.0.0.0.2|69985^MDC_DEV_PUMP_INFUS_MDS^MDC|||
4635 |||F|||20120109175426-0600
OBX|3|ST|68481^MDC_ATTR_EVENT_PHASE^MDC|1.0.0.0.3|end||||||F
OBX|4|ST|68482^MDC_ATTR_ALARM_STATE^MDC|1.0.0.0.4|inactive||||||F
OBX|5|ST|68483^MDC_ATTR_ALARM_INACTIVATION_STATE|1.0.0.0.5|enabled|||||F
4640
4645
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 183 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 184 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 185 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 186 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 187 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 188 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
DeviceObservationConsumer.wsdl
<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions name="DeviceObservationConsumer"
targetNamespace="urn:ihe:pcd:dec:2010"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
xmlns:tns="urn:ihe:pcd:dec:2010">
<wsdl:types>
<xsd:schema>
<xsd:import namespace="urn:ihe:pcd:dec:2010"
schemaLocation="DeviceObservationConsumer.xsd"/>
</xsd:schema>
</wsdl:types>
<wsdl:message name="CommunicatePCDData_Message">
<wsdl:documentation>Communicate PCD Data</wsdl:documentation>
<wsdl:part name="body" element="tns:CommunicatePCDData"/>
</wsdl:message>
<wsdl:message name="CommunicatePCDDataResponse_Message">
<wsdl:documentation>Communicate PCD Data Response</wsdl:documentation>
<wsdl:part name="body" element="tns:CommunicatePCDDataResponse"/>
</wsdl:message>
<wsdl:portType name="DeviceObservationConsumer_PortType">
<wsdl:operation name="CommunicatePCDData">
<wsdl:input message="tns:CommunicatePCDData_Message"
wsaw:Action="urn:ihe:pcd:2010:CommunicatePCDData"/>
<wsdl:output message="tns:CommunicatePCDDataResponse_Message"
wsaw:Action="urn:ihe:pcd:2010:CommunicatePCDDataResponse"/>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 189 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="DeviceObservationConsumer_Binding_Soap12"
type="tns:DeviceObservationConsumer_PortType">
<soap12:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http"/>
<wsaw:UsingAddressing wsdl:required="true"/>
<wsdl:operation name="CommunicatePCDData">
<soap12:operation soapAction="urn:ihe:pcd:2010:CommunicatePCDData"
soapActionRequired=""/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="DeviceObservationConsumer_Service">
<wsdl:port name="DeviceObservationConsumer_Port_Soap12"
binding="tns:DeviceObservationConsumer_Binding_Soap12">
<soap12:address location="http://www.example.org/"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 190 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 191 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
CommunicatePCDData.xml
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:To soapenv:mustUnderstand="true">
http://localhost:9097/org.openhealthtools.stepstone.backend.gateway/DeviceObservationConsumer_Servi
ce
</wsa:To>
<wsa:From soapenv:mustUnderstand="true">
<wsa:Address>
http://www.w3.org/2005/08/addressing/anonymous
</wsa:Address>
</wsa:From>
<wsa:MessageID soapenv:mustUnderstand="true">
urn:uuid:A52590343911955D1A1251497585530
</wsa:MessageID>
<wsa:Action soapenv:mustUnderstand="true">
urn:ihe:pcd:2010:CommunicatePCDData
</wsa:Action>
</soapenv:Header>
<soapenv:Body>
<CommunicatePCDData xmlns="urn:ihe:pcd:dec:2010">
MSH|^~\&|AcmeInc^ACDE48234567ABCD^EUI-
64||||20090713090030+0500||ORU^R01^ORU_R01|MSGID1234|P|2.6|||NE|AL|||||IHE PCD ORU-R01
2006^HL7^2.16.840.1.113883.9.n.m^HL7
PID|||789567^^^Imaginary Hospital^PI||Doe^John^Joseph^^^^L^A|||M
OBR|1|AB12345^AcmeAHDInc^ACDE48234567ABCD^EUI-64|CD12345^AcmeAHDInc^ACDE48234567ABCD^EUI-
64|528391^MDC_DEV_SPEC_PROFILE_BP^MDC|||20090813095715+0500
OBX|1||528391^MDC_DEV_SPEC_PROFILE_BP^MDC|1|||||||R|||||||0123456789ABCDEF^EUI-64
OBX|2||150020^MDC_PRESS_BLD_NONINV^MDC|1.0.1||||||R|||20090813095715+0500
OBX|3|NM|150021^MDC_PRESS_BLD_NONINV_SYS^MDC|1.0.1.1|120|266016^MDC_DIM_MMHG^MDC||||R
OBX|4|NM|150022^MDC_PRESS_BLD_NONINV_DIA^MDC|1.0.1.2|80|266016^MDC_DIM_MMHG^MDC||||R
OBX|5|NM|150023^MDC_PRESS_BLD_NONINV_MEAN^MDC|1.0.1.3|100|266016^MDC_DIM_MMHG^MDC||||R
</CommunicatePCDData>
</soapenv:Body>
</soapenv:Envelope>
4750
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 192 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
CommunicatePCDDataResponse.xml
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>
urn:ihe:pcd:2010:CommunicatePCDDataResponse
</wsa:Action>
<wsa:RelatesTo>
urn:uuid:F8C3FF2964F94E404E1251145112405
</wsa:RelatesTo>
</soapenv:Header>
<soapenv:Body>
<CommunicatePCDDataResponse xmlns="urn:ihe:pcd:dec:2010">
MSH|^~\&|Stepstone||AcmeInc^ACDE48234567ABCD^EUI64||20090726095731+0500||ACK^A01^ACK|AMSGID1234|
P|2.6|
MSA|AA|MSGID1234|Message Accepted|
</CommunicatePCDDataResponse>
</soapenv:Body>
</soapenv:Envelope>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 193 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 194 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4785 Some WCTP implementations have minimum tolerable poll intervals to reduce overall polling of
the WCTP gateway server, the Alert Communicator (AC).
K.5 Constraints
The use of WCTP for ACM does not require Message Response Redirection.
Sub-second timing is not expected to be needed by ACM use of WCTP.
4790 The WCTP messageID is used to track the status of a message that was sent from the Alert
Manager to the Alert Communicator.
The WCTP notifyWhen element should indicate notifyWhenDelivered (notify upon delivery to
device) and notify upon read receipt.
If WCTP version query is not supported then a request for version query must not be ignored. It
4795 must be responded to with a Not Supported WCTP confirmation response.
K.6 Transactions
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 195 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Please note, XML constant strings are presented in normal text. XML data to be filled in during
implementation is presented in bold red text.
4805 The format of WCTP conformant timestamps (timestamp) is: yyyy-mm-ddThh:mm:ss.ttt
All times are UTC. WCTP does not support the ability to indicate a time zone offset.
Hours (hh) in 24-hour format, and .ttt is the optional number of milliseconds
Example: 2011-01-19T20:33:52
A push response URI is the URI (URL minus the HTTP://) used to identify the HTTP POST
4810 destination for WCTP replies and status updates.
The notification text value is the actual text message to be presented to the wireless device
operator.
The sender ID is the security identification of the IHE ACM to the WCTP receiver.
The security code is essentially the password to go with the security sender ID.
4815 The message ID is the identification of the overall message to the ACM Alert Communicator by
the Alert Manager.
The transaction ID is the lower level transaction identification making up the message.
The recipient PIN is the identification of the destination device as per the ACM Alert
Communicator.
4820 The e-mail address is the optional ACM Alert Manager contact information e-mail address.
The phone number is the optional ACM Alert Manager contact information voice telephony
phone number.
The web site is the optional ACM Alert Manager contact information web site.
The info string is the optional ACM Alert Manager contact information comment.
4825 The priority is any of HIGH, NORMAL, or LOW with a default of NORMAL.
The presentation ID is the optional alphanumeric field for coordinating presentation, behaviors,
sorting, etc. between the ACM Alert Communicator and ACM Alert Manager. The AC and AM
should coordinate expected values.
The sequence number is a sequential value used for tracking polling requests and responses
4830 used during Virtual Pre-Connectathon testing.
The batch size is the numeric maximum count of responses a WCTP client (ACM Alert
Manager) expects from a WCTP poll request to a WCTP server (ACM Alert Communicator). A
common value is 500.
The WCTP version indicates the expected version of WCTP XML message content supported.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 196 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The WCTP DTD identifies the URL of the DTD (Data Type Definition) for the indicated
version of WCTP supported.
4840
The IHEPCD-PCD06-V1R1 value is used to signal the willingness of the Alert Communicator to
the Alert Manager to support communication of waveform evidentiary data and/or waveform
graphical snippets sent from the Alert Manager to the Alert Communicator in the PCD-06
message.
4845 The Next Poll Interval is the number of seconds the ACM Alert Manager (WCTP client) should
wait before again polling the ACM Alert Communicator (WCTP server). The ACM Alert
Communicator (WCTP server) dictates this value to reduce the aggregate polling load on the
WCTP server by all WCTP polling clients. Given that there are typically not many ACM Alert
Manager instances per ACM Alert Communicator instance, this interval can be kept to a small
4850 single digit number of seconds. In typical WCTP wide area communication deployments, there
are often hundreds if not maybe thousands of WCTP clients per WCTP server.
The graphics format and graphical image attachments are IHE PCD domain specific extensions
to WCTP version 1.3 to convey waveform graphical snippets.
The graphics format indicates the format of the graphical image information, and the value can
4855 be any one of SVG, JPEG, PNG, or BMP as agreed between the ACM Alert Manager vendor
and the ACM Alert Communicator vendor.
The graphical image is a base-64 encoded string representing one of the evidentiary data static
graphical images represented by one of the sets of evidentiary data from the ACM PCD-04
message sent from the ACM Alert Reporter to the ACM Alert Manager.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 197 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
4860 The telephony dial string is an encoded telephony dial string, including any required prefixes,
area codes, PBX switch hops, or pauses needed to permit the ACM Alert Communicator
endpoint communication device operator to make a telephone call from that device back to a
patient’s room or to the observation producer/order filler.
The status update is the string indicating the type of status update that the ACM Alert
4865 Communicator is reporting back to the ACM Alert Manager in wctp-Notification. Possible
values are as QUEUED, DELIVERED, or READ. Additionally there are the optional IHE PCD
ACM Profile specific values for IHEPCDCALLBACKSTART and IHEPCDCALLBACKEND
in support of Call Back Number phone dialing by the operator of the ACM Alert Communicator
endpoint communication device and the resulting telephony call start and call end, the status of
4870 which are useful as logged items in alert response analysis.
The Send Choice n is the prompt component of an MCR request. This is the value used by the
ACM Alert Communicator to populate buttons, softkeys, or menu choices on the endpoint
communication device for selection by the device operator. There can be multiple.
The Reply Choice n is the response value component of an MCR request. This value is
4875 correlated with its same ordinal occurrence Send Choice n value.
The response text is the string sent by the endpoint communication device of the ACM Alert
Communicator back to the ACM Alert Manager as the response to a notification message sent
from the ACM Alert Manager to the ACM Alert Communicator. In the case of an MCR response
the text can be predefined. In the case of non-MCR responses the text can be an unexpected
4880 value.
The actionURI is the optional URI value which can be included in paired and unpaired MCR
options. The URI will be opened on the endpoint communication device when the relevant MCR
Option is selected. The AC and AM should coordinate expected values.
The actionURIPurpose is the optional URI description field which provides additional
4885 descriptions of what the actionURI is to be used for. The element is required if an actionURI
element is included. The AC and AM should coordinate expected values.
The participant ID is the unique identifier of a participant in this alert indication as per the Alert
Communicator. The participant name is the name of the participant. The participant classification
is the type of the participant so that the Alert Communicator knows how to process the
4890 participant ID. The available values for classification are DEVICE, PATIENT, or STAFF. There
can be multiple wctp-IHEPCDACMParticipant elements.
The responder ID is the unique identifier of the person who is assigned to respond to this alert as
per the Alert Communicator. It is up to the Alert Communicator whether it chooses to use the
recipient PIN, the responder ID, or a combination of both to route messages.
4895 The location of an alert is defined by one or more location elements. These location elements are
modeled off of the FHIR®10 Location resource. There are attributes for the identifier, description,
type, and physical type. Refer to the FHIR standard for descriptions and available values of these
attributes.
10
FHIR is the registered trademark of Health Level Seven International.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 198 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The alert timestamp is the timestamp for an alert indication according to the Alert Manager. This
4900 corresponds to a value in a Report Alert [PCD-04] transaction, but it is in the format of a WCTP
conformant timestamp (yyyy-mm-ddThh:mm:ss.tt). For more information, see Section B.8.7 in
the IHE PCD TF Volume 2.
The filler order number is the unique identifier for status updates to an alert indication. This
corresponds to a value in a Report Alert [PCD-04] transaction. For more information, see Section
4905 B.7.1 in the IHE PCD TF Volume 2.
The parent filler order number is the unique identifier for the original alert indication. This
corresponds to a value in a Report Alert [PCD-04] transaction. For more information, see Section
B.7.1 in the IHE PCD TF Volume 2.
The value is the numeric result of an alert. This corresponds to an observation in a Report Alert
4910 [PCD-04] transaction. For more information, see Section B.8.5 in the IHE PCD TF Volume 2.
Units is the measurement type of the value of an alert. This corresponds to an observation in a
Report Alert [PCD-04] transaction. For more information, see Section B.8.5 in the IHE PCD TF
Volume 2.
The reference range is the alert range set in the device. This corresponds to a value in a Report
4915 Alert [PCD-04] transaction. For more information, see Section B.8.5 in the IHE PCD TF Volume
2.
The abnormality type indicates the type of abnormality described by this alert. This corresponds
to an observation in a Report Alert [PCD-04] transaction. For more information, see Section
B.8.5 in the IHE PCD TF Volume 2.
4920 The event identification is the MDC event code for the alert. This corresponds to an observation
in a Report Alert [PCD-04] transaction. For more information, see Table B.8.5-1.
The source identification is the physiological measurement or technical source responsible for
the alert. This corresponds to an observation in a Report Alert [PCD-04] transaction. For more
information, see Table B.8.5-1.
4925 The event phase is whether the stimulus for the message is the beginning, end, or some other
state or state transition of the alert. This corresponds to an observation in a Report Alert [PCD-
04] transaction. An Alert Manager can use this field to inform an Alert Communicator that a
PCD-06 message was sent as a result of an escalation or deescalation. For more information, see
Table B.8.5-1.
4930 The alert state is the state of the underlying alert condition at the patient care device. This
corresponds to an observation in a Report Alert [PCD-04] transaction. For more information, see
Table B.8.5-1.
The inactivation state is whether or not visual or aural indications at the patient care device are
inactivated. This corresponds to an observation in a Report Alert [PCD-04] transaction. For more
4935 information, see Table B.8.5-1.
The alarm priority is the priority of an alert. This corresponds to an observation in a Report Alert
[PCD-04] transaction. For more information, see Table B.8.5-1.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 199 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The alert type is the type of alert. This corresponds to an observation in a Report Alert [PCD-04]
transaction. For more information, see Table B.8.5-1.
1. OBR-7
2. OBX-14
Filler order number OBR-3
Parent filler order number OBR-29
Value OBX-5 of OBX segment with Source Identification facet for alerts with a
type of Physiological
Units OBX-6 of OBX segment with Source Identification facet for alerts with a
type of Physiological
Reference range OBX-7 of OBX segment with Source Identification facet for alerts with a
type of Physiological
Abnormality type Either:
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 200 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
The update action is the action that an ACM AC should take for a previous wctp-SubmitRequest
message. It is sent by an ACM Alert Manager to an ACM Alert Communicator. The available
values are CANCEL, ESCALATE, and DEESCALATE.
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
4970 <wctp-Operation wctpVersion=“WCTP version” wctpToken="11AA">
<wctp-Confirmation>
<wctp-Failure errorCode="300" errorText="Operation not supported.">
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 201 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
</wctp-Failure>
</wctp-Confirmation>
4975 </wctp-Operation>
The assumption to this response is that the ACM Alert Manager is to use only WCTP 1.1 XML
messages and not later, e.g., is no support for MCR.
A response dtdName of "wctp-dtd-v1r3" indicates support for ACM Profile conformant WCTP
version 1.3 which indicates support for Multiple Choice Response (MCR) pairs on WCTP
SubmitRequest messages. MCR pairs are used to populate soft keys on wireless device operator
4995 interfaces and so that the reply value can be vendor specific and still be presented in a vendor
agnostic manner. A response of dtdName of "wctp-dtd-v1r2" indicates support for WCTP 1.2
which supports non-paired MCR.
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
5005 <wctp-Operation wctpVersion=“WCTP version”>
<wctp-SubmitRequest>
<wctp-SubmitHeader submitTimestamp="timestamp">
<wctp-Originator senderID="sender ID" securityCode="security code"/>
<wctp-MessageControl messageID="message ID" transactionID="transaction ID"
5010 allowResponse="true" deliveryPriority="priority" notifyWhenDelivered="true"
preformatted="true"/>
<wctp-Recipient recipientID="recipient PIN"/>
</wctp-SubmitHeader>
<wctp-Payload>
5015 <wctp-Alphanumeric>notification text</wctp-Alphanumeric>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 202 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
</wctp-Payload>
</wctp-SubmitRequest>
</wctp-Operation>
<?xml version="1.0"?>
5025 <!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
<wctp-Operation wctpVersion=“WCTP version”>
<wctp-SubmitRequest>
<wctp-SubmitHeader submitTimestamp="timestamp">
<wctp-Originator senderID="sender ID" securityCode="security code"/>
5030 <wctp-MessageControl messageID="message ID" transactionID="transaction ID"
allowResponse="true" deliveryPriority="priority" notifyWhenDelivered="true"
preformatted="true" notifyWhenRead="true"/>
<wctp-Recipient recipientID="recipient PIN"/>
</wctp-SubmitHeader>
5035 <wctp-Payload>
<wctp-MCR>
<wctp-MessageText>notification text</wctp-MessageText>
<wctp-Choice>Accept</wctp-Choice>
<wctp-Choice>Reject</wctp-Choice>
5040 <wctp-Choice actionURI="uriPrefix://action?id=123" actionURIPurpose=”purpose”
>Accept</wctp-Choice>
</wctp-MCR>
</wctp-Payload>
</wctp-SubmitRequest>
5045 </wctp-Operation>
When using unpaired MCR the wctp-Choice value selected by the endpoint device operator is
the response data from the WCTP server (the ACM Alert Communicator) back to the WCTP
client (the ACM Alert Manager).
5050 Selecting the wctp-Choice with the optional actionURI parameter included will indicate this
response back to the AM Actor and open the URI on the device.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 203 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<wctp-SubmitRequest>
5060 <wctp-SubmitHeader submitTimestamp="timestamp">
<wctp-Originator senderID="sender ID" securityCode="security code"/>
<wctp-MessageControl messageID="message ID" transactionID="transaction ID"
allowResponse="true" deliveryPriority="priority" notifyWhenDelivered="true"
preformatted="true" notifyWhenRead="true"/>
5065 <wctp-Recipient recipientID="recipient PIN"/>
</wctp-SubmitHeader>
<wctp-Payload>
<wctp-MCR>
<wctp-MessageText>notification text</wctp-MessageText>
5070 <wctp-ChoicePair>
<wctp-SendChoice>Send Choice 1</wctp-SendChoice>
<wctp-ReplyChoice>Reply Choice 1</wctp-ReplyChoice>
</wctp-ChoicePair>
<wctp-ChoicePair>
5075 <wctp-SendChoice> Send Choice 2</wctp-SendChoice>
<wctp-ReplyChoice Reply Choice 2</wctp-ReplyChoice>
</wctp-ChoicePair>
<wctp-ChoicePair>
<wctp-SendChoice> Send Choice 3</wctp-SendChoice>
5080 <wctp-ReplyChoice> Reply Choice 3</wctp-ReplyChoice>
</wctp-ChoicePair>
<wctp-SendChoice actionURI="uriPrefix://action?id=123"
actionURIPurpose=”purpose” >Send Choice 1</wctp-SendChoice>
</wctp-MCR>
5085 </wctp-Payload>
</wctp-SubmitRequest>
</wctp-Operation>
When using a paired MCR the selectable values presented to the endpoint device operator are in
5090 the wctp-SendChoice elements. Once selected the correlated reply value sent to the WCTP client
(the ACM Alert Manager) is in the wctp-ReplyChoice element.
Selecting the wctp-SendChoice with the optional actionURI parameter included will indicate this
response back to the AM Actor and open the URI on the device.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 204 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
HL7 message received by the ACM Alert Manager from the ACM Alert Reporter for sending to
the ACM Alert Communicator.
5105 In order for the WCTP server (the ACM Alert Communicator) to signal its willingness to receive
and potentially support IHE ACM Profile evidentiary data extensions to WCTP 1.3r1, per the
extensions mechanism defined in Section 3.6 Protocol Version of the WCTP 1.3r1 interface
specification, the DTD response value shall be “wctp-dtd-ihepcd-pcd06-v1r1” to indicate support
for reception of the Call Back Phone Number extension to WCTP 1.3r1. This version shall
5110 presume at a minimum WCTP version 1.3r1 capabilities, with primary emphasis on the ability of
the WCTP server (ACM Alert Communicator) to support paired MCR if sent in a wctp-
SubmitRequest message from the WCTP client (the ACM Alert Manager) to the WCTP server
(the ACM Alert Communicator).
On wctp-SubmitRequest messages the WCTP 1.3r1 interface specification supports a choice of
5115 one of wctp-Alphanumeric (simple text with no MCR), wctp-TransparentData (binary encoded
data), or wctp-MCR (simple text accompanied with either unpaired or paired MCR). Since only
smarter devices, associated with the newest WCTP implementations, are expected to make use of
the additional alert evidentiary information in the PCD-06 transaction and so as to offload simple
non-MCR message WCTP implementations from having to ignore the extensions, the wctp-
5120 MCR element tree has been selected as the extension point for the WCM related additional XML
elements.
In order to pass the Call Back Phone Number used for the ACM nurse call use case for telephony
call back to the patient in the room, or for the ACM laboratory results/observations use case for
telephony call back to the results provider/order filler for any required results/observation read
5125 back, the following additional WCTP XML element is defined specifically to pass the telephony
dial back string from the ACM Alert Manager to the ACM Alert Communicator by means able
to be more deterministically referenced than simply including the string in the message text sent
to the endpoint communication device operator.
Telephony call back functionality can also be implemented via the actionURI element.
5130
<wctp-IHEPCDDialback String=”telephony dial string” />
<?xml version="1.0"?>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 205 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
5150 The following is an indication of the failed attempt to queue a message from the ACM Alert
Manager to the ACM Alert Communicator.
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
5155 <wctp-Operation wctpVersion=“WCTP version” wctpToken="11AA">
<wctp-Confirmation>
<wctp-Failure errorCode="500" errorText="Timeout">comment</wctp-Failure>
</wctp-Confirmation>
</wctp-Operation>
5160
Refer to the WCTP interface specification for all possible values for successCode and
successText as well as errorCode and errorText.
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
5175 <wctp-Operation wctpVersion=“WCTP version”>
<wctp-PollForMessages pollerID="poller ID" securityCode="security code"
maxMessagesInBatch="batch size"/>
</wctp-Operation>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 206 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<?xml version="1.0"?>
5185 <!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
<wctp-Operation wctpVersion="1.0">
<wctp-PollResponse minNextPollInterval=“Next Poll Interval”>
<wctp-NoMessages/>
</wctp-PollResponse>
5190 </wctp-Operation>
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
<wctp-Operation wctpVersion="1.0">
5200 <wctp-PollResponse minNextPollInterval=“Next Poll Interval”>
<wctp-Message sequenceNo="sequence number">
<wctp-StatusInfo>
<wctp-ResponseHeader responseToMessageID="message ID"
responseTimestamp="timestamp">
5205 </wctp-ResponseHeader>
<wctp-Notification type="status update" />
</wctp-StatusInfo>
</wctp-Message>
</wctp-PollResponse>
5210 </wctp-Operation>
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
5220 <wctp-Operation wctpVersion=“WCTP version”>
<wctp-PollForMessages pollerID="poller ID" securityCode="security code"
maxMessagesInBatch="batch size">
<wctp-MessageReceived sequenceNo="sequence number">
<wctp-Success successCode="200" successText="Message accepted">comment</wctp-
5225 Success>
</wctp-MessageReceived>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 207 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
</wctp-PollForMessages>
</wctp-Operation>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 208 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
5270 <wctp-StatusInfo>
<wctp-ResponseHeader responseTimestamp="timestamp" respondingToTimestamp="timestamp"
onBehalfOfRecipientID="recipient PIN">
<wctp-Originator senderID="sender ID" />
<wctp-MessageControl messageID="message ID" transactionID="transaction ID" />
5275 <wctp-Recipient authorizationCode="" />
</wctp-ResponseHeader>
<wctp-Notification type="status update" />
</wctp-StatusInfo>
</wctp-Operation>
5280 K.8.15 IHE PCD-07 asynchronous reply message with MCR and URI response
<?xml version="1.0" encoding="utf-16"?>
<!DOCTYPE wctp-Operation SYSTEM “WCTP DTD”>
<wctp-Operation wctpVersion=“WCTP version”>
<wctp-MessageReply MCRMessageReply="true">
5285 <wctp-ResponseHeader responseToMessageID="message ID" responseTimestamp="timestamp"
respondingToTimestamp="timestamp" onBehalfOfRecipientID="recipient PIN">
<wctp-Originator senderID="sender ID" miscInfo="" />
<wctp-MessageControl messageID="message ID" transactionID="transaction ID" />
<wctp-Recipient recipientID="recipient PIN" />
5290 </wctp-ResponseHeader>
<wctp-Payload>
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 209 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
In order for the WCTP server (the ACM Alert Communicator) to signal its willingness to receive
and potentially support these IHE ACM Profile WCM specific extensions to WCTP 1.3r1, per
5315 the extensions mechanism defined in Section 3.6 Protocol Version of the WCTP 1.3r1 interface
specification, the DTD response value shall be “wctp-dtd-ihepcd-pcd06-v1r1” to indicate support
for reception of either or both of the PCD-04 (HL7 evidentiary data) or a graphical image
representative of the evidentiary data and for removal of the maximum message length
restriction. This version shall presume at a minimum WCTP version 1.3r1 capabilities, with
5320 primary emphasis on the ability of the WCTP server (ACM Alert Communicator) to support
paired MCR if sent in a wctp-SubmitRequest message from the WCTP client (the ACM Alert
Manager) to the WCTP server (the ACM Alert Communicator).
On wctp-SubmitRequest messages the WCTP 1.3r1 interface specification supports a choice of
one of wctp-Alphanumeric (simple text with no MCR), wctp-TransparentData (binary encoded
5325 data), or wctp-MCR (simple text accompanied with either unpaired or paired MCR). Since only
smarter devices, associated with the newest WCTP implementations, are expected to make use of
the additional WCM information in the [PCD-06] transaction and so as to offload simple non-
MCR message WCTP implementations from having to ignore the extensions, the wctp-MCR
element tree has been selected as the extension point for the WCM related additional XML
5330 elements.
<wctp-IHEPCD04 xmlns=”urn:ihe:pcd:acm:2015">
IHE PCD-04 HL7 message
</wctp-IHEPCD04>
5335 <wctp-IHEPCDWCMImages>
<wctp-IHEWCMImage Format=”graphics format” Encoding=”base64”>
graphical image
</wctp-IHEWCMImage>
</wctp-IHEPCDWCMImages >
5340
The IHE PCD-04 HL7 message may or may not contain WCM evidentiary data, but it is
expected to contain ACM alarm indication data.
Since a single PCD-04 WCM extension can result in more than a single graphics image the wctp-
IHEWCMImage can be repeated. Due to endpoint communication device display real estate
5345 limitations the ACM Alert Communicator may not be able to display all of the images presented
to it by the ACM Alert Manager, but shall present the images starting with the first for as many
as the ACM Alert Communicator supports for the given endpoint communication device.
Whether or not the ACM Alert Manager sends the rendered images to the ACM Alert
Communicator is ACM Alert Manager vendor specific.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 210 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
5350 The Format specification is required, indicates the format of the graphical image information,
and the value can be any one of SVG, JPEG, PNG, or BMP as agreed between the ACM Alert
Manager vendor and the ACM Alert Communicator vendor.
If the ACM Alert Communicator does not respond to the wctp-VersionQuery with the WCM
supportive DTD response indicating value then the Alert Manager shall not send these
5355 extensions to the Alert Communicator.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 211 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
<wctp-IHEPCDACMLocations>
<wctp-IHEPCDACMLocation
5390 identifier=“identifier”
description=“description”
type=“type”
physicalType=“physicalType” />
</wctp-IHEPCDACMLocations>
5395 <wctp-IHEPCDACMResponder
responderID=“responderID” />
<wctp-IHEPCDACMObservation
alertTimestamp=“alertTimestamp”
fillerOrderNumber=“fillerOrderNumber”
5400 parentFillerOrderNumber=“parentFillerOrderNumber”
value=“value”
units=“units”
referenceRange=“referenceRange”
abnormalityType=“abnormalityType”
5405 eventIdentification=“eventIdentification”
sourceIdentification=“sourceIdentification”
eventPhase=“eventPhase”
alertState=“alertState”
inactivationState=“inactivationState”
5410 alarmPriority=“alarmPriority”
alertType=“alertType” />
<wctp-IHEPCDACMPresentation presentationID=“presentationID” />
</wctp-IHEPCDACM>
This extension is optional. If it is present, then the ACM AC can use these values to present
5415 additional information to users or categorize PCD-06 messages more effectively.
All of the elements and attributes within this extension are optional. However, the ACM AC can
require elements and attributes in this extension if they are necessary to ensure complete
functionality. If these elements and attributes are not present, then the message will not be
queued.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 212 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
5420 These values are not required to be pulled directly from a PCD-04 message and can instead be
used by an Alert Manager to send additional information to an Alert Communicator.
If there is patient information sent in the PCD-06 message, Alert Managers and Alert
Communicators should take care to secure their communications using existing WCTP
methodologies.
5425 If the ACM AC does not respond to the wctp-VersionQuery with the supportive DTD response
indicating value then the AM shall not send these extensions to the AC.
K.8.18 IHE PCD specific WCTP extensions to PCD-07 transactions for alerts
The following ACM Profile proprietary extensions to wctp-StatusInfo and wctp-MessageReply
are used to convey alert information from the ACM AC to the ACM AM.
5430 The WCTP 1.3r1 interface specification that is the basis for ACM AM – AC communication
does not support the ability to pass alert information in association with a status info response or
message reply. For this reason, the ACM Profile is required to extend the WCTP 1.3r1 interface
specification in a backward transparent manner in order to convey alert information from the
ACM AC to the ACM AM.
5435 In order for the WCTP server (the ACM AC) to signal its willingness to send and potentially
support IHE ACM Profile evidentiary data extensions to WCTP 1.3r1, per the extensions
mechanism defined in Section 3.6 Protocol Version of the WCTP 1.3r1 interface specification,
the DTD response value shall be “wctp-dtd-ihepcd-pcd06-v1r2” to indicate support for sending
the alert information. This version shall presume at a minimum WCTP version 1.3r1 capabilities.
5440 The wctp-StatusInfo and wctp-MessageReply element trees have been selected as the extension
point for additional XML elements.
<wctp-IHEPCDACM>
<wctp-IHEPCDACMResponder
onBehalfOfResponderID=“responderID” />
5445 </wctp-IHEPCDACM>
This extension is optional and can be used to convey additional information from the ACM AC
to the ACM AM that is not in present in WCTP version 1.3r1.
All of the elements and attributes within this extension are optional. However, the ACM AM can
require elements and attributes in this extension if they are necessary to ensure complete
5450 functionality. If these elements and attributes are not present, then the message will not be
queued.
These values are not required to be pulled directly from a PCD-06 message and can instead be
used by an Alert Communicator to send additional information to an Alert Manager.
If the ACM AC does not respond to the wctp-VersionQuery with the supportive DTD response
5455 indicating value then the AC shall not send these extensions to the AM.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 213 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 214 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
5490 <wctp-IHEPCDMessageToUpdate
messageToUpdate=“message ID”/>
<wctp-IHEPCDUpdateAction
action=“update action”/>
<wctp-IHEPCDACMResponder
5495 responderID=“responderID”/>
</wctp-IHEPCDUpdate>
</wctp-Payload>
</wctp-IHEPCDSubmitRequestUpdate>
</wctp-Operation>
5500 This extension is optional and can be used by the AM to send updates about prior PCD-06
SubmitRequest messages to the AC. The elements wctp-IHEPCDMessageToUpdate and wctp-
IHEPCDUpdateAction are required if this message type is used.
Each wctp-IHEPCDSubmitRequestUpdate message contains a unique message ID that is
different from the ID of the message that it intends to update. The previous wctp-SubmitRequest
5505 message is identified by its message ID, located in the wctp-IHEPCDMessageToUpdate element.
Each wctp-IHEPCDSubmitRequestUpdate message updates one previous wctp-SubmitRequest
message.
The kind of action that must be done by the ACM AC is specified by the value in the wctp-
IHEPCDUpdateAction element. It is up to the AC to determine what this action means in the
5510 context of their system.
In response to this message, the ACM AC is expected to send a synchronous PCD-07 response to
convey success or failure of message queueing as described in Section K.8.8. No asynchronous
responses will be sent because of this message.
If the ACM AC does not respond to the wctp-VersionQuery with the supportive DTD response
5515 indicating value then the AM shall not send this message type to the AC.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 215 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 216 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
becomes aware of them. As alert dissemination destinations (clinicians) move out of and into
range of known wireless communication attenuation zones the AM could automatically adjust
5560 alert dissemination destinations. Through the above deployment efforts, alert (alarm) audio and
its associated fatigue can be significantly mitigated without new communication protocols or
profiles.
These are the key points.
1. The Alert Source always controls its own local alarm audio state, pause, end or extension
5565 of a pause.
2. The Alert Source and the Alert Reporter (AR) can use the available context and received
triggers to make decisions regarding the audio state.
3. In this scenario a local alarm is not cleared by a remote actor.
4. Only local resolution of the alerting condition can locally clear the alert.
5570 5. This scenario does not comment regarding the state of other cues (visual, haptic).
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 217 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 218 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 219 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Communication Status
MDC_EVT_COMM_STATUS_CHANGE No
Change
Patient Parameter
MDC_EVT_PATIENT_PARAMETER_CHANGE No
Change
Pump Volume Counters
MDC_EVT_PUMP_VOL_COUNTERS_CLEARED No
Cleared
5645
For IPEC delivery events, the DOR should send all parameters that are known for the infusion.
The following table outlines the parameters that are typically sent with each Delivery Start, Stop,
and Complete event, with additional constraints as noted. Refer to the Infusion Pump Model and
Infusion Pump Terms documents for the other parameters that may be reported with each event.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 221 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
PARAMETER NOTES
Active Source Parameters:
Current Delivery
Required for Delivery Start, Stop, and Complete.
Status
Program Delivery
Required for Delivery Start, Stop, and Complete.
Mode
Pump Not Required for Delivery Stop and Delivery Complete if Current Delivery Status =
Delivering Reason pump-delivery-status-not-delivering; not applicable for Delivery Start.
Source Channel
Required for Delivery Start, Stop, and Complete.
Label
Current Segment
For Delivery Stop and Delivery Complete, either this parameter or Cumulative
Volume Delivered
Note 1 Volume Delivered is required; optional for Delivery Start.
Cumulative Volume For Delivery Stop and Delivery Complete, either this parameter or Current
Delivered Note 1 Segment Volume Delivered is required; optional for Delivery Start.
Note 1: When Pump Active Sources is primary or secondary, this parameter is reported under the corresponding containment
group. When Pump Active Sources is PCA, loading, clinician, or intermittent, this parameter is reported under the
containment group for the fluid source (primary or secondary).
5655 The following table outlines the parameters that are sent with the Communication Status Change
event.
Table M.1.2.1-4: Clinical Scenarios describes the mapping of clinical scenarios to pump events.
5660 Notes:
• The term “delivery segment” refers to the period between a
MDC_EVT_PUMP_DELIV_START event and the next
MDC_EVT_PUMP_DELIV_STOP or MDC_EVT_PUMP_DELIV_COMP event
• Although the Pump Active Sources parameters can identify multiple sources, there is
5665 only one active source at a given time in each of the scenarios in the table
• For Pump Active Sources, the value “pump-source-info-*” indicates that either pump-
source-info-primary or pump-source-info-secondary is a valid value for the event
• When Pump Active Sources is one of the following:
o pump-source-info-pca
5670 o pump-source-info-loading
o pump-source-info-clinician
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 222 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
o pump-source-info-intermittent
parameter values specific to that dose are reported within a corresponding containment
group (reflected in the scenarios as “Active Source Parameters (pump-source-info-...)".
5675 Parameters that apply to the overall delivery for the active fluid source (such as
Cumulative Volume Delivered) are reported within a separate containment group for that
source (reflected in the scenarios as “Source Parameters (primary or secondary)”).
• Source Channel Label is assigned a vendor-specific value (e.g., “primary” or
“secondary”, ‘A’ or ‘B’, etc.). This is especially useful when Pump Active Sources is not
5680 pump-source-info-primary or pump-source-info-secondary (e.g., during a bolus). In that
case, the source for the bolus can be identified via Source Channel Label.
• The value of pump-delivery-status-transitioning for Current Delivery Status is applicable
to transitional stop and complete events in cases where the medication or fluid associated
with the source will continue to be delivered after the transition (e.g., to/from bolus, to
5685 KVO, titration, etc.). It should not be used for transitions from piggyback to primary.
• For events where Current Delivery Status = pump-delivery-status-transitioning, the
values for Infusing Status and Current Pump Fluid Flow must be consistent; i.e., either:
o Infusing Status = pump-status-infusing and Current Pump Fluid Flow > 0, or
o Infusing Status = pump-status-not-infusing and Current Pump Fluid Flow = 0
5690 In the scenarios, the terms “pump reported status” and “pump reported rate” are used in
place of actual values to indicate that it is vendor-specific as to which of these two
combinations of values will be reported.
• Additional clinical scenarios will be added to this table as they are identified.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 223 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 224 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=KVO rate
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 225 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Start/restart an MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
infusion, _ START Infusing Status=pump-status-infusing
followed by Current Pump Fluid Flow=programmed
pausing the rate
running
infusion Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 226 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump-status-not-infusing
Current Pump Fluid Flow=0
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 227 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Rate Change MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
(e.g., titration) _ STOP Infusing Status=pump reported status
while running Current Pump Fluid Flow=pump reported
(NOTE: rate
events
associated Pump Active Sources=pump-source-info-*
with the start
of the infusion Active Source Parameters:
at original rate Current Delivery Status=pump-delivery-
and pausing or status-transitioning
completion at Program Delivery Mode=pump-program-
the new rate delivery-mode-*
are not
Source Channel Label=vendor-specific
shown)
Rate=old programmed rate
Dose Rate=old programmed dose rate
Volume Programmed=volume
programmed
Current Segment Volume
Delivered=volume delivered since last
DELIV_START
Cumulative Volume Delivered=sum of
“Current Segment Volume Delivered”
values across all segments for the delivery,
including the one just completed
Volume Remaining=volume remaining
Time Remaining=based upon Volume
Remaining and Rate
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=new
programmed rate
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 228 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Piggyback MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
start, followed _ STOP Infusing Status=pump-status-not-infusing The first
by piggyback Current Pump Fluid Flow=0 DELIV_STOP
end, followed represents the stop of
by resumption Pump Active Sources=pump-source-info-
primary the primary infusion
of the primary that was running.
infusion (this
assumes the Active Source Parameters:
pump will If the pump supports
Current Delivery Status=pump-delivery- automatic transition
revert to the status-not-delivering
primary rate from primary to
Pump Not Delivering Reason=either pump- secondary (i.e.,
once stopped-by-clinician, pump-stopped-not-
piggyback without a manual
specified, or pump-stopped-switching- pause by the
VTBI is source
achieved) clinician), then the
Program Delivery Mode=pump-program- appropriate value for
delivery-mode-* Pump Not Delivering
(Note: events Source Channel Label=vendor-specific Reason on the first
associated DELIV_STOP event
Rate=primary rate
with the start in this scenario is
of the primary Dose Rate=primary dose rate
pump-stopped-
infusion prior Volume Programmed=primary volume switching-source. If
to the programmed not, then its value
piggyback and Current Segment Volume should be either
completion of Delivered=volume delivered since last pump-stopped-by-
the primary DELIV_START clinician or pump-
infusion after Cumulative Volume Delivered=sum of stopped-not-
the piggyback “Current Segment Volume Delivered” specified.
are not values across all segments for the primary
shown) delivery, including the one just completed
Volume Remaining=primary volume
remaining
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 229 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=piggyback
programmed rate
Pump Active Sources=pump-source-info-
secondary
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 230 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ COMP Infusing Status=pump-status-not-infusing
Current Pump Fluid Flow=0
Pump Active Sources=pump-source-info-
secondary
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 231 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=primary rate
Pump Active Sources=pump-source-info-
primary
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 232 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Bolus start, MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters: DELIV_STOP –
followed by _ STOP Infusing Status=pump reported status Used if the pump is
bolus end, Current Pump Fluid Flow=pump reported switching from
followed by rate continuous to bolus.
resumption of Not needed if starting
continuous Pump Active Sources=pump-source-info-* bolus from a pause or
rate after the stop.
bolus (this Active Source Parameters (primary or
assumes the secondary):
pump will Current Delivery Status=pump-delivery-
revert to the status-transitioning
continuous Program Delivery Mode=pump-program-
rate once the delivery-mode-continuous
bolus VTBI is
Source Channel Label=vendor-specific
achieved)
Rate=continuous rate
Dose Rate=continuous dose rate
(NOTE:
events Volume Programmed=continuous volume
associated programmed
with the start Current Segment Volume
of the Delivered=continuous volume delivered
continuous since last DELIV_START
infusion prior Cumulative Volume Delivered=sum of
to the bolus “Current Segment Volume Delivered”
and values across all segments for the
completion of continuous delivery, including the one just
the continuous completed, and any previously completed
infusion after boluses
the bolus Volume Remaining=continuous volume
completes are remaining
not shown)
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 233 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=bolus
programmed rate
Pump Active Sources=pump-source-info-
clinician
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 234 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump reported status
Current Pump Fluid Flow=pump reported
rate
Pump Active Sources=pump-source-info-
clinician
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 235 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=continuous rate
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 236 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump reported status
Current Pump Fluid Flow=pump reported
rate for step 1
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 237 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=programmed
rate for step 2
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 238 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump-status-not-infusing
Current Pump Fluid Flow=0
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 239 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Intermittent MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
step start, _ START Infusing Status=pump-status-infusing
followed by Current Pump Fluid Flow=programmed
intermittent rate for step n
step stop
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 240 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump-status-not-infusing
Current Pump Fluid Flow=0
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 241 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Loading dose MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
start, followed _ START Infusing Status=pump-status-infusing
by loading Current Pump Fluid Flow=loading dose
dose end, programmed rate
followed by
start of Pump Active Sources=pump-source-info-
continuous loading
(this assumes
the pump will Source Parameters (primary or secondary):
start at the Cumulative Volume Delivered=0
continuous
rate once the
Active Source Parameters (Loading Dose):
loading dose
VTBI is Current Delivery Status=pump-delivery-
achieved) status-delivering
(NOTE: the Program Delivery Mode=pump-program-
event delivery-mode-continuous
associated Source Channel Label=vendor-specific
with the Rate= loading dose programmed rate
completion of Dose Rate= loading dose rate
the continuous
Volume Programmed= loading dose
infusion after
volume programmed
the bolus
completes is Current Segment Volume Delivered=0
not shown) Cumulative Volume Delivered=0
Volume Remaining= loading dose volume
programmed
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 242 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump reported status
Current Pump Fluid Flow=pump reported
rate
Pump Active Sources=pump-source-info-
loading
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 243 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=continuous rate
Pump Active Sources=pump-source-info-*
Same as “Pause a
running infusion”
case followed by
“Start/restart an
infusion” case
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 244 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Ramp/taper MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
start, followed _ START Infusing Status=pump-status-infusing
by ramp/taper Current Pump Fluid Flow=programmed
rate change, rate for step 1
followed by
ramp/taper Pump Active Sources=pump-source-info-*
stop
Active Source Parameters:
Current Delivery Status=pump-delivery-
status-delivering
Program Delivery Mode=pump-program-
delivery-mode-ramp-taper
Source Channel Label=vendor-specific
Rate=programmed rate for step 1
Dose Rate=programmed dose rate for step
1
Volume Programmed=volume
programmed for entire ramp/taper delivery
Current Segment Volume Delivered=0
Cumulative Volume Delivered=0
Volume Remaining=volume programmed
for entire ramp/taper delivery
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 245 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump reported status
Current Pump Fluid Flow=pump reported
rate for step 1
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 246 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV based uponPump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=programmed
rate for step 2
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 247 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ STOP Infusing Status=pump-status-not-infusing
Current Pump Fluid Flow=0
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 248 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Switch to MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters: The library-based
library-based _ STOP Infusing Status=pump-status-not-infusing infusion is considered
infusion Current Pump Fluid Flow=0 a new delivery
(NOTE: Pump Active Sources=pump-source-info-*
events
associated
with the start Active Source Parameters:
of the non- Current Delivery Status=pump-delivery-
library status-not-delivering
infusion and Pump Not Delivering Reason=either pump-
the stopped-by-clinician or pump-stopped-not-
completion of specified
the library- Program Delivery Mode=pump-program-
based delivery-mode-*
infusion are
Source Channel Label=vendor-specific
not shown)
Rate=rate of non-library infusion
Dose Rate= dose rate of non-library
infusion
Volume Programmed=volume
programmed for non-library infusion
Current Segment Volume
Delivered=volume delivered since last
DELIV_START
Cumulative Volume Delivered=sum of
“Current Segment Volume Delivered”
values across all segments for the non-
library delivery, including the one just
completed
Volume Remaining=volume remaining of
non-library infusion
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 249 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=programmed
rate of library-based infusion
Pump Active Sources=pump-source-info-*
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 250 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
Switch from MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
library-based _ STOP Infusing Status=pump-status-not-infusing
infusion Current Pump Fluid Flow=0
(NOTE: Pump Active Sources=pump-source-info-*
events
associated
with the start Active Source Parameters:
of the library- Current Delivery Status=pump-delivery-
based infusion status-not-delivering
and the Pump Not Delivering Reason=either pump-
completion of stopped-by-clinician or pump-stopped-not-
the non- specified
library-based Program Delivery Mode=pump-program-
infusion are delivery-mode-*
not shown)
Source Channel Label=vendor-specific
Rate=rate of library infusion
Dose Rate= dose rate of library infusion
Volume Programmed=volume
programmed for library infusion
Current Segment Volume
Delivered=volume delivered since last
DELIV_START
Cumulative Volume Delivered=sum of
“Current Segment Volume Delivered”
values across all segments for the library
delivery, including the one just completed
Volume Remaining=volume remaining of
library infusion
Time Remaining=based upon Volume
Remaining and Rate
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 251 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Clinical
PCD-10 Event Parameters Discussion
Scenario
MDC_EVT_PUMP_DELIV Pump Delivery Info Parameters:
_ START Infusing Status=pump-status-infusing
Current Pump Fluid Flow=programmed
rate of non-library-based infusion
Pump Active Sources=pump-source-info-*
5700
5705
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 252 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
MSH|^~\&|PAT_DEVICE_PUMPVENDOR^9999990000000000^EUI-
64|PUMPVENDOR|DOC_VENDOR|DOC_VENDOR|20151015132107-
5715 0500||ORU^R42^ORU_R01|6358051206735492253|P|2.6|||AL|NE||ASCII|en^English^ISO
639||IHE_PCD_010^IHE PCD^ 1.3.6.1.4.1.19376.1.6.4.10^ISO
PID|||HO2009002^^^IHE^PI||Hon^Charles^^^^^L|Brooks^^^^^^L|19610201000000-
0600|M|||||||||||||||||||||||N
PV1||I|3 West ICU^3002^1
5720 OBR|1|AB12345^PCD-03|CD12345^HL7^ACDE48234567ABCD^EUI-
64|2222^Dopamine|||20151015132106-0500
OBX|1||70049^MDC_DEV_PUMP_INFUS_LVP_MDS^MDC|1.0.0.0|||||||X|||||N0002||E0002^
^0012210000000000^EUI-64
OBX|2|ST|184517^MDC_PUMP_DRUG_LIBRARY_VERSION^MDC|1.0.0.1|DL1||||||R
5725 OBX|3|CWE|68487^MDC_ATTR_EVT_COND^MDC|1.0.0.2|197288^MDC_EVT_PUMP_DELIV_START
^MDC||||||R
OBX|4|ST|68488^MDC_ATTR_EVT_SOURCE^MDC|1.0.0.3|1.1.2.0||||||R
OBX|5||70050^MDC_DEV_PUMP_INFUS_LVP_VMD^MDC|1.1.0.0|||||||X
OBX|6||70067^MDC_DEV_PUMP_DELIVERY_INFO^MDC|1.1.1.0|||||||X
5730 OBX|7|CWE|184519^MDC_PUMP_INFUSING_STATUS^MDC|1.1.1.1|^pump-status-
infusing||||||R
OBX|8|NM|158014^MDC_FLOW_FLUID_PUMP_CURRENT^MDC|1.1.1.2|15.4|265266^MDC_DIM_M
ILLI_L_PER_HR^MDC^mL/h^mL/h^UCUM|||||R
OBX|9|CWE|158016^MDC_DEV_PUMP_ACTIVE_SOURCES^MDC|1.1.1.3|^pump-source-info-
5735 primary||||||R
OBX|10||70071^MDC_DEV_PUMP_INFUSATE_SOURCE_PRIMARY^MDC|1.1.2.0|||||||X
OBX|11|CWE|158005^MDC_DEV_PUMP_CURRENT_DELIVERY_STATUS^MDC|1.1.2.1|^pump-
delivery-status-delivering||||||R
OBX|12|CWE|158008^MDC_DEV_PUMP_PROGRAM_DELIVERY_MODE^MDC|1.1.2.2|^pump-
5740 program-delivery-mode-continuous||||||R
OBX|13|ST|158012^MDC_DEV_PUMP_SOURCE_CHANNEL_LABEL^MDC|1.1.2.3|Primary||||||R
OBX|14|NM|157784^MDC_FLOW_FLUID_PUMP^MDC|1.1.2.4|15.4|265266^MDC_DIM_MILLI_L_
PER_HR^MDC^mL/h^mL/h^UCUM|||||R
OBX|15|NM|157924^MDC_RATE_DOSE^MDC|1.1.2.5|5.00|265619^MDC_DIM_MICRO_G_PER_KG
5745 _PER_MIN^MDC^ug/kg/min^ug/kg/min^UCUM|||||R
OBX|16|NM|157884^MDC_VOL_FLUID_TBI^MDC|1.1.2.6|250.0|263762^MDC_DIM_MILLI_L^M
DC^mL^mL^UCUM|||||R
OBX|17|NM|157993^MDC_VOL_FLUID_DELIV_TOTAL^MDC|1.1.2.7|0.0|263762^MDC_DIM_MIL
LI_L^MDC^mL^mL^UCUM|||||R
5750 OBX|18|NM|157872^MDC_VOL_FLUID_TBI_REMAIN^MDC|1.1.2.8|250.0|263762^MDC_DIM_MI
LLI_L^MDC^mL^mL^UCUM|||||R
OBX|19|NM|157916^MDC_TIME_PD_REMAIN^MDC|1.1.2.9|974|264352^MDC_DIM_MIN^MDC^mi
n^min^UCUM|||||R
OBX|20|ST|184514^MDC_DRUG_NAME_LABEL^MDC|1.1.2.10|Dopamine||||||R
5755 OBX|21|NM|157760^MDC_CONC_DRUG^MDC|1.1.2.11|1.6|264306^MDC_DIM_MILLI_G_PER_ML
^MDC^mg/mL^mg/mL^UCUM|||||R
OBX|22|ST|184516^MDC_PUMP_DRUG_LIBRARY_CARE_AREA^MDC|1.1.2.12|Crit
Care||||||R
OBX|23|NM|68063^MDC_ATTR_PT_WEIGHT^MDC|1.1.2.13|82.0|263875^MDC_DIM_KILO_G^MD
5760 C^kg^kg^UCUM|||||R
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 253 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01
IHE Patient Care Device Technical Framework, Vol. 2 (PCD TF-2): Transactions
______________________________________________________________________________
Glossary
The IHE Glossary, an appendix to the IHE Technical Frameworks General Introduction, can be
5765 found here.
______________________________________________________________________________
Rev. 9.0 – Final Text 2019-12-12 254 Copyright © 2019: IHE International, Inc.
Template Rev. 1.0 – 2014-07-01