0% found this document useful (0 votes)
129 views

AW8057 Rev A - PrisMax Communication Programmers Guide

Uploaded by

mario
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
129 views

AW8057 Rev A - PrisMax Communication Programmers Guide

Uploaded by

mario
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 21

Communication Programmer’s Guide

For use with software version 2.X


Trademarks

PrisMax, prismaComfort, prismaFlo II, prismaFlo IIS, prismaTherm and Baxter are trademarks of

Baxter International Inc.

Legal Manufacturer

Baxter Healthcare SA

8010 Zurich

Switzerland

www.baxter.com

Questions or comments about this publication

can be directed to your local representative or

to the manufacturer.

AW8057 Rev A SEP2018 Page | 1


Notes:

AW8057 Rev A SEP2018 Page | 2


Table of Contents
1 Introduction ........................................................................................................................................................... 4
1.1 Terms, Acronyms and Definitions ................................................................................................................. 4
1.2 Service Information........................................................................................................................................ 4
2 Communication Interfaces .................................................................................................................................... 5
2.1 General Settings ............................................................................................................................................. 5
2.1.1 EMR ID ................................................................................................................................................ 5
2.1.2 EMR Timer ........................................................................................................................................... 5
2.2 Ethernet Connections ..................................................................................................................................... 5
2.2.1 Software Requirements ......................................................................................................................... 5
2.2.2 Network Settings................................................................................................................................... 6
2.2.3 Connecting to PrisMax Ethernet Network Interface ............................................................................. 6
2.3 RS232 Connections ........................................................................................................................................ 6
2.3.1 Software Requirements ......................................................................................................................... 6
2.3.2 Connecting to PrisMax RS232 Interface ............................................................................................... 6
3 Accessing the PrisMax Communication ............................................................................................................... 8
3.1 S-message Subtypes ....................................................................................................................................... 8
3.2 S-message Structure Definition ...................................................................................................................... 8
3.2.1 CRC Calculation ................................................................................................................................... 9
3.2.2 Message Body: S-record Structure Definition .................................................................................... 10
3.2.3 Message Flags ..................................................................................................................................... 10
3.2.4 Patient Identifier.................................................................................................................................. 10
3.2.5 Software Revision Encoding Convention ........................................................................................... 10
3.3 Endianness ................................................................................................................................................... 11
3.4 Alarm ........................................................................................................................................................... 11
4 Example of Received Data Stream ..................................................................................................................... 12
5 General Coding Conventions .............................................................................................................................. 14
5.1 Parameters .................................................................................................................................................... 14
5.1.1 Numerical Parameters ......................................................................................................................... 14
5.1.2 Enumerative Parameters ..................................................................................................................... 19

AW8057 Rev A SEP2018 Page | 3


1 Introduction
This Programmer’s Guide provides the information needed when writing a customized software program which will
collect synchronous data from PrisMax. This Guide is intended for use only by trained and experienced software
programmers. Before writing a data collection/storage program, the programmer should understand how the medical
institution wishes to use the collected data.

Note: Detailed information about PrisMax is available in the PrisMax Operators Manual and the PrisMax Service
Manual.

Note: This Programmer’s Guide has to be provided with the Baxter, Intl Non-Disclosure Agreement.

1.1 Terms, Acronyms and Definitions


EMR Electronic Medical Records

1.2 Service Information


For technical assistance, contact your representative.

AW8057 Rev A SEP2018 Page | 4


2 Communication Interfaces
PrisMax is equipped with two different communication interfaces located on the rear panel.
• An Ethernet network interface, with a 10Base-T compatible connector;
• An optically isolated RS232 serial communications port (Note: the top serial port is used for the
communication protocol described in this document). Note that a “straight through” cable is to be used for
connection here. An internally applied “Null Modem” is already present.

Figure 2-1. Rear Panel

Both the Ethernet and the RS232 interfaces are IEC 60601-1 compliant.

WARNING --------------------------------------------------------------------------------------------------------------------------------------
PrisMax makes treatment-related data available to connected external devices (personal computer or communication
network) for storage and display. This information is intended to support the physician but is not a substitute for
clinical verification or judgement. If using a patient data management system (PDMS) with PrisMax, it is the hospital’s
responsibility to verify compatibility between the two systems, and to evaluate the risks of any subsequent changes to
the PDMS or associated equipment. Using incompatible systems can result in presentation of erroneous data. It is
the physician’s responsibility to verify all data before prescribing any therapeutic or pharmacological action for the
patient.
--------------------------------------------------------------------------------------------------------------------------------------- WARNING

2.1 General Settings


2.1.1 EMR ID
Each PrisMax can be associated with a 2-byte word (hereafter EMR ID) that is attached to, for identification
purposes, every message that PrisMax sends through its communication interfaces. In order to take full advantage of
the PrisMax communication protocol identification feature, check the uniqueness of the EMR ID across your network.
The EMR ID can be configured on the PrisMax System Configuration Connectivity screen.

