CC5725-1 Link+ Agilia HL7 Interface Handbook Eng
CC5725-1 Link+ Agilia HL7 Interface Handbook Eng
CC5725-1 Link+ Agilia HL7 Interface Handbook Eng
2 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
Table of contents
1. INTRODUCTION .................................................................................................................................................. 5
2. DEFINITIONS AND ABBREVIATIONS ............................................................................................................... 6
3. REFERENCE DOCUMENTS ............................................................................................................................... 7
4. LINK+ HL7 INTERFACE ...................................................................................................................................... 8
4.1 INTRODUCTION ............................................................................................................................................. 8
4.2 SUPPORTED STANDARDS .............................................................................................................................. 8
4.3 LOWER LAYER PROTOCOL: MLLP ................................................................................................................ 8
4.4 HL7 MESSAGES ACKNOWLEDGEMENT .......................................................................................................... 9
4.4.1 HL7 MESSAGES ACKNOWLEDGEMENT BEHAVIOR ....................................................................................................... 9
4.4.2 HL7 ACKNOWLEDGEMENT MESSAGE CONTENT .......................................................................................................... 9
4.5 HL7 MESSAGES COMMON DESCRIPTION ....................................................................................................... 10
4.5.1 UNSOLICITED OBSERVATION REPORT (ORU) MESSAGE CONTENT .............................................................................. 10
4.5.2 MESSAGE HEADER (MSH) SEGMENT CONTENT ......................................................................................................... 11
4.5.3 PATIENT GROUP (PID AND PV1) SEGMENTS CONTENT ............................................................................................... 12
4.6 INFUSION DATA REPORT HL7 INTERFACE DETAILS ........................................................................................ 13
4.6.1 DEVICE OBSERVATION REPORTER (DOR) ................................................................................................................ 13
4.6.2 OBSERVATION REQUEST (OBR) SEGMENT CONTENT.................................................................................................. 13
4.6.3 OBSERVATION RESULT (OBX) SEGMENT CONTENT .................................................................................................... 14
4.6.4 LIST OF THE INFUSION DATA REPORTED BY THE LINK+ INFUSION DATA REPORT HL7 INTERFACE ................................... 14
4.7 ALARM REPORT HL7 INTERFACE DETAILS .................................................................................................... 17
4.7.1 ALARM REPORTER (AR) .......................................................................................................................................... 17
4.7.2 OBSERVATION REQUEST (OBR) SEGMENT CONTENT.................................................................................................. 18
4.7.3 OBSERVATION RESULT (OBX) SEGMENT CONTENT .................................................................................................... 19
4.7.4 LIST OF THE ALARMS REPORTED BY THE LINK+ ALARM REPORT HL7 INTERFACE.......................................................... 20
5. APPENDIX A: SUPPORTED UNITS ................................................................................................................... 22
6. APPENDIX B: MESSAGES SAMPLES............................................................................................................... 26
6.1 INFUSION DATA REPORT HL7 INTERFACE MESSAGES SAMPLES ...................................................................... 26
6.2 ALARM REPORT HL7 INTERFACE MESSAGES SAMPLES .................................................................................. 27
7. LOCAL CONTACTS FOR SERVICING ............................................................................................................... 28
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 3
List of tables
4 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
1. INTRODUCTION
This Link+ HL7 Interface handbook is intended for technical staff of third party providers (eg: PDMS or HIS companies)
and customer representatives (IT department, Biomedical department, Purchasing department…). It provides technical
information needed to:
understand the HL7 interface implemented by the Link+,
The Link+ is able to send the features and alarms of all the infusions running on the plugged Agilia infusion devices to a
third party system.
This sending is implemented as a HL7 messages exchange protocol which is based on the IHE specifications of the
“Patient Care Device” technical framework. These messages are built according to the syntax of the HL7 standard and
the data embedded into them are encoded according to the ISO/IEEE 11073 standard nomenclature.
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 5
2. DEFINITIONS AND ABBREVIATIONS
6 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
3. REFERENCE DOCUMENTS
Reference Title
R1 IHE_PCD_TF_Vol1_2012-08-16 IHE Patient Care Device Technical Framework
Volume 1 (PCD TF-1) Integration Profiles [Revision 2.0 – Final Text August 16, 2012]
see: www.ihe.net
R9 HL7_ImplementationGuide_V2.3 HL7_ImplementationGuide_V2.3
see: www.hl7.org
R11 Link+ Technical Manual Ask your local Fresenius Kabi representative
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 7
4. LINK+ HL7 INTERFACE
4.1 Introduction
The Link+ HL7 interface contains the two following parts:
“Infusion data report” HL7 interface: the Link+ periodically sends the infusion status of each plugged Agilia
infusion device to the peer HL7 application,
“Alarm report” HL7 interface: when an alarm occurs on one of the plugged Agilia infusion devices, the Link+
sends a HL7 alarm message to the peer HL7 application.
8 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
4.4 HL7 Messages Acknowledgement
Where cardinality is [min..max] ; example : [1..1] means only one segment of this type.
The Message Header (MSH) segment content is provided into the following table with the required fields only.
Table 2: MSH Segment required fields into the ACK Message
Field Designation Content (in ER7 format)
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 9
The Message Acknowledgement (MSA) segment content is provided into the following table with the required fields only.
Table 3: MSA Segment required fields into the ACK Message
Field Designation Content
MSA-1 Acknowledgment Code The code depends on the peer HL7 application behavior regarding the message being acknowledged:
« AA » if the peer HL7 application has accepted the message,
« AR » if the peer HL7 application has rejected the message,
« AE » if the peer HL7 application has encountered an error with the message.
MSA-2 Message Control ID Message unique identifier must be the same as the one of the Link+ HL7 message that is being acknowledged (and the same as
the MSH-10 field).
Where cardinality is [min..max] ; example : [1..1] means only one segment of this type.
Since a Link+ can be linked to only one patient at a time, there is only one Patient Result group (set of segments following
the MSH one) into one Link+ ORU Message.
Each ORU message contains one OBR segment and a set of related OBX segments depending on the interface: see the
details of each interface into the corresponding paragraph below (paragraphs 4.6 and 4.7).
10 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
4.5.2 Message Header (MSH) segment content
The MSH segment mainly contains the Link+ HL7 application and peer HL7 application identifiers, the message
timestamp, the message type and the character set used into the message.
The Message Header (MSH) segment content is detailed into the following table with the fields’ values provided by the
Link+.
Table 5: MSH Segment fields into the Link+ ORU Message
Field Designation Content (in ER7 format)
MSH-4 Sending Facility Link+ HL7 application facility identifier composed of:
facility name,
optionally the facility unique identifier.
This field can be configured on the Link+ (see [R11]).
MSH-7 Date/Time of message Message timestamp formatted according to: YYYYMMDDhhmmss.mil+/-ZZZZ where:
YYYY is the year; MM is the month in the year (01 to 12); DD is the day in the month (01 to 31);
hh is the hour in the day (00 to 23); mm is the minute in the hour (00 to 59); ss is the second in the minute (00 to 59);
.mil is the millisecond in the second (.000 to .999);
+/-ZZZZ is the time zone represented as +/-HHMM offset from Coordinated Universal Time (UTC), where +0000 or -
0000 both represent UTC (without offset).
MSH-10 Message control ID Message unique identifier. This field contains a string that identifies uniquely the current message instance.
The peer HL7 application shall echo this ID back to the Link+ HL7 application in the acknowledgement message.
The way the Link+ builds it is provided below for information only:
« FMD » followed by a sequence number between 0 and 99 (loop back to 0 after 99),
« - » separator followed by the message timestamp formatted according to: YYYYMMDDhhmmss.
MSH-11 Processing ID « P » for Production, « D » for Debugging. This field can be configured on the Link+ (see [R11]).
MSH-18 Character Set Two character sets are supported: « ASCII » when no specific characters are required and « UNICODE UTF-8 » otherwise.
The Link+ chooses the right character set according to the configuration of the Agilia infusion device from which the data are
extracted to build the HL7 message. When these data contain only ASCII characters, the ASCII character set is chosen, when they
contain extended characters, the UTF-8 character set is chosen.
MSH-21 Message Profile Identifier IHE Patient Care Device (PCD) message profile identifier [R2- Appendix 1155 B Common Segment Descriptions and R4- 3.Z
Common Message Segments]:
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 11
4.5.3 Patient group (PID and PV1) segments content
The PID segment mainly contains the patient code, first name and last name, date of birth and sex. These patient
demographics can be configured on the Link+ (see [R11]).
When these patient demographics are not configured on the Link+ (the patient is “unknown” by the Link+), the Link+
provides a PID segment with specific values that allow the peer HL7 application to recognise an “unknown” patient (these
“unknown” patient demographics values are specified into the following table).
Table 6: PID Segment fields into the Link+ ORU Message
Field Designation Content (in ER7 format) “Unknown” patient content (in ER7 format)
PID-3 Patient Identifier List Only one Patient Identifier can be configured on the Link+ and only the <ID The <ID Number> component of the Patient
Number> component of this Patient Identifier can be configured on the Link+. Identifier is set to « PID_UNKNOWN »
The <Assigning authority> and <Identifier Type Code> components of this « PID_UNKNOWN^^^Fresenius^PI^ »
Patient Identifier are left empty.
PID-5 Patient Name Patient last name (family name) and first name (given name). All components of the Patient Name are left
empty except the <Name Type Code> which is
Only the <Family Name> and <Given Name> components of this Patient Name set to « U » (Unspecified) :
field can be configured on the Link+.
« ^^^^^^U »
The <Name Type Code> component is set to « L ».
PID-7 Date/Time of Birth Patient date of birth formatted according to: YYYYMMDD where: The date of birth is left empty.
YYYY is the year; MM is the month in the year (01 to 12); DD is the day in the
month (01 to 31)
PID-8 Administrative Sex Patient Sex. It can be configured on the Link+ with the following values: The Administrative Sex is left empty.
« M » for male,
« F » for Female,
« U » for Unknown.
The PV1 segment mainly contains the patient location identifier (care facility, ward, room, bed). This patient location can
be configured on the Link+ (see [R11]).
Table 7: PV1 Segment fields into the Link+ ORU Message
Field Designation Content (in ER7 format)
PV1-2 Patient Class The Patient Class is fixed to « U » for Unknown and cannot be configured on the Link+
PV1-3 Assigned Location The Assigned Location is defined by the following three components: <Point of Care>, <Room> and <Bed>.
12 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
4.6 Infusion Data Report HL7 Interface Details
The Infusion data report HL7 interface implements the Device Observation Reporter (DOR) actor role of the Device
Enterprise Communication (DEC) integration profile of the IHE Patient Care Device (PCD) Technical Framework [R1, R2,
R3].
OBR-1 Set ID-OBR OBR segment rank into the message (starting from 1)
OBR-2 Placer Order Number The Placer Order Number is composed of:
an order identifier which can be configured on the Link+ (see [R11]).
the Universal identifier of the Link+ HL7 application (same EUI-64 identifier as in the MSH-3 field).
OBR-3 Filler Order Number The Filler Order Number is composed of:
an order identifier which can be configured on the Link+ (see [R11]).
the Universal identifier of the Link+ application (same EUI-64 identifier as in the MSH-3 field).
OBR-4 Universal Service ID The “service” identified by this field is the name of the substance to be administered:
when the Link+ knows the drug name, the value is: « DrugName^DrugName »
when the Link+ does not know the drug name, the value is: « 999999^Medication Unknown »
The drug name must be configured on the Agilia infusion device for the Link+ to be able to report it into this field.
OBR-7 Observation Date/Time The observation timestamp formatted according to: YYYYMMDDhhmmss.mil+/-ZZZZ where:
YYYY is the year; MM is the month in the year (01 to 12); DD is the day in the month (01 to 31);
hh is the hour in the day (00 to 23); mm is the minute in the hour (00 to 59); ss is the second in the minute (00 to 59);
.mil is the millisecond in the second (.000 to .999);
+/-ZZZZ is the time zone represented as +/-HHMM offset from Coordinated Universal Time (UTC), where +0000 or -0000 both represent
UTC (without offset).
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 13
4.6.3 Observation result (OBX) segment content
The Link+ ORU message contains one OBR segment followed by a set of related OBX segments that provide the status
of the corresponding Agilia infusion device. Each OBX segment embeds one observation which can be an infusion
parameter or a device parameter.
These parameters are identified according to the Rosetta Terminology Mapping (RTM) [R1 - 2.2.4 Rosetta Terminology
Mapping] which establishes a nomenclature that maps the proprietary semantics communicated by medical devices today
to a standard representation using ISO/IEEE 11073 semantics [R5, R6] and UCUM units of measurement [R10].
The OBX segment contains mainly the observation sequence number, observation identifier and sub-identifier,
observation type, value and units, observation timestamp, and equipment instance identifier.
Table 9: OBX Segment Fields into the Link+ ORU Message (Infusion data report HL7 interface)
Field Designation Content (in ER7 format)
OBX-1 Set ID-OBX This field contains the sequence number of the OBX in this ORU message: 1st OBX Set ID = 1, 2nd OBX set_ID = 2, etc...
OBX-2 Value Type This field contains the type of the observation value stored into the OBX-5 field.
It is valued if the value of the OBX-11 field is not « X ». This value type can be:
« NM » for numerical observation,
« ST » for characters string observation,
« CWE » for coded observation (enumeration).
OBX-3 Observation This observation identifier is encoded according to the ISO/IEEE 11073 nomenclature [R6]. For example, the Agilia infusion device flow rate
Identifier is identified by « 157784^MDC_FLOW_FLUID_PUMP^MDC ».
The complete list of observations reported by the Link+ on the Infusion Data Report HL7 interface is provided into the next paragraph 4.6.4.
OBX-4 Observation Sub-ID This field is used to distinguish between multiple OBX segments by providing an unambiguous mapping from the IEEE 11073 containment
tree [R5], in order to bind a parameter to the right device.
OBX-5 Observation Value This field is the actual value of the observation, formatted according to the HL7 type specified into the field OBX-2
OBX-6 Units This field contains the units of the OBX-5 observation value, encoded according to 11073-10101 [R6], and UCUM [R10].
For example the milliliter per hour units of a flow rate is : « 265266^MDC_DIM_MILLI_L_PER_HR^MDC^mL/h^mL/h^UCUM »
See the list of units supported by the Link+ into the paragraph 5.
OBX-11 Observation Result This field reflects the current completion status of the results for the observation. Possible values are:
Status « X » for an OBX segment with no observation value,
« R » for an OBX segment with an observation value.
OBX-18 Equipment This field contains the Agilia infusion device identifier which is built from the serial number of the device followed by the EUI-64 identifier of
Instance Identifier the Fresenius company. Example : « 018210/98898989X^^0013380000000000^EUI-64 »
This field is set only for the first OBX segment of the message.
4.6.4 List of the infusion data reported by the Link+ Infusion Data Report HL7 interface
Each infusion data is reported into one OBX segment of the ordered set of OBX segments related to one OBR segment.
Table 10: Infusion data specifying the IEEE 11073 containment tree
OBX-2 OBX-3 Observation Identifier (in ER7 format) OBX-4 Comment
Value Observation
Type Sub-ID (*)
This OBX segment contains the serial number of the corresponding Agilia
infusion device into the OBX-18 field.
14 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
Table 11: Infusion data related to the delivery channel
OBX-2 OBX-3 Observation Identifier (in ER7 format) OBX-4 Comment
Value Observation
Type Sub-ID (*)
CWE 184508^MDC_PUMP_STAT^MDC R.1.1.N The pump state is stored into the OBX-5 Observation Value field.
See the list of pump states supported by the Link+ in the Table 13
CWE 184504^MDC_PUMP_MODE^MDC R.1.1.N The pump mode is stored into the OBX-5 Observation Value field.
See the list of pump modes supported by the Link+ in the Table 14
NM 157888^MDC_VOL_FLUID_DELIV_TOTAL_SET^MDC R.1.1.N Total infused volume in milliliters since the last switch off / switch on of the
Agilia infusion device.
NM 157864^MDC_VOL_FLUID_DELIV^MDC R.1.1.N Infused volume in milliliters. This volume is displayed on the Agilia infusion
device screen (or can be accessed through the Agilia infusion device menu). It
can be reset to zero manually by the user through the Agilia infusion device
menu, and automatically when the device is switched off / switched on.
(*) OBX-4 legend: R is the slot rank on the Link+; N is the <Metric> rank into the <Channel>
NM 157760^MDC_CONC_DRUG^MDC R.1.2.N Drug concentration (see the supported concentration units in the Appendix A
Table 20)
NM 157872^MDC_VOL_FLUID_TBI_REMAIN^MDC R.1.2.N For a syringe pump, volume remaining into the syringe.
For a volumetric pump, primary volume remaining.
The volume is expressed in milliliters.
NM 157916^MDC_TIME_PD_REMAIN^MDC R.1.2.N For a syringe pump, time remaining before the end of the syringe;
For a volumetric pump, time remaining before the end of the primary volume.
The remaining time is expressed in minutes.
NM 157924^MDC_RATE_DOSE^MDC R.1.2.N Dose rate when defined (see the supported dose rate units in the Appendix A
Table 21, Table 22, Table 23). If it is normalized by the patient weight or body
surface area, the corresponding patient information is specified into the
message.
NM 157820^MDC_MASS_DRUG_DELIV^MDC R.1.2.N Dose of drug infused (see the supported dose units in the Appendix A Table
20). This dose is displayed on the Agilia infusion device screen (or can be
accessed through the Agilia infusion device menu). It can be reset to zero
manually by the user through the Agilia infusion device menu, and
automatically when the device is switched off / switched on.
(*) OBX-4 legend: R is the slot rank on the Link+; N is the <Metric> rank into the <Channel>
Table 13: Pump states supported by the Link+ (from the Rosetta Terminology [R1])
Pump state Agilia device running mode reference
pump-status-priming Priming
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 15
Table 14: Pump modes supported by the Link+ (from the Rosetta Terminology [R1])
Pump mode Agilia device infusion mode reference
pump-mode-continuous Volume / Time; Volume / Flow; Time / Flow; Volume / Time / Flow; Flow only; Drop per minute.
16 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
4.7 Alarm Report HL7 Interface Details
The Alarm report HL7 interface implements the Alarm Reporter (AR) actor role of the Alarm Communication
Management (ACM) integration profile of the IHE Patient Care Device (PCD) Technical Framework [R4].
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 17
4.7.2 Observation request (OBR) segment content
The OBR segment mainly contains the segment rank, placer order number and filler order number, requested observation
identifier and the observation timestamp.
Table 15: OBR Segment Fields into the Link+ ORU Message (Alarm report HL7 interface)
Field Designation Content (in ER7 format)
OBR-1 Set ID-OBR OBR segment rank into the message (starting from 1)
OBR-3 Filler Order Number The Filler Order Number serves as the unique identifier for status updates to an alarm indication identified in OBR-29 Parent. This value
is assigned by the Link+ and is used by system actors to associate updates to a particular alarm identified in OBR-29 Parent. This field is
composed of:
an order identifier which is built by the Link+ according to the format SN-R_A_O_P-S below,
the Universal identifier of the Link+ application (same EUI-64 identifier as in the MSH-3 field).
OBR-4 Universal Service The “service” identified by this field is the ALARM service. The value is « ALARM^ALARM »
ID
OBR-7 Observation The observation timestamp formatted according to: YYYYMMDDhhmmss.mil+/-ZZZZ where:
Date/Time YYYY is the year; MM is the month in the year (01 to 12); DD is the day in the month (01 to 31);
hh is the hour in the day (00 to 23); mm is the minute in the hour (00 to 59); ss is the second in the minute (00 to 59);
.mil is the millisecond in the second (.000 to .999);
+/-ZZZZ is the time zone represented as +/-HHMM offset from Coordinated Universal Time (UTC), where +0000 or -0000 both represent
UTC (without offset).
OBR-29 Parent This field identifies the alarm which current status is identified by the OBR-3 field. The <Placer Assigned Identifier> component is left
empty. The <Filler Assigned Identifier> component is composed of:
an order identifier which is built by the Link+ according to the format SN-R_A_O below,
the Universal identifier of the Link+ application (same EUI-64 identifier as in the MSH-3 field).
Start 0
Continue 1
End 2
Active 0
Inactive 1
18 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
4.7.3 Observation result (OBX) segment content
The Link+ ORU message contains one OBR segment followed by 4 related OBX segments that provide the attributes of
the alarm that occurred on the corresponding Agilia infusion device. These 4 alarm attributes (called facets in the ACM
profile specification [R4]) are the following:
facet 1: alarm identifier, type and priority,
facet 2: alarm source,
facet 3: alarm phase,
facet 4: alarm state.
This representation relies on ISO/IEEE 11073 nomenclature and concepts for alarms [R5, R6].
The fields of the OBX segment (mainly the observation sequence number, observation identifier and sub-identifier,
observation type, value, observation timestamp, and equipment instance identifier) are used specifically according to the
facet number. See the following table.
Table 18: OBX Segment Fields into the Link+ ORU Message (Alarm report HL7 interface)
Field Designation Content (in ER7 format)
OBX-1 Set ID-OBX This field contains the sequence number of the OBX in this ORU message: 1st OBX Set ID = 1, 2nd OBX set_ID = 2, etc..
OBX-2 Value Type This field contains the type of the value stored into the OBX-5 field. It depends on the alarm facet:
facet 1 (alarm identifier) and facet 2 (alarm source): « CWE »,
facet 3 (alarm phase) and facet 4 (alarm state): « ST ».
OBX-4 Observation Sub- This field is used to distinguish between multiple OBX segments by providing an unambiguous mapping from the IEEE 11073 containment
ID tree [R5], in order to bind the alarm to the right device.
For example for the facet 1 of an alarm that occurred on the Agilia device plugged on the 3rd rack channel: « 3.0.0.0.1 »
OBX-8 Abnormal Flags This field contains the 3 following features of the alarm:
Abnormality: normal « N » or abnormal « A »,
Priority: medium priority « PM » or high priority « PH »,
Type: always technical alert « ST ».
For the Agilia infusion device pre-alarms and indications, the field contains « N~PM~ST »
For the Agilia infusion device alarms, the field is « A~PH~ST »
OBX-18 Equipment This field contains the Agilia infusion device identifier which is built from the serial number of the device followed by the EUI-64 identifier of
Instance Identifier the Fresenius company. Example : « 018210/98898989X^^0013380000000000^EUI-64 »
This field is set only for the facet 1 (alarm identifier) OBX segment.
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 19
4.7.4 List of the alarms reported by the Link+ Alarm Report HL7 interface
The following table gives the identifiers of the alarms (from ISO/IEEE 11073 nomenclature) that the Link+ is able to send
on the Alarm Report HL7 interface. The meaning of each alarm can vary according to the Agilia device type (Injectomat
syringe pump, or Volumat volumetric pump).
These alarm identifiers are reported into the OBX-5 field (observation value) of the facet 1 OBX segment (alarm identifier)
related to the OBR segment (see Table 18).
Table 19: Alarms reported by the Link+ Alarm Report HL7 interface
OBX-5 Observation Value (in ER7 format) Agilia device alarm reference
facet 1 (alarm identifier)
Enumeration Agilia device type Comment
number (*) (Injectomat or Volumat)
15 Volumat Door
11 Injectomat Rotation
12 Injectomat Displacement
30 Volumat Rotation
(*) Enumeration number: this number is stored into the OBR-3 and OBR-29 fields.
20 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 21
5. APPENDIX A: SUPPORTED UNITS
The following tables give the units, from the Rosetta Terminology [R1], that are supported by the Infusion Data Report
HL7 interface of the Link+.
The units are formatted the same way as into the OBX-6 field of the HL7 ORU message, in ER7 format.
Table 20: Units supported by the Link+ (weight, area, duration, volume, dose, concentration)
Unit category OBX-6 Unit (in ER7 format)
263616^MDC_DIM_SQ_M^MDC^m2^m2^UCUM
263890^MDC_DIM_MILLI_G^MDC^mg^mg^UCUM
263891^MDC_DIM_MICRO_G^MDC^ug^ug^UCUM
263892^MDC_DIM_NANO_G^MDC^ng^ng^UCUM
266688^MDC_DIM_MOLE^MDC^mol^mol^UCUM
266706^MDC_DIM_MILLI_MOLE^MDC^mmol^mmol^UCUM
266720^MDC_DIM_EQUIV^MDC^eq^eq^UCUM
266738^MDC_DIM_MILLI_EQUIV^MDC^meq^meq^UCUM
267616^MDC_DIM_INTL_UNIT^MDC^[iU]^[iU]^UCUM
267634^MDC_DIM_MILLI_INTL_UNIT^MDC^m[iU]^m[iU]^UCUM
267619^MDC_DIM_KILO_INTL_UNIT^MDC^k[iU]^k[iU]^UCUM
267620^MDC_DIM_MEGA_INTL_UNIT^MDC^M[iU]^M[iU]^UCUM
264306^MDC_DIM_MILLI_G_PER_ML^MDC^mg/mL^mg/mL^UCUM
264307^MDC_DIM_MICRO_G_PER_ML^MDC^ug/mL^ug/mL^UCUM
264308^MDC_DIM_NANO_G_PER_ML^MDC^ng/mL^ng/mL^UCUM
267748^MDC_DIM_MEGA_INTL_UNIT_PER_ML^MDC^M[iU]/mL^M[iU]/mL^UCUM
267747^MDC_DIM_KILO_INTL_UNIT_PER_ML^MDC^k[iU]/mL^k[iU]/mL^UCUM
267744^MDC_DIM_INTL_UNIT_PER_ML^MDC^[iU]/mL^[iU]/mL^UCUM
267762^MDC_DIM_MILLI_INTL_UNIT_PER_ML^MDC^m[iU]/mL^m[iU]/mL^UCUM
267008^MDC_DIM_EQUIV_PER_ML^MDC^eq/mL^eq/mL^UCUM
267026^MDC_DIM_MILLI_EQUIV_PER_ML^MDC^meq/mL^meq/mL^UCUM
266880^MDC_DIM_MOLE_PER_ML^MDC^mol/mL^mol/mL^UCUM
266898^MDC_DIM_MILLI_MOLE_PER_ML^MDC^mmol/mL^mmol/mL^UCUM
22 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
Table 21: Units supported by the Link+ (flow rate)
Unit category OBX-6 Unit (in ER7 format)
265235^MDC_DIM_MICRO_L_PER_MIN^MDC^uL/min^uL/min^UCUM
265248^MDC_DIM_L_PER_HR^MDC^L/h^L/h^UCUM
265266^MDC_DIM_MILLI_L_PER_HR^MDC^mL/h^mL/h^UCUM
265490^MDC_DIM_MILLI_G_PER_MIN^MDC^mg/min^mg/min^UCUM
265491^MDC_DIM_MICRO_G_PER_MIN^MDC^ug/min^ug/min^UCUM
265492^MDC_DIM_NANO_G_PER_MIN^MDC^ng/min^ng/min^UCUM
265504^MDC_DIM_G_PER_HR^MDC^g/h^g/h^UCUM
265522^MDC_DIM_MILLI_G_PER_HR^MDC^mg/h^mg/h^UCUM
265523^MDC_DIM_MICRO_G_PER_HR^MDC^ug/h^ug/h^UCUM
265524^MDC_DIM_NANO_G_PER_HR^MDC^ng/h^ng/h^UCUM
265536^MDC_DIM_G_PER_DAY^MDC^g/d^g/d^UCUM
265554^MDC_DIM_MILLI_G_PER_DAY^MDC^mg/d^mg/d^UCUM
265555^MDC_DIM_MICRO_G_PER_DAY^MDC^ug/d^ug/d^UCUM
265556^MDC_DIM_NANO_G_PER_DAY^MDC^ng/d^ng/d^UCUM
267154^MDC_DIM_MILLI_MOLE_PER_MIN^MDC^mmol/min^mmol/min^UCUM
267268^MDC_DIM_MOLE_PER_HR^MDC^mol/h^mol/h^UCUM
267186^MDC_DIM_MILLI_MOLE_PER_HR^MDC^mmol/h^mmol/h^UCUM
267200^MDC_DIM_MOLE_PER_DAY^MDC^mol/d^mol/d^UCUM
267218^MDC_DIM_MILLI_MOLE_PER_DAY^MDC^mmol/d^mmol/d^UCUM
267682^MDC_DIM_MILLI_EQUIV_PER_MIN^MDC^meq/min^meq/min^UCUM
267296^MDC_DIM_EQUIV_PER_HR^MDC^eq/h^eq/h^UCUM
267314^MDC_DIM_MILLI_EQUIV_PER_HR^MDC^meq/h^meq/h^UCUM
267328^MDC_DIM_EQUIV_PER_DAY^MDC^eq/d^eq/d^UCUM
267346^MDC_DIM_MILLI_EQUIV_PER_DAY^MDC^meq/d^meq/d^UCUM
267826^MDC_DIM_MILLI_INTL_UNIT_PER_MIN^MDC^m[iU]/min^m[iU]/min^UCUM
267811^MDC_DIM_KILO_INTL_UNIT_PER_MIN^MDC^k[iU]/min^k[iU]/min^UCUM
267812^MDC_DIM_MEGA_INTL_UNIT_PER_MIN^MDC^M[iU]/min^M[iU]/min^UCUM
267840^MDC_DIM_INTL_UNIT_PER_HR^MDC^[iU]/h^[iU]/h^UCUM
267858^MDC_DIM_MILLI_INTL_UNIT_PER_HR^MDC^m[iU]/h^m[iU]/h^UCUM
267843^MDC_DIM_KILO_INTL_UNIT_PER_HR^MDC^k[iU]/h^k[iU]/h^UCUM
267844^MDC_DIM_MEGA_INTL_UNIT_PER_HR^MDC^M[iU]/h^M[iU]/h^UCUM
267872^MDC_DIM_INTL_UNIT_PER_DAY^MDC^[iU]/d^[iU]/d^UCUM
267890^MDC_DIM_MILLI_INTL_UNIT_PER_DAY^MDC^m[iU]/d^m[iU]/d^UCUM
267875^MDC_DIM_KILO_INTL_UNIT_PER_DAY^MDC^k[iU]/d^k[iU]/d^UCUM
267876^MDC_DIM_MEGA_INTL_UNIT_PER_DAY^MDC^M[iU]/d^M[iU]/d^UCUM
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 23
Table 22: Units supported by the Link+ (flow rate normalized by the patient weight)
Unit category OBX-6 Unit (in ER7 format)
265618^MDC_DIM_MILLI_G_PER_KG_PER_MIN^MDC^mg/kg/min^mg/kg/min^UCUM
265619^MDC_DIM_MICRO_G_PER_KG_PER_MIN^MDC^ug/kg/min^ug/kg/min^UCUM
265620^MDC_DIM_NANO_G_PER_KG_PER_MIN^MDC^ng/kg/min^ng/kg/min^UCUM
265632^MDC_DIM_G_PER_KG_PER_HR^MDC^g/kg/h^g/kg/h^UCUM
265650^MDC_DIM_MILLI_G_PER_KG_PER_HR^MDC^mg/kg/h^mg/kg/h^UCUM
265651^MDC_DIM_MICRO_G_PER_KG_PER_HR^MDC^ug/kg/h^ug/kg/h^UCUM
265652^MDC_DIM_NANO_G_PER_KG_PER_HR^MDC^ng/kg/h^ng/kg/h^UCUM
265664^MDC_DIM_G_PER_KG_PER_DAY^MDC^g/kg/d^g/kg/d^UCUM
265682^MDC_DIM_MILLI_G_PER_KG_PER_DAY^MDC^mg/kg/d^mg/kg/d^UCUM
265683^MDC_DIM_MICRO_G_PER_KG_PER_DAY^MDC^ug/kg/d^ug/kg/d^UCUM
265684^MDC_DIM_NANO_G_PER_KG_PER_DAY^MDC^ng/kg/d^ng/kg/d^UCUM
267410^MDC_DIM_MILLI_MOLE_PER_KG_PER_MIN^MDC^mmol/kg/min^mmol/kg/min^UCUM
267424^MDC_DIM_MOLE_PER_KG_PER_HR^MDC^mol/kg/h^mol/kg/h^UCUM
267442^MDC_DIM_MILLI_MOLE_PER_KG_PER_HR^MDC^mmol/kg/h^mmol/kg/h^UCUM
267456^MDC_DIM_MOLE_PER_KG_PER_DAY^MDC^mol/kg/d^mol/kg/d^UCUM
267474^MDC_DIM_MILLI_MOLE_PER_KG_PER_DAY^MDC^mmol/kg/d^mmol/kg/d^UCUM
267538^MDC_DIM_MILLI_EQUIV_PER_KG_PER_MIN^MDC^meq/kg/min^meq/kg/min^UCUM
267552^MDC_DIM_EQUIV_PER_KG_PER_HR^MDC^eq/kg/h^eq/kg/h^UCUM
267570^MDC_DIM_MILLI_EQUIV_PER_KG_PER_HR^MDC^meq/kg/h^meq/kg/h^UCUM
267584^MDC_DIM_EQUIV_PER_KG_PER_DAY^MDC^eq/kg/d^eq/kg/d^UCUM
267602^MDC_DIM_MILLI_EQUIV_PER_KG_PER_DAY^MDC^meq/kg/d^meq/kg/d^UCUM
267639^MDC_DIM_KILO_INTL_UNIT_PER_KG_PER_MIN^MDC^k[iU]/kg/min^k[iU]/kg/min^UCUM
267968^MDC_DIM_INTL_UNIT_PER_KG_PER_HR^MDC^[iU]/kg/h^[iU]/kg/h^UCUM
267986^MDC_DIM_MILLI_INTL_UNIT_PER_KG_PER_HR^MDC^m[iU]/kg/h^m[iU]/kg/h^UCUM
267971^MDC_DIM_KILO_INTL_UNIT_PER_KG_PER_HR^MDC^k[iU]/kg/h^k[iU]/kg/h^UCUM
268000^MDC_DIM_INTL_UNIT_PER_KG_PER_DAY^MDC^[iU]/kg/d^[iU]/kg/d^UCUM
268018^MDC_DIM_MILLI_INTL_UNIT_PER_KG_PER_DAY^MDC^m[iU]/kg/d^m[iU]/kg/d^UCUM
268003^MDC_DIM_KILO_INTL_UNIT_PER_KG_PER_DAY^MDC^k[iU]/kg/d^k[iU]/kg/d^UCUM
24 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
Table 23: Units supported by the Link+ (flow rate normalized by the patient body surface area)
Unit category OBX-6 Unit (in ER7 format)
269011^MDC_DIM_MICRO_G_PER_M_SQ_PER_MIN^MDC^ug/m2/min^ug/m2/min^UCUM
269012^MDC_DIM_NANO_G_PER_M_SQ_PER_MIN^MDC^ng/m2/min^ng/m2/min^UCUM
268960^MDC_DIM_G_PER_M_SQ_PER_HR^MDC^g/m2/h^g/m2/h^UCUM
268978^MDC_DIM_MILLI_G_PER_M_SQ_PER_HR^MDC^mg/m2/h^mg/m2/h^UCUM
268979^MDC_DIM_MICRO_G_PER_M_SQ_PER_HR^MDC^ug/m2/h^ug/m2/h^UCUM
268980^MDC_DIM_NANO_G_PER_M_SQ_PER_HR^MDC^ng/m2/h^ng/m2/h^UCUM
269312^MDC_DIM_G_PER_M_SQ_PER_DAY^MDC^g/m2/d^g/m2/d^UCUM
269330^MDC_DIM_MILLI_G_PER_M_SQ_PER_DAY^MDC^mg/m2/d^mg/m2/d^UCUM
269331^MDC_DIM_MICRO_G_PER_M_SQ_PER_DAY^MDC^ug/m2/d^ug/m2/d^UCUM
269332^MDC_DIM_NANO_G_PER_M_SQ_PER_DAY^MDC^ng/m2/d^ng/m2/d^UCUM
0^MDC_DIM_MOLE_PER_M_SQ_PER_HR^MDC^mol/m2/h^mol/m2/h^UCUM
0^MDC_DIM_MILLI_MOLE_PER_M_SQ_PER_HR^MDC^mmol/m2/h^mmol/m2/h^UCUM
0^MDC_DIM_MOLE_PER_M_SQ_PER_DAY^MDC^mol/m2/d^mol/m2/d^UCUM
0^MDC_DIM_MILLI_MOLE_PER_M_SQ_PER_DAY^MDC^mmol/m2/d^mmol/m2/d^UCUM
269216^MDC_DIM_EQUIV_PER_M_SQ_PER_HR^MDC^eq/m2/h^eq/m2/h^UCUM
269234^MDC_DIM_MILLI_EQUIV_PER_M_SQ_PER_HR^MDC^meq/m2/h^meq/m2/h^UCUM
269280^MDC_DIM_EQUIV_PER_M_SQ_PER_DAY^MDC^eq/m2/d^eq/m2/d^UCUM
269298^MDC_DIM_MILLI_EQUIV_PER_M_SQ_PER_DAY^MDC^meq/m2/d^meq/m2/d^UCUM
269123^MDC_DIM_KILO_INTL_UNIT_PER_M_SQ_PER_MIN^MDC^k[iU]/m2/min^k[iU]/m2/min^UCUM
269088^MDC_DIM_INTL_UNIT_PER_M_SQ_PER_HR^MDC^[iU]/m2/h^[iU]/m2/h^UCUM
269106^MDC_DIM_MILLI_INTL_UNIT_PER_M_SQ_PER_HR^MDC^m[iU]/m2/h^m[iU]/m2/h^UCUM
269091^MDC_DIM_KILO_INTL_UNIT_PER_M_SQ_PER_HR^MDC^k[iU]/m2/h^k[iU]/m2/h^UCUM
269344^MDC_DIM_INTL_UNIT_PER_M_SQ_PER_DAY^MDC^[iU]/m2/d^[iU]/m2/d^UCUM
269362^MDC_DIM_MILLI_INTL_UNIT_PER_M_SQ_PER_DAY^MDC^m[iU]/m2/d^m[iU]/m2/d^UCUM
269347^MDC_DIM_KILO_INTL_UNIT_PER_M_SQ_PER_DAY^MDC^k[iU]/m2/d^k[iU]/m2/d^UCUM
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 25
6. APPENDIX B: MESSAGES SAMPLES
PID|||PATIENT_ID^^^^^||Lastname^Firstname^^^^^L^||19610201|M
PV1||U|Surgery^OR^4^^^^^
OBR|1|AB12345^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-64|CD67890^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-
64|Alfentanil^Alfentanil|||20130130144611.811-0600
OBX|1||69985^MDC_DEV_PUMP_INFUS_MDS^MDC|1.0.0.0|||||||X|||||||018210/98898989X^^0013380000000000^EUI-64
OBX|2||69986^MDC_DEV_PUMP_INFUS_VMD^MDC|1.1.0.0|||||||X
OBX|3||126978^MDC_DEV_PUMP_INFUS_CHAN_DELIVERY^MDC|1.1.1.0|||||||X|||
OBX|4|CWE|184508^MDC_PUMP_STAT^MDC|1.1.1.1|^pump-status-infusing|262656^MDC_DIM_DIMLESS^MDC|||||R|||
OBX|5|CWE|184504^MDC_PUMP_MODE^MDC|1.1.1.2|^pump-mode-nominal|262656^MDC_DIM_DIMLESS^MDC|||||R|||
OBX|6|NM|157888^MDC_VOL_FLUID_DELIV_TOTAL_SET^MDC|1.1.1.3|0.414|263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM|||||R|||
OBX|7|NM|157864^MDC_VOL_FLUID_DELIV^MDC|1.1.1.4|0.414|263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM|||||R|||
OBX|8|NM|157784^MDC_FLOW_FLUID_PUMP^MDC|1.1.1.5|15|265266^MDC_DIM_MILLI_L_PER_HR^MDC^mL/h^mL/h^UCUM|||||R|||
OBX|9||126977^MDC_DEV_PUMP_INFUS_CHAN_SOURCE^MDC|1.1.2.0|||||||X|||
OBX|10|ST|184330^MDC_DRUG_NAME_TYPE^MDC|1.1.2.1|Alfentanil|262656^MDC_DIM_DIMLESS^MDC|||||R|||
OBX|11|NM|157760^MDC_CONC_DRUG^MDC|1.1.2.2|100|264307^MDC_DIM_MICRO_G_PER_ML^MDC^ug/mL^ug/mL^UCUM|||||R|||
OBX|12|NM|157872^MDC_VOL_FLUID_TBI_REMAIN^MDC|1.1.2.3|51.147|263762^MDC_DIM_MILLI_L^MDC^mL^mL^UCUM|||||R|||
OBX|13|NM|157916^MDC_TIME_PD_REMAIN^MDC|1.1.2.4|204.588|264352^MDC_DIM_MIN^MDC^min^min^UCUM|||||R|||
OBX|14|NM|157924^MDC_RATE_DOSE^MDC|1.1.2.5|25|265491^MDC_DIM_MICRO_G_PER_MIN^MDC^ug/min^ug/min^UCUM|||||R|||
OBX|15|NM|157820^MDC_MASS_DRUG_DELIV^MDC|1.1.2.6|41.43|263891^MDC_DIM_MICRO_G^MDC^ug^ug^UCUM|||||R|||
Sample of the acknowledgement message sent back by the peer hl7 application to the Link+ (in ER7 format):
MSH|^~\&|PEER_DOC_APP|PEER_MANUFACTURER|PAT_DEVICE_FRESENIUS|FRESENIUS|20130130144612||ACK^R01^ACK|20130130144612085606|P|2.6
MSA|AA|FMD40-20130130144611
26 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc
6.2 Alarm Report HL7 interface messages samples
Following is a sequence of 2 alarm messages sent by the Link+ on the Alarm Report HL7 interface to a peer HL7
application. The 2 messages report an occlusion alarm: the first one is sent when the occlusion occurs (event phase is
“start”), the second one is sent when the occlusion ends (event phase “end”).
The acknowledgement messages sent back by the peer HL7 application are provided too.
First alarm message (in ER7 format):
MSH|^~\&|PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-64|FRESENIUS|PEER_AM_APP|PEER_MANUFACTURER|20130131144548.283-
0600||ORU^R40^ORU_R40|FMD4-20130131144548|P|2.6|||NE|AL||ASCII|||IHE_PCD_ACM_001^IHE PCD^1.3.6.1.4.1.19376.1.6.4.4^ISO
PID|||2010002^^^^^||Lastname^Firstname^^^^^L^||19610201|M
PV1||U|Surgery^OR^4^^^^^
OBR|1|AB12345^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-64|018020/21481377X-1_2_2_0-0^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-
64|ALARM^ALARM^|||20130131144548.283-0600||||||||||||||||||||||^018020/21481377X-1_2_2&PAT_DEVICE_FRESENIUS&001338FFFE02FF00&EUI-64
OBX|1|CWE|196616^MDC_EVT_ALARM^MDC|1.0.0.0.1|196688^MDC_EVT_OCCL^MDC|||A~PH~ST|||X|||20130131144548.283-
0600||||018020/21481377X^^0013380000000000^EUI-64
OBX|2|CWE|ALARM_SOURCE^ALARM_SOURCE^|1.0.0.0.2|69985^MDC_DEV_PUMP_INFUS_MDS^MDC||||||X
OBX|3|ST|EVENT_PHASE^EVENT_PHASE^|1.0.0.0.3|start||||||R
OBX|4|ST|ALARM_STATE^ALARM_STATE^|1.0.0.0.4|active||||||R
MSA|AA|FMD4-20130131144548
PID|||2010002^^^^^||Lastname^Firstname^^^^^L^||19610201|M
PV1||U|Surgery^OR^4^^^^^
OBR|1|AB12345^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-64|018020/21481377X-1_2_2_2-1^PAT_DEVICE_FRESENIUS^001338FFFE02FF00^EUI-
64|ALARM^ALARM^|||20130131144555.548-0600||||||||||||||||||||||^018020/21481377X-1_2_2&PAT_DEVICE_FRESENIUS&001338FFFE02FF00&EUI-64
OBX|1|CWE|196616^MDC_EVT_ALARM^MDC|1.0.0.0.1|196688^MDC_EVT_OCCL^MDC|||A~PH~ST|||X|||20130131144555.548-
0600||||018020/21481377X^^0013380000000000^EUI-64
OBX|2|CWE|ALARM_SOURCE^ALARM_SOURCE^|1.0.0.0.2|69985^MDC_DEV_PUMP_INFUS_MDS^MDC||||||X
OBX|3|ST|EVENT_PHASE^EVENT_PHASE^|1.0.0.0.3|end||||||R
OBX|4|ST|ALARM_STATE^ALARM_STATE^|1.0.0.0.4|inactive||||||R
MSA|AA|FMD5-20130131144555
CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc 27
7. LOCAL CONTACTS FOR SERVICING
Fresenius Kabi AG
D-61346 Bad Homburg
Marking in conformity to the
Germany essential requirements of the
www.fresenius-kabi.com 93/42/CEE directive.
28 CC5725_Link+_Agilia_HL7_Interface_Handbook_eng.doc