Communication Programmers Guide - G5015012 SW 8.20
Communication Programmers Guide - G5015012 SW 8.20
Guide
Order number:
G5015012
© 2005–2019 Gambro Lundia AB. All rights reserved.
Trademarks
Baxter, Adsorba, Diamars, Hospal, Mars, Mars flux, Oxiris, Prismacomfort, Prismaflo, Prismalung,
Prismatherm, Septex and Prismaflex are trademarks of Baxter International Inc. or its subsidiaries.
Codan is a trademark of Codan.
Injectomat is a trademark of Fresenius SE & Co.
Monoject is a trademark of Covidien AG.
NovaTherm is a trademark of Novalung GmbH.
Omnifix and Perfusor are trademarks of B. Braun Melsungen AG.
Plastipak is a trademark of Becton, Dickinson & Company.
Terumo is a trademark of Terumo Corporation.
Manufacturer
Gambro Lundia AB
Box 10101
Magistratsvägen 16
SE-220 10 LUND
Sweden
Phone +46 46 169000
www.baxter.com
Questions or comments about this publication can be directed to your local representative or to the
manufacturer.
1 Introduction.............................................................................................................................. 3
1.1 Introduction.................................................................................................................... 4
NOTE!
This Programmer's Guide has to be provided with the Baxter Non Disclosure
Agreement.
WARNING!
If a Patient Data Management System (PDMS) is to be used with the PRISMAFLEX
system, the Responsible Organization is obliged to verify compatibility between the
two systems. The Responsible Organization should identify, analyze, evaluate and
control risks due to integration of PRISMAFLEX in an IT network. Subsequent
changes to the IT network could introduce new risks and require new analysis. The
use of a PDMS not compatible with the PRISMAFLEX system can result in
presentation of erroneous data. It is the responsibility of the physician to verify all
data before prescribing any therapeutic or pharmacological action for the patient.
WARNING!
The personal computer used for receiving/storing collected PRISMAFLEX data must
meet or exceed the IEC 60950 electrical isolation specification for computers.
NOTE!
The patient ID is hidden by default when using any of the external communication
protocols. The Responsible Organization has the legal responsibility to comply with
data security and confidentiality requirements.
2.2.1 MachID
Each PRISMAFLEX system can be associated with a 2-byte word (hereafter MachID)
that is attached - for identification purposes - to every message that the PRISMAFLEX
system itself sends through its communication interfaces.
In order to take full advantage of the PRISMAFLEX Communication Protocol device
identification feature, check the uniqueness of the MachID across your PRISMAFLEX
network in the Calibration section in service mode, in the Service – External
Communication Interface screen. MachID is setable between 0 to 255.
NOTE!
the messages do not contain the number of the listening port. However, when a
communication is active, it’s possible to verify which listening port is used by
checking the value of the field FLAG in the message header (see Section 3.3.4
“Message Flags” on page 16).
In case of a socket timeout, the PRISMAFLEX control unit will drop a stalled TCP
connection after 20 ± 10 seconds. The timeout allows for detection of an unplugged
ethernet cable.
CAUTION!
Devices connected to the RS232 serial communication port or the Ethernet port
must comply with IEC 60950. Connected cables must have a Kitagawa RFC-10
ferrite or equivalent to fulfill EMC requirements.
The RS232 communications port is exposed on a DB9-type female connector, located
on the rear panel of the PRISMAFLEX control unit.
Pin configuration of the RS232 communication port is shown in Figure 2-2 “RS232
connector - DB9 Female” on page 9. To connect the interface cable to the
PRISMAFLEX control unit and PC, proceed as follows:
1. Line up the pins on the cable's connector with the sockets on the PRISMAFLEX
RS232 port. Press the pins into the sockets. Use the two finger screws to tighten
the connector to the PRISMAFLEX control unit.
2. Attach the other cable end to an unused COM port of the PC. Use the two finger
screws to tighten the connector to the PC.
NOTE!
When treatment is in a therapy state outside “RUN” and CHANGE_BAGS, the
S-message fields with names starting with IO_HIST_ are not updated.
In the Ethernet connection scenario, after the TCP connection has been opened, the
PRISMAFLEX control unit periodically writes a binary formatted message (hereafter
called S-message) on the newly created socket. The result is a sequence of
messages, characterized by a timing set, which can be configured via the
PRISMAFLEX Service Mode, as described in the Section 2.2.2 “Master Time Settings”
on page 7.
The RS232 connection has a similar behaviour: shortly after the serial connection has
been opened, the peer receives a byte stream, containing a periodical S-message
sequence. Make sure to start decoding only after a whole message has been received.
built under the rules described in Section 3.4 “Endianness” on page 17.
Param_code is the code for the parameter. There are Numerical parameters,
Enumerative parameters and Alarm (Warning, Malfunction, Caution, and Advisory)
parameters. They are listed in Section 5.2 “Parameters” on page 22.
NOTE!
For Numerical and Enumerative Parameters (ActualValue), the Param_code
corresponds to the ID in the Parameters section.
NOTE!
For Alarm Parameters, the Param_code corresponds to 0x80000000 + the ID in the
Parameters section.
Time is the set time on the PRISMAFLEX Control unit when the sampling measure has
been performed. It’s expressed in seconds, elapsed from the Jan, 01 1970 midnight
(epoch time). Measure_value represents the value of the parameter, expressed in
exponential notation (base-10). Only the mantissa is included in the Srecord: the
exponent to be used is fully determined given a particular parameter code, and it can
be found in Parameters section.
WARNING!
In case of power failure event detected via the appropriate message flag
(PWRFAIL_MESSAGE___FROM_PRISMAFLEX), all the remaining message
information - including the entire message body - must be ignored, since the data
correctness is not guaranteed.
NOTE!
The patient ID is hidden by default when using any of the external communication
protocols. The Responsible Organization has the legal responsibility to comply with
data security and confidentiality requirements.
3.4 Endianness
Endianness refers to sequencing methods used in one-dimensional systems. The
convention “little-endian” (little-units-first, i.e. Intel x86-type representation) applies to
all binary streams, when talking or listening to the PRISMAFLEX System.
Let suppose that the value of the field “Flags” of a certain message is “02 00 00 00”.
According to the little-endian convention, that value must be read as “00 00 00 02”.
That tells us that we are analyzing a Service-message.
3.5 Alarm
Information about alarms are given at the end of an S-message (both Status-message
and Service-message), after the Numerical and Enumerative parameters list.
Only alarm with the highest priority will be included when an S-message is sent. In
case more than one alarm is active, only the alarm with the highest priority will be
reported as present, as per Table 5-6. Any overridden alarm will also be reported.
5.2 Parameters
5.2.3 Alarms
5.2.3.4 Advisory
Table 5-9. Advisory
ID Name Title
226 ALMA_ACC_PRESS_OVER_OP Check Access
227 ALMA_ACC_PRESS_UNDER_OP Check Access
228 ALMA_RET_PRESS_OVER_OP Check Return
229 ALMA_PAUSE_TIME_EXPIRED Blood Flow Stopped
230 ALMA_SYRINGE_EMPTY Syringe Empty
231 ALMA_SYRINGE_LINE_CLAMPED Syringe Line Clamped
232 ALMA_CLOTTING_FILTER Filter is Clotting
233 ALMA_TPE_CLOTTING_FILTER Plasmafilter is Clotting
234 ALMA_HP_CLOTTING_FILTER HP Cartridge is Clotting
235 ALMA_MAX_UFR TMP Too High
236 ALMA_TPE_MAX_UFR TMPa Too High
237 ALMA_REPLACE_BLOOD_CIRCUIT Time to Change Set (72 hours)
240 ALMA_RET_PRESS_CANNOT_MON Cannot Detect Return
244 ALMA_CONFIRM_POSITIVE_RANGE Confirm Access Range (POS)
245 ALMA_CONFIRM_NEGATIVE_RANGE Confirm Access Range (NEG)
258 ALMA_CONFIRM_CONFIRM_POSITIVE_RANGE Confirm Positive Access
Pressure
259 ALMA_SYRINGE_LINE_CLAMPED_TEST Check Syringe Line
261 ALMA_SYRINGE_NOT_LOADED Syringe Not Loaded
279 ALMA_FLUID_PUMPS_STOPPED Fluid Pumps Stopped
280 ALMA_CITRATE_CHECK_POINT Anticoagulation Checkpoints
301 ALMA_SYRINGE_ALMOST_EMPTY Syringe Almost Empty
302 ALMA_CALCIUM_SYRINGE_EMPTY Calcium Syringe Empty
303 ALMA_CALCIUM_LINE_CLAMPED Calcium Line Clamped
304 ALMA_CALCIUM_LINE_NOT_CONNECTED Calcium Line Not Connected
305 ALMA_MEMORY_BACKUP Memory Backup
306 ALMA_START_MARS_TREATMENT MARS TREATMENT
314 ALMA_BATTERY_EXHAUSTED Battery Exhausted
315 ALMA_MAIN_POWER_LOST Main Power Lost
320 ALMA_SELF_TEST_OVERDUE Self-test overdue
322 ALMA_INCOMPLETE_BOLUS Incomplete Bolus (Treatment
was stopped during an
anticoagulation bolus)
5.2.3.5 Malfunction
Table 5-10. Malfunction
ID Name Title
65 ALMM_GENERAL_SAFESTATE_UNDEFINED General System Failure (0)
67 ALMM_WATCHDOG_FAIL_ON_TASK Communication Error (2)
68 ALMM_PROT_COMMUNICATION_LINK_ERROR Communication Error (3)
69 ALMM_CON_COMMUNICATION_LINK_ERROR Communication Error (4)
70 ALMM_STATUS_COMM_MISSING Communication Error (5)
71 ALMM_ALARM_COMM_MISSING Communication Error (6)
72 ALMM_SENDTOPSLAVE_ERROR Communication Error (7)
74 ALMM_SETVAL_INCONGRUENCE Memory Error (4)
75 ALMM_PRESSURE_HWTEST_FAIL Pressures Circuit Board
76 ALMM_VOLTAGE_OUT_RANGE Voltage Out of Range
77 ALMM_SETVAL_INCONGRUENCE_CTRL_PROT Memory Error (6)
81 ALMM_BUBBLE_TEST_FAIL Air Detector
82 ALMM_CLOSED_CLAMP Clamp Stuck Closed
83 ALMM_B_RATE_WRONG Blood Pump
84 ALMM_W_RATE_WRONG Effluent Pump
85 ALMM_R_RATE_WRONG Replacement Pump
86 ALMM_D_RATE_WRONG Dialysate Pump
87 ALMM_P_RATE_WRONG PBP Pump
88 ALMM_BLD_NORM_FAIL Normalization Failed
89 ALMM_BLOOD_TEST_FAIL Blood Leak Detector
98 ALMM_STST_ACC_EFFL_FAIL Self-Test Failure (5)
99 ALMM_STST_FIL_EFFL_FAIL Self-Test Failure (6)
100 ALMM_STST_EFFL_FIL_ACC_FAIL Self-Test Failure (7)
109 ALMM_STST_RET_FAIL Self-Test Failure (16)
110 ALMM_PRTST_BLDNORM_FAIL Prime Self-Test (17)
111 ALMM_PRTST_BLD_FAIL Prime Self-Test (18)
112 ALMM_PRTST_STOPPUMP_FAIL Prime Self-Test (19)
113 ALMM_PRTST_PUMPOCCL_FAIL Prime Self-Test (20)
114 ALMM_PRTST_DIAL_PINCH_FAIL Prime Self-Test (21)
115 ALMM_PRTST_REP_PINCH_FAIL Prime Self-Test (22)
116 ALMM_PRTST_DIALREP_PINCH_FAIL Prime Self-Test (23)
117 ALMM_PRTST_24V_FAIL Prime Self-Test (24)
118 ALMM_PRTST_CLAMP_FAIL Prime Self-Test (25)
119 ALMM_PRTST_24V_CLAMP_FAIL Prime Self-Test (26)
121 ALMM_PRTST_ACC_FAIL Prime Self-Test (1)
122 ALMM_PRTST_FIL_FAIL Prime Self-Test (2)
123 ALMM_PRTST_ACC_FIL_FAIL Prime Self-Test (3)
124 ALMM_PRTST_EFFL_FAIL Prime Self-Test (4)
NOTE!
Erasing the History Data is possible before downloading it to the USB flash drive.
Always make sure to download the data before erasing it to avoid data loss.
Decoding
Software version
820 ⇒ SW 8.20
Language
ENGB = English
Table 7-1.
Language Name ISO 639-1 + ISO 3166-1
English (Great Britain) enGB
Bulgarian bgBG
Chinese (Simplified) zhCN
Chinese (Traditional) zhTW
Croatian hrHR
Czech csCZ
Danish daDK
Dutch (The Netherlands) nlNL
Estonian etEE
Finnish fiFI
French (France) frFR
German (Germany) deDE
Greek elGR
Hungarian huHU
Indonesian idID
Italian (Italy) itIT
Japanese jpJP
Korean koKR
Latvian lvLV
Lithuanian ltLT
Norwegian (Bokmål) nbNO
Polish plPL
Portuguese (Portugal) ptPT
Romanian (Romania) roRO
Russian ruRU
Serbian srRS
Scale error
321X00001X004H4Z
Table 7-3.
Base 36 Dec
32 110 PBP_px
1X 69 PBP_cx
00 0 Rep_px
00 0 Rep_cx
1X 69 Dia_px
00 0 Dia_cx
4H 161 Eff_px
4Z 179 Eff_cx
Table 7-4.
Base 36 Dec
EN 527 ABD_x