2.1.2 EMR Timer


The PrisMax sends messages at fixed intervals as specified by the EMR Timer. The EMR Timer can be configured
on the PrisMax System Configuration Connectivity screen. The EMR Timer can be adjusted between 5 and 60 sec.
The default value for the EMR Timer is 10 sec. It applies to the Ethernet and RS232 ports.

There is no implied time synchronization between the EMR timer and any external high precision clock source.

2.2 Ethernet Connections


2.2.1 Software Requirements
The PrisMax Ethernet network interface is bound to a TCP/IP software stack. PrisMax has to be connected to an
Ethernet LAN having an available IP protocols suite, so that a communication channel can be opened.

AW8057 Rev A SEP2018 Page | 5


The EXTERNAL DEVICE connected to PrisMax has to be TCP/IP enabled and it should be able to perform a
connection to the TCP port (listening port) on which the PrisMax communication system is properly configured. When
the Ethernet port is set to 3001, then Status-messages are received (see 3.1 S-message Subtypes).

In case of a socket timeout, the PrisMax will drop a stalled TCP connection after 20 +/- 10 sec. The timeout allows for
detection of an unplugged Ethernet cable.

2.2.2 Network Settings


The IP address, bound to the PrisMax Ethernet network interface, and the other relevant IP settings (Netmask,
Default Gateway and DNS Server) can be configured on the PrisMax System Configuration Connectivity screen.

Check that the chosen IP address is unique across your IP network, or network software malfunction will arise.

2.2.3 Connecting to PrisMax Ethernet Network Interface


The Ethernet network interface connector is located on the rear panel of the PrisMax. To connect the PrisMax to the
LAN a twisted-pair CAT.5E D+ class patch cable should be used: one plug has to be attached to the PrisMax
Ethernet network interface connector, and the other end should be inserted in a free patch jack in your LAN
hub/switch.

2.3 RS232 Connections


2.3.1 Software Requirements
The PrisMax RS232 settings are given by the manufacturer and they can only be changed by an authorized
individual:

Table 2-1: RS232 Configuration


Configuration Setting
Baud Rate 115200

Data Bits 8
Parity None
Stop Bits 1
Flow Control None
Buffer Max Size
Out 1024
In 648
It is recommended to stay at a higher baud rate, reducing the speed may make it impossible to transmit all the
message data between the intermessage gap time.

2.3.2 Connecting to PrisMax RS232 Interface


WARNING --------------------------------------------------------------------------------------------------------------------------------------
To connect the PrisMax to an external device, use only a RS232 Interface Cable that conforms to the requirements of
IEC 60601-1 and IEC 61000-4 standards, and meets European Standard EN 55011, limit B.
--------------------------------------------------------------------------------------------------------------------------------------- WARNING

CAUTION ---------------------------------------------------------------------------------------------------------------------------------------
Devices connected to the RS232 serial connection 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.
--------------------------------------------------------------------------------------------------------------------------------------- CAUTION

The RS232 communications port is the top serial port located on the rear panel of the PrisMax. The top-most
PrisMax port is a DB-9 Female DCE. Use a straight cable to connect it to a typical PC which is DB-9 Male DTE. To
connect the interface cable to the PrisMax and external device proceed as follows:
• Line up the pins on the cable’s connector with the top RS232 socket on the rear panel of the PrisMax. Press
the pins into the socket. Use the two finger screws to tighten the connector to the PrisMax.

AW8057 Rev A SEP2018 Page | 6


• Attach the other cable end to an unused COM port of the external device. Use the two finger screws to
tighten the connector to the external device.

AW8057 Rev A SEP2018 Page | 7


3 Accessing the PrisMax Communication
PrisMax makes available a synchronous data flow (containing both technical and dialysis-related information) via the
communication interfaces. Once the logical connection has been established (via Ethernet Network and/or RS232),
and either New Patient or Same Patient has been selected on PrisMax, PrisMax will begin to periodically send a
binary formatted message (hereafter called S-message). The S-messages are sent with a periodicity as defined by
the EMR Timer (see 2.1.2 EMR Timer).

In the Ethernet connection scenario, the S-messages are always sent as long as a client connection has been
initiated. In the RS232 connection scenario, the S-messages are sent when the EMR Enabled is checked on the
System Configuration Connectivity screen.

3.1 S-message Subtypes


For PrisMax, there is one type of S-messages and they are called Status-messages.

3.2 S-message Structure Definition


The S-message is composed of two main sections:
• Header
• Body

The header is always present. It has a fixed and predetermined size (in bytes), and contains a fixed number of fields.
See Table 3.1 S-message Structure Definition. The body is not always present and it does not have a fixed size.
When it exists, it contains a sequence of one or more S-records, (see 3.2.2 Message Body: S-record Structure
Definition)

The precise S-message structure definition is given in the following table.

Table 3-1: S-message Structure Definition


