888 tcpip protocol manual 100217

1

Patient label and Test tube preparation system

BC ROBO-888

TCP/IP Interface Protocol Manual

Version 2

2

INTRODUCTION .................................................................................................................. 3

1. TCP/IP connection .......................................................................................................... 3

2.DATA FLOW ...................................................................................................................... 4

2.1 Normal case ............................................................................................................... 4

2.2 Error case ................................................................................................................... 5

2.2.1 Wrong data received ........................................................................................... 5

2.2.1 Time out or open wire ......................................................................................... 5

3. DETAILS OF TEXT FORMAT ........................................................................................... 6

3.1 LITX and EPTX ........................................................................................................... 6

3.2 DATA STRING FORMAT............................................................................................. 7

3.3 MANDATORY CODE DETAILS .................................................................................. 8

4. SAMPLE OF DATA STRING ............................................................................................ 9

3

INTRODUCTION

This manual describes the interface protocol between BC ROBO-888 and LIS/HIS.

It includes connection details, data flow and data string.

Read this manual carefully beforehand of BC ROBO interfacing and feel free to contact Techno

Medica(hereinafter TMC) if you have any further questions.

1. TCP/IP connection

1) TMC’s coverage

TMC

2) Connection : TCP/IP

3) Transmission Control Code : ASCII

4) TEXT Format : One label = One data string

All the data string must have the same format and should have

CR(Carriage return) at the end.

5) Data string length : All of the string should be the Fix length. Variable length is NG.

6) EPTX : Refer to chapter 3.

Note:

Ensure that “EPTX” is not ETX. “EPTX” is a unique data string dedicated for BC ROBO.

7) Retry interval : More than three seconds

8) Port number : Assigned by LIS/HIS vender.

BC ROBO (as server) LIS/HIS (as client)

4

2.DATA FLOW

2.1 Normal case

BC ROBO(as server) LIS/HIS(as client)

Listen Connection

Establish connection

Bind session

Session bind request

Accept

Session bind permission

Receive data Send data LITX of 1st patient 1st label incl CR(Carriage return)

Data confirmed

00:ACK + CR

Receive data Send data LITX of 1st patient 2nd label incl CR(Carriage return)

Data confirmed

00:ACK + CR

Receive data Send data

EPTX of 1st patient incl CR(Carriage return)

Data confirmed

00:ACK +CR

Terminate session

Session terminate request Close Close

The flow of message is below.

1. When Server is powered ON, it observes the connection of the client. In case client

requires connection, the server returns the session bind permission.

2. When the sever received LITX from the client, it returns ACK (00)

3. When the sever received EPTX from the client, it returns ACK (00)

4. Repeat the cycle of above step 2 and 3.

5. The client sends the session terminate request.

5

2.2 Error case

2.2.1 Wrong data received



LITX or EPTX

Return error message

10:NACK + CR

2.2.1 Time out or open wire



LITX or EPTX

Return error message

10:NACK + CR

Note:

Ensure to send CR(Carriage return) at the end for both ACK and NACK.

6

3. DETAILS OF TEXT FORMAT

3.1 LITX and EPTX

Data strings for one patient must include 2kinds of data strings. These are called “LITX” and

“EPTX”. ROBO identifies them by message header. If message header is “0”, it is identified as

LITX. If message header is 9, it is identified as “EPTX”.

“LITX” decides the letters/symbols to be printed on the barcode labels.

A number of “LITX” equals to a number of barcode labels.

“EPTX” orders the BC ROBO to change the tray.

For instance, if four tubes and one extra label is need, client should send five LITX and one EPTX.

Note:

• If client forget to send “EPTX”, tubes and extra labels for the different patient will be

contained into the same tray.

• All of the data strings must have the same format and length.

• Worklist label will be automatically generated from the group of LITX.

Sample of “LITX”

0 PatientID00000000000 Patientname0000000000000000000 1 Order#

Sample of “EPTX”

In below sample, you can just copy the LITX and change the message header to “9”.

9 PatientID00000000000 Patientname0000000000000000000 1 Order#

or

In below sample, message header is “9” and other field should be “space”.

9

7

3.2 DATA STRING FORMAT

Below is TMC recommended standard. If HIS/LIS has a difficulty in sending some element name,

contact to TMC for further information.

SEQ Element name Length Mandatory? Character

type Comment

1 Message header 1 YES Numeric 0: LITX 9: EPTX

2 Patient ID 20 YES Alphanumeric

3 Patient Name 30 YES Any kind

4 I/O code 1 YES Numeric 1: Outpatient 2: Inpatient

5 Order location code 6 STATISTIC* Alphanumeric “000000” if not in use

6 Order placed location 20 STATISTIC* Any kind Space available if not in use

7 Ward code 6 YES Alphanumeric “000000” if not in use

8 Ward name 20 STATISTIC* Any kind Space available if not in use

9 Barcode 20 YES Alphanumeric Including start stop code

10 Container code 3 YES Numeric

11 Container name 20

NO

Any kind

12 Sex 1 Alphabet M=Male F=Female

13 Free comment 1 20

Any kind










Note:

• STATISTIC*: This is for statistic report purpose. BC ROBO has a function to display and archive

statistic report.

• All character should be left aligned.

8

3.3 MANDATORY CODE DETAILS

Mandatory code is a MUST element name to be sent to BC ROBO no matter whether they should

print on the label or not. However, some of them could be supported by using “0” or “Space” if

HIS/LIS has a difficulty in creating such element name.

SEQ Element name Length Comment

1 Message header 1 If data string is LITX, use “0”. If data string is EPTX, use “9”

2 Patient ID 20 Patient ID to be printed on the label.

3 Patient Name 30 Patient Name to be printed on the label.

4

I/O code 1

If LITX is for outpatient, use “1”. Output will be horizontal line of

BC ROBO.

If LITX is for inpatient, use “2”. Output will be vertical line of BC

ROBO.

5

Order location code 6

Order may be placed from particular location. Enter location code.

Such information is useful to calculate how many orders were placed

from the each location. If you are not using statistic report function,

use “000000” as a dummy code.

6

Order placed location 20

Order may be placed from particular location. Enter location name.

Such information is useful to calculate how many orders were placed

from the each location. If you are not using statistic report function,

use “Space” as a dummy code.

7 Ward code 6

ROBO can sort inpatient data by ward code. If you do not use BC

ROBO for inpatient, use “000000” as a dummy code.

8

Ward name 20

Ward name is useful to calculate how many orders were placed to the

each ward. If you are not using statistic report function, use

“Space” as a dummy code.

9 Barcode 20

Barcode to be printed on the label. Barcode type is programmable by

BC ROBO software. Ensure to enter start stop code.

10

Container code 3

BC ROBO chooses the correct tube according to the container code.

If assignment of container code is wrong, BC ROBO may choose the

wrong tube or nothing.

ie) 12mm diameter 100mm length Gel tube = Container code 123

12mm diameter 75mm length EDTA tube = Container code 124

9

4. SAMPLE OF DATA STRING

Below is the sample of LITX if you want to use full function of BC ROBO including statistic report.

0PATIENTID PATIENTNAME 1ORDERL

INTERNAL MEDICINE WARDCOWARDNAME a12345678a

013M CR

Below is the sample of LITX if you use BC ROBO without using statistic report.

0PATIENTID PATIENTNAME 1000000

000000 a12345678a 013M CR

Note:

• Underline stands for “Space”.

888 tcpip protocol manual 100217

Documents