Section Field Name Type Description Allowed Values
Header STX Unsigned short Start of text marker 0x0002
(16 bits)
CRC Unsigned short Cyclic redundancy any
(16 bits) check, computed
applying the
standard CRC16
algorithm to the
message portion
that starts from the
subsequent field
and extends to the
end of the message.
See 3.2.1 CRC
Calculation.
MachID Unsigned short PrisMax EMR ID. It 0x00 – 0xFF
(16 bits) can be configured
via the PrisMax user
interface. See 2.1.1
EMR ID.
ClinicalSWID Unsigned short RESERVED: SET 0x0000
(16 bits) TO ZERO
MsgCounter Integer RESERVED: SET 0x00000000
(32 bits) TO ZERO
CmdCode Integer RESERVED: SET 0x00000000
(32 bits) TO ZERO
MsgInfo Integer Message 0-0x7FFFFFFF
(32 bits) information. The
number of S-records
in the message
body
Flags Integer Message flags See 3.2.3 Message
(32 bits) Flags

AW8057 Rev A SEP2018 Page | 8


Section Field Name Type Description Allowed Values
PatID Unicode chars Patient Identifier See 3.2.4 Patient
(20 x 32 bits) Identifier
SWRevision Integer Software revision. See 3.2.5 Software
(32 bits) Represents the Revision Encoding
PrisMax software Convention
revision
TherapyType Integer Therapy type. THERAPY_ID
(32 bits) Represents the enumeration, See
therapy selected for 5.1.2 for definition.
the currently
delivered treatment.
TherapyStatus Integer Therapy status. THERAPY_STATES
(32 bits) Contains enumeration, See
information about 5.1.2 for definition.
the status of
treatment
Time Integer Contains the 0 – 0x7FFFFFFF
(32 bits) timestamp
associated with the
message,
expressed in
seconds elapsed
since Jan 1, 1970
midnight
MBL Unsigned integer Message body 0x00 – 0x000017F4
(32 bits) length
Body (packet Sequence of S- 0 or more S-records
of data records See 3.2.2 Message
following this Body: S-record
header) Structure Definition

3.2.1 CRC Calculation


Here is an extract of the source code used to calculate the CRC.

#define STX_CRC_LENGTH 4 // length of STX + CRC


#define POLY 0x8408 // used by CRC calculation algorithm

// Function for calculating the CRC of the S-message


void EmrMessage::CalculateCrc(uEmrSMessage* pMessage)
{
unsigned short i;
unsinged short crc = 0;

for (i = STX_CRC_LENGTH; i < (sizeof(EmrHeader) +


pMessage->sMessage.mHeader.messageBodyLength); i++)
{
UpdateCrcForByte(&pMessage->cMessage[i], &crc);
}

pMessage->sMessage.mHeader.crc = crc;
}

// Function for adding one byte to the CRC result


short EmrMessage::UpdateCrcForByte(unsigned char* pBuf, unsigned short* pCrc)
{
unsigned short ch = (unsigned short) *pBuf;
for (int j = 1; j <= 8; j++)
{

AW8057 Rev A SEP2018 Page | 9


unsigned short Q = (*pCrc & 0x0001) ^ (ch & 0x0001);
if (Q == 0x0001)
{
*pCrc = *pCrc >> 1;
*pCrc = *pCrc ^ POLY;
}
else
{
*pCrc = *pCrc >> 1;
}
ch = ch >> 1;
}
return (*pCrc);
}

3.2.2 Message Body: S-record Structure Definition


The message body contains zero or more S-records. No separator or terminator is used in the S-records sequence.
Each S-record represents a value (Value) relative to a PrisMax parameter (Param_code), performed at a given time
(Time). More formally, an S-record is the binary serialization of a C-language variable of type defined as follows:

typedef struct {
unsigned int Param_code;
unsinged int Time;
int Value
} SRecord;

The S-record is built under the rules described in XX.

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 the section xx.

Note:
• For Numerical and Enumerative Parameters measured values (ACT), the Param_code corresponds to the
ID in the Parameters section.
• For Numerical and Enumerative Parameters setting values (SET), the Param_Code corresponds to
0x40000000 + the ID in the Parameters section.
• For Alarm Parameters, the Param_code corresponds to 0x80000000 + the ID in the Parameters section.

Time is the time of the PrisMax when the value was collected. It is expressed in seconds, elapsed since Jan 1, 1970
midnight (epoch time).

Value represents the value of the parameter, expressed in exponential notation (base-10). Only the mantissa is
included in the S-record: the exponent to be used is fully determined given a particular parameter code, and it can be
found in the Parameters section.

3.2.3 Message Flags


For PrisMax, the Flags field will always be set to indicate a Status-message and will contain the value 0x00000010.

3.2.4 Patient Identifier


Patient Identifier represents the patient ID. Its value will be a non-reversible mathematical function of the patient ID
entered on the PrisMax Patient Information screen during Setup for a treatment. This field can contain a maximum of
20 characters.

3.2.5 Software Revision Encoding Convention


The SWRevision field of every S-message contains the PrisMax software revision. The SWRevision has the following
structure:

A.B.C.0
Where A, B, and C are numbers

AW8057 Rev A SEP2018 Page | 10


Here are the steps to get the PrisMax software revision from the SWRevision field:
• Apply the little-endian convention to the SWRevision field
• Convert the hexadecimal value to the decimal value (e.g. A B C D)
• Extract the digits and group them according to the above PrisMax software revision structure.

See 4 Example of Received Data Stream.

3.3 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 PrisMax.
Let’s suppose that the value of the field “Flags” of a certain message is “10 00 00 00”. According to the little-endian
convention, that value must be read as “00 00 00 10”, which tells us that we are analyzing a Status-message.

3.4 Alarm
Information about alarms is given in the Operator’s Manual. Only the active alarm with the highest priority will be
included when an S-message is sent.

AW8057 Rev A SEP2018 Page | 11


4 Example of Received Data Stream
The following table shows an example of a portion of a received data stream, containing an S-message.

Output is the received data.


Value is the output according to the little-endian convention.
Field Name is the naming convention for that portion of the output.
Description is its explanation.

Table 4-1: Example of a Received Data Stream


Output Value Field Name Description
02 00 00 02 STX (Header) Start of text marker.
03 C2 C2 03 CRC (Header) Cyclic Redundancy Check.
0A 00 00 0A MachID (Header) EMR ID.
Configured on PrisMax System
Configuration Connectivity screen.
00 00 00 00 N/A Clinical software ID. Currently not used.
00 00 00 00 00 00 00 00 N/A Message counter. Currently not used.
00 00 00 00 00 00 00 00 N/A Command code. Currently not used.
5F 00 00 00 00 00 00 5F MsgInfo (Header) Message information – the number of S-
records in the S-message. In this example
there are 95 S-records
10 00 00 00 00 00 00 10 Flags (Header) This flag indicates it is a Status-message.
74 00 00 00 00 00 00 74 PatientID t
66 00 00 00 f
6B 00 00 00 k
68 00 00 00 h
69 00 00 00 i
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
00 00 00 00 null
40 42 0F 00 00 0F 42 40 SWRevision (Header) Conversion from hex to dec gives value
1000000. The PrisMax software version is
1.0.0. This can be found on the PrisMax
System Configuration System Info screen.
03 00 00 00 00 00 00 03 TherapyType (Header) Selected Therapy is CVVHD. See
THERAPY_TYPE.
05 00 00 00 00 00 00 05 TherapyStatus (Header) PrisMax is in state RECIRCULATE. See
THERAPY_STATES.
C1 3A EC 4F 4F EC 3A C1 Time (Header) The message timestamp, expressed in
seconds elapsed since Jan 1, 1970
midnight, also called Epoch time. Timestamp
corresponds to the PrisMax system time
when the S-message was created. In this
example, the timestamp is 1340881601 and
the conversion gives 28 June 2012 11:06:41.
10 04 00 00 00 00 04 10 MBL (Header) The length of the S-message’s body in bytes
1040 bytes (0x0410).
01 00 00 00 00 00 00 01 1st S-record (Body) Param_code: 1 (ACCESS_PRESSURE)

AW8057 Rev A SEP2018 Page | 12


C1 3A EC 4F 4F EC 3A C1 Time: 19 Sept 2012 23:08:46
E4 FF FF FF FF FF FF E4 Value: -28 mmHg
02 00 00 00 00 00 00 02 2nd S-record (Body) Param_code: 2 (FILTER_PRESSURE)
C1 3A EC 4F 4F EC 3A C1 Time: 19 Sept 2012 23:08:46
83 00 00 00 00 00 00 83 Value: 131 mmHg
03 00 00 00 00 00 00 03 3rd S-record (Body) Param_code: 3 (EFFLUENT_PRESSURE)
C1 3A EC 4F 4F EC 3A C1 Time: 19 Sept 2012 23:08:46
59 00 00 00 00 00 00 59 Value: 89 mmHg
04 00 00 00 00 00 00 04 4th S-record (Body) Param_code: 4 (RETURN_PRESSURE)
C1 3A EC 4F 4F EC 3A C1 Time: 19 Sept 2012 23:08:46
51 00 00 00 00 00 00 51 Value: 81 mmHg

AW8057 Rev A SEP2018 Page | 13


5 General Coding Conventions
5.1 Parameters
5.1.1 Numerical Parameters
Note: Scale factor descriptions with all uppercase identifiers are enumeration types and will be expanded in the
enumeration data type section following.

Table 5-3: Numerical Parameters


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
1 ACCESS_PRESSURE: 1mmHg 500 -500 ACT
0x00000001
Actual value of the pressure at the access pod
2 FILTER_PRESSURE: 1mmHg 500 -500 ACT
0x00000002
Actual value of the pressure at the filter pod
3 EFFLUENT_PRESSURE: 1mmHg 500 -500 ACT
0x00000003
Actual pressure at the effluent pod
4 RETURN_PRESSURE: 1mmHg 500 -500 ACT
0x00000004
Actual pressure at the return pod
5 RESERVED: Not included in output N/A 0 0 ACT
0x00000005
6 TMP: 1mmHg 500 -500 ACT
0x00000006
Actual value of the transmembrane pressure
7 DP: 1mmHg 500 -500 ACT
0x00000007
Actual value of the pressure drop
17 BLOOD_FLOW: 1ml/min (*) (*) SET
0x00000011
Blood flow set by user
18 REPLACEMENT_PRE_FLOW: 1ml/hr (*) (*) SET
0x00000012
Replacement pre flow set by user
19 REPLACEMENT_POST_FLOW: 1ml/hr (*) (*) SET
0x00000013
Replacement post flow set by user
21 DIALYSATE_FLOW: 1ml/hr (*) (*) SET
0x00000015
Dialysate flow set by user
22 PRE_BLOOD_FLOW: 1ml/hr (*) (*) SET
0x00000016
Pre-blood flow set by user
23 EFFLUENT_FLOW: 1ml/hr (*) (*) SET
0x00000017
Effluent flow set by user (based on the other flows set)
24 PT_WEIGHT_BALANCE: 1ml/hr (*) (*) SET
0x00000018
PFR flow set by user
26 PT_WEIGHT: 1kg 999 0 SET
0x0000001A
Patient weight set by user
36 BOLUS_VOL: 0.1ml 5 0 SET
0x00000024
Anticoagulant bolus volume set by user
37 RESERVED: SET TO ZERO N/A 0 0 SET
0x00000025
38 HEPARIN_CONT_RATE: 0.1ml/hr 5 0 SET
0x00000026
Anticoagulant continuous rate set by user
44 RESERVED: SET TO ZERO N/A 0 0 SET
0x0000002C
47 PRE_HCT: 1% 60 10 SET
0x0000002F
Pre-Hematocrit value
59 CAL_RUN_TIME: 1s 10 000 0 ACT
0x0000003B
Actual run time of therapy 000
60 BLOOD_VOL_PROCESSED: 1l 780 0 ACT
0x0000003C
Actual blood volume processed
92 NEXT_INTERV_HOURS: 1hr (/) (/) ACT
0x0000005C
Hour of the next intervention
93 NEXT_INTERV_MINUTES: 1min (/) (/) ACT
0x0000005D
Minutes of the next intervention

AW8057 Rev A SEP2018 Page | 14


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
94 IO_HIST_PRE_REPL_WITH-OUT_PBP_TOT: 1ml (/) (/) ACT
0x0000005E
Actual cumulated volume for replacement pre delivered (excluding
PBP)
95 IO_HIST_POST_REPL_TOT: 1ml (/) (/) ACT
0x0000005F
Total replacement volume post delivered
Includes the volume from previous filter sets if the option Same
patient has been used, Selecting New Patient resets this value to 0
97 IO_HIST_DIAL_TOT: 1ml (/) (/) ACT
0x00000061
Actual cumulated volume for dialysate
98 IO_HIST_PBP_TOT: 1ml (/) (/) ACT
0x00000062
Actual cumulated volume for pre-blood
99 IO_HIST_EFFL_TOT: 1ml (/) (/) ACT
0x00000063
Actual cumulated volume for effluent
100 IO_HIST_PFR_TOT 1ml (/) (/) ACT
0x00000064
Actual cumulated patient fluid removed
192 MAX_GAIN: 1ml 2000 0 SET
0x000000C0
Max value of volume gain set by user
196 EXCESS_PATIENT_FLUID_LIMIT: 1ml 400 100 SET
0x000000C4
Limit value for excess patient fluid loss or gain, in CRRT, set by
user
198 EXCESS_PATIENT_FLUID_SIGN: 1ml (/) (/) ACT
0x000000C6
Actual value for patient excess fluid loss or gain, in CRRT
Positive value = GAIN
Negative value = LOSS
400 CITRATE_DOSE: 0.1mmol/l 6 0 SET
0x00000190
Citrate dose set by user
SET TO ZERO IF CITRATE ANTICOAGULATION NOT USED
401 CITRATE_CONCENTRATION: 1mmol/l 600 10 SET
0x00000191
Citrate concentration (excl. Citric Acid) of the used citrate solution
SET TO ZERO IF CITRATE ANTICOAGULATION NOT USED
402 CITRATE_SOL_CITR_ACID_CONC: 1mmol/l 100 0 SET
0x00000192
Citric Acid concentration of the used citrate solution
SET TO ZERO IF CITRATE ANTICOAGULATION NOT USED
403 CITRATE_LOAD: 0.1mmol/h (/) (/) SET
0x00000193
Citrate load
SET TO ZERO IF CITRATE ANTICOAGULATION NOT USED
404 CALCIUM_SYRINGE_RATE: 0.1ml/hr 100 2 SET
0x00000194
Calcium syringe flow rate
SET TO ZERO IF CITRATE/CALCIUM ANTICOAGULATION NOT
USED
405 CALCIUM_CONCENTRATION: 1mmol/l 1000 80 SET
0x00000195
Calcium concentration of the calcium solution in the syringe
SET TO ZERO IF CITRATE/CALCIUM ANTICOAGULATION NOT
USED
406 CALCIUM_COMPENSATION: 1% 200 5 SET
0x00000196
Calcium compensation set by user
SET TO ZERO IF CITRATE/CALCIUM ANTICOAGULATION NOT
USED
407 IO_HIST_SYRINGE_TOT: 1ml (/) (/) ACT
0x00000197
Actual cumulated volume for infused syringe solution
SET TO ZERO IF SYRINGE NOT USED
408 REPL_SOL_CA_CONC: 0.01mmol/l 1.75 0.00 SET
0x00000198
Calcium concentration in used Replacement solution
SET TO ZERO IF REPLACEMENT NOT USED
410 EFFL_DOSE: 1ml/hg/h (/) (/) ACT
0x0000019A
Calculated Total Effluent dose
412 FILTRATION_FRACT_BLOOD: 1% 100 0 ACT
0x0000019C
Calculated Filtration fraction value for blood

AW8057 Rev A SEP2018 Page | 15


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
413 REPL_PRE_PERCENT: 1% 100 0 ACT
0x0000019D
Replacement solution pre infused in blood circuit, includes PBP
solution
414 REPL_POST_PERCENT: 1% 100 0 ACT
0x0000019E
Replacement solution post infused in blood circuit
415 CURRENT_FILTER_TIME: 1min (/) 0 ACT
0x0000019F Note: Prismaflex
Run time for the disposable set currently in use
mistakenly had
units=1sec
416 IO_HIST_PFR_1HR_CHART: 1ml (/) (/) ACT
0x000001A0
Patient fluid removal value per 1 hour, reset every hour
417 IO_HIST_PFR_24HR_CHART: 1ml (/) (/) ACT
0x000001A1
Patient fluid removal volume presented per 24 hour from beginning
of Charting Period Start of Charting Period setting is configured on
the System Configuration Display Operations Screen.
Default start time is 00:00
418 IO_HIST_PFR_1HR: 1ml (/) (/) ACT
0x000001A2
Patient fluid removal volume
Per 1 hour sliding window
419 IO_HIST_PFR_24HR: 1ml (/) (/) ACT
0x000001A3
Patient fluid removal volume
Per 24 hour sliding window
420 IO_HIST_UF_1HR: 1ml (/) (/) ACT
0x000001A4
Ultrafiltration rate
Per 1 hour sliding window
Ultrafiltration volume = Total replacement volume + Pre-blood
volume + PFR volume
421 IO_HIST_UF_24HR: 1ml (/) (/) ACT
0x000001A5
Ultrafiltration rate
Per 24 hour sliding window
Ultrafiltration volume = Total replacement volume + Pre-blood
volume + PFR volume
422 IO_HIST_UF_TOT: 1ml (/) (/) ACT
0x000001A6
Ultrafiltration volume = Total replacement volume + Pre-blood
volume + PFR volume
Includes the volume from previous filter sets if the option Same
Patient has been used, Selecting New Patient resets this value to
0.
423 IO_HIST_UF_DOSE_1HR: 1ml/kg/h (/) (/) ACT
0x000001A7
Ultrafiltration dose
Per 1 hour sliding window
424 IO_HIST_UF_DOSE_24HR: 1ml/kg/h (/) (/) ACT
0x000001A8
Ultrafiltration dose
Per 24 hour sliding window
425 IO_HIST_UF_DOSE_TOT: 1ml/kg/h (/) (/) ACT
0x000001A9
Total Ultrafiltration dose
Includes the volume from previous filter sets if the option Same
Patient has been used, Selecting New Patient resets this value to
0.
426 IO_HIST_TOT_REPL_WITH_PBP_1HR: 1ml (/) (/) ACT
0x000001AA
Total replacement volume delivered, includes PBP volume,
Per 1 hour sliding window
427 IO_HIST_TOT_REPL_WITH_PBP_24HR: 1ml (/) (/) ACT
0x000001AB
Total replacement volume delivered, includes PBP volume,
Per 24 hour sliding window

AW8057 Rev A SEP2018 Page | 16


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
428 IO_HIST_TOT_REPL_WITH_PBP_TOT: 1ml (/) (/) ACT
0x000001AC
Total replacement volume delivered, includes PBP volume, from
beginning of treatment, Includes the volume from previous filter
sets if the option Same Patient has been used, Selecting New
Patient resets this value to 0.
429 IO_HIST_TOT_REPL_WITH_PBP_DOSE_1HR: 1ml/kg/h (/) (/) ACT
0x000001AD
Replacement (incl. PBP) dose
Per 1 hour sliding window
430 IO_HIST_TOT_REPL_WITH_PBP_DOSE_24HR: 1ml/kg/h (/) (/) ACT
0x000001AE
Replacement (incl. PBP) dose
Per 24 hour sliding window
431 IO_HIST_TOT_REPL_WITH_PBP_DOSE_TOT: 1ml/kg/h (/) (/) ACT
0x000001AF
Total replacement (incl. PBP) dose, Includes the volume from
previous filter sets if the option Same Patient has been used,
Selecting New Patient resets this value to 0.
432 IO_HIST_PRE_REPL_WITH_PBP_1HR: 1ml (/) (/) ACT
0x000001B0
Total replacement volume pre delivered including PBP
Per 1 hour sliding window
433 IO_HIST_PRE_REPL_WITH_PBP_24HR: 1ml (/) (/) ACT
0x000001B1
Total replacement volume pre delivered including PBP
Per 24 hour sliding window
434 IO_HIST_PRE_REPL_WITH_PBP_TOT: 1ml (/) (/) ACT
0x000001B2
Total replacement volume pre delivered including PBP, Includes
the volume from the previous filter sets if the option Same Patient
has been used; selecting New Patient resets this value to 0.
435 IO_HIST_PRE_REPL_WITH_PBP_DOSE_1HR: 1ml/kg/h (/) (/) ACT
0x000001B3
Total replacement dose pre delivered including PBP
Per 1 hour sliding window
436 IO_HIST_PRE_REPL_WITH_PBP_DOSE_24HR: 1ml/kg/h (/) (/) ACT
0x000001B4
Total replacement dose pre delivered including PBP
Per 24 hour sliding window
437 IO_HIST_PRE_REPL_WITH_PBP_DOSE_TOT: 1ml/kg/h (/) (/) ACT
0x000001B5
Total replacement dose pre delivered including PBP, Includes the
volume from previous filter sets if the option Same Patient has
been used; selecting New Patient resets this value to 0.
438 IO_HIST_POST_REPL_1HR: 1ml (/) (/) ACT
0x000001B6
Total replacement volume post delivered
Per 1 hour sliding window
439 IO_HIST_POST_REPL_24HR: 1ml (/) (/) ACT
0x000001B7
Total replacement volume post delivered
Per 24 hour sliding window
440 RESERVED: SET TO ZERO N/A 0 0 ACT
0x000001B8
441 IO_HIST_POST_REPL_DOSE_1HR: ml/kg/h (/) (/) ACT
0x000001B9
Total replacement dose post delivered
Per 1 hour sliding window
442 IO_HIST_POST_REPL_DOSE_24HR: ml/kg/h (/) (/) ACT
0x000001BA
Total replacement dose post delivered
Per 24 hour sliding window
443 IO_HIST_POST_REPL_DOSE_TOT: ml/kg/h (/) (/) ACT
0x000001BB
Total replacement dose post delivered, Includes the volume from
previous filter sets if the option Same Patient has been used,
selecting New Patient resets this value to 0.
444 IO_HIST_EFFL_1HR: 1ml (/) (/) ACT
0x000001BC
Total effluent volume
Per 1 hour sliding window
445 IO_HIST_EFFL_24HR: 1ml (/) (/) ACT
0x000001BD
Total effluent volume
Per 24 hour sliding window

AW8057 Rev A SEP2018 Page | 17


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
446 IO_HIST_EFFL_DOSE_1HR: ml/kg/h (/) (/) ACT
0x000001BE
Total effluent dose
Per 1 hour sliding window
447 IO_HIST_EFFL_DOSE_24HR: ml/kg/h (/) (/) ACT
0x000001BF
Total effluent dose
Per 24 hour sliding window
448 IO_HIST_PBP_1HR: 1ml (/) (/) ACT
0x000001C0
Total PBP volume
Per 1 hour sliding window
449 IO_HIST_PBP_24HR: 1ml (/) (/) ACT
0x000001C1
Total PBP volume
Per 24 hour sliding window
450 IO_HIST_DIAL_1HR: 1ml (/) (/) ACT
0x000001C2
Total dialysate volume
Per 1 hour sliding window
451 IO_HIST_DIAL_24: 1ml (/) (/) ACT
0x000001C3
Total dialysate volume
Per 24 hour sliding window
452 IO_HIST_TOT_REPL_1HR: 1ml (/) (/) ACT
0x000001C4
Total replacement volume
Per 1 hour sliding window
453 IO_HIST_TOT_REPL_24HR: 1ml (/) (/) ACT
0x000001C5
Total replacement volume
Per 24 hour sliding window
454 IO_HIST_TOT_REPL_TOT: 1ml (/) (/) ACT
0x000001C6
Total replacement volume from beginning of treatment, Includes
the volume from previous filter sets if the option Same Patient has
been used, Selecting New Patient resets this value to 0.
455 IO_HIST_SYRINGE_1HR: 1ml (/) (/) ACT
0x000001C7
Total syringe volume
Per 1 hour sliding window
456 IO_HIST_SYRINGE_24HR: 1ml (/) (/) ACT
0x000001C8
Total syringe volume
Per 24 hour sliding window
457 IO_HIST_NUMBER_OF_SETS_USED: 1set 10 0 ACT
0x000001C9
Total number of sets used in the current treatment
458 IO_HIST_PFR_1HR_PERIODIC_CHART: 1ml (/) (/) ACT
0x000001CA
Cumulative value for the current charting period. This value shall
be the same as the PFR value displayed on the History PFR
screen.
459 IO_HIST_PFR_24HR_PERIODIC_CHART: 1ml (/) (/) ACT
0x000001CB
Total value for the current treatment. This value shall be the same
as the Total value displayed on the History PFR screen.
460 POST_HCT: 1% (/) (/) ACT
0x000001CC
Post-filter Hematocrit
463 SERIAL_NUMBER: N/A 999999 0 SET
0x000001CF
PrisMax serial number
65536 PFR Makeup Enabled BOOLEAN 1 0 SET
0x0001_0000
65537 Auto Effluent Enabled BOOLEAN 1 0 SET
0x0001_0001
65538 Auto Effluent Drain Paused BOOLEAN 1 0 SET
0x0001_0002
65539 Auto Effluent Draining BOOLEAN 1 0 ACT
0x0001_0003
65540 Auto Liquid Level Enabled BOOLEAN 1 0 SET
0x0001_0004
65541 Blood Warmer In Use WARMER_ID 1 0 SET
0x0001_0005
65542 TherMax Temperature Setpoint 0.1 degree C 50 30 SET
0x0001_0006

AW8057 Rev A SEP2018 Page | 18


ID Name and Description Scale factor Max Min Type
Decimal (value of Val Val
Hex
LSB)
65543 Battery Charge Capacity 1% 100 0 ACT
0x0001_0007
65544 On Battery BOOLEAN 1 0 ACT
0x0001_0008
65545 HP-X Cartridge Type HPX_CART 5 0 SET
0x0001_0009
65546 Communication Version Number N/A (/) (/) SET
0x0001_000A
65547 System Time Offset Value 1 second (/) (/) ACT
0x0001_000B
65548 FILTRATION_FRACT_PLASMA: 1% 100 0 SET
0x0001_000C
Calculated Filtration fraction value for plasma

Legend and Notes


(*) Filter dependent value (See PrisMax Operator’s Manual)
(/) Value not useful

5.1.2 Enumerative Parameters


Table 5-4 Enumerative Parameters
ID Name Value Allowed Max Min Status Type
Val Val MSG
BOOLEAN 0 = False, 1 = True 1 0
THERAPY_ID 0 UNSPECIFIED 8 0
1 SCUF
2 CVVH
3 CVVHD
4 CVVHDF
5 RESERVED
6 RESERVED
7 HP
8 TPE
THERAPY_STATES 0 INITIAL 6 0

1 SETUP

2 PRIMING

3 ATTACH_PATIENT

4 TREATMENT

5 RETURN

6 END
296 NEXT_INTERV_ENUM: 0 effluent bag full 8 0 X ACT
0x00000128 Type of next intervention
1 replacement bag empty
2 dialysate bag empty
3 replacement 2 bag empty
4 pre-blood bag empty
5 suggestion to normalize BLD
6 time to change set cause of usage time
7 prescription delivered
8 syringe empty
409 ANTICOAG_METHOD: 0 UNSPECIFIED 5 0 SET
0x00000199 Anticoagulation method
selected by user 1 NONE

2 SYRINGE

3 CITRATE_BAG

4 CITRATE_BAG_CA_SYRINGE

5 CITRATE_BAG_CA_BAG
411 FILTRO: 0 UNSPECIFIED 18 0 SET
0x0000019B Selected disposable set
1 M60

2 M100

3 M150

4 ST60

5 ST100

6 ST150

AW8057 Rev A SEP2018 Page | 19


7 HF20

8 HF1000

9 HF1400

10 SEPTEX

11 OXIRIS

12 MARS

13 TPE1000

14 TPE2000

15 ADSORBA150

16 ADSORBA300

17 HPX

18 RESERVED
65545 HPX_CART 0 UNSPECIFIED 6 0 ACT
0x0001_0009
1 ADSORBA_150

2 ADSORBA_300

3 CUSTOM_1

4 CUSTOM_2

5 CUSTOM_3

6 PRISMALUNG
65548 FILT_FRACTION 0
0x0001_000C

65541 WARMER_ID 0 No warmer 4 0 ACT


0x0001_0005 1 Prismaflo IIS
2 Prismatherm II
3 Prismacomfort
4 TherMax

AW8057 Rev A SEP2018 Page | 20

You might also like