Manufacturer:

OPTOPOL Technology Sp. z o.o.

ul. Żabia 42
42-400 Zawiercie
POLAND
www.optopol.com
info@optopol.com.pl

CMDL interface in SOCT Software

SOCT Software Version 10.0.0 or later

Document revision A

0197
Copyright

© 2021 OPTOPOL Technology Sp. z o.o. All rights reserved.

CMDL interface in SOCT Software Revision C

Date of issue of manual: March 2021

Date of review: March 2021

SOCT is a registered trademark of OPTOPOL Technology. All other trademarks or registered

trademarks mentioned herein are used for identification purposes only and may be trademarks or
registered trademarks of their respective companies. All contents in this document are protected by
copyright. Except as specifically permitted herein, no portion of the information on this web site may
be reproduced in any form, or by any means, without prior written permission from OPTOPOL
Technology. It is not permitted to modify, distribute, publish, transmit or create derivative works of
any material found in this document for any public or commercial purposes.

For Technical Service contact your authorized dealer of OPTOPOL Technology Sp. z o.o. Contact
details are available on www.optopol.com

CMDL interface SOCT Software revision A 2021 03 03

2
Table of contents
Command Line (CMDL)............................................................................................................................ 4
SOCT application modes controlled by CMDL ......................................................................................... 4
Running application with logged user via CMDL interface ..................................................................... 4
Running application with transferring patients data via CMDL interface ............................................... 5
The Work List in CMDL mode .............................................................................................................. 5
Conducting the examination ............................................................................................................... 5
Patient information transferred through CMDL ................................................................................. 6
Patient data transferred through the interface CMDL:................................................................... 6
Examination order for the awaiting patient. ................................................................................... 7
The Running application by CMDL and transferring patient data by a .in file ........................................ 8
Assumption for external applications: .......................................................................................... 10
Set as active patient on the patients list with specified PATIENT NUMBER ‘–ref’ ........................ 10
Closing SOCT application after setting patient on the WORKLIST................................................. 10
SOCT application settings in CMDL mode ............................................................................................. 11
Activation of CMDL mode ............................................................................................................. 11
Output of the examination results .................................................................................................... 12
Export data to EMR server ............................................................................................................ 12
Edit the default profile Export to EMR .......................................................................................... 12
Profile parameters ......................................................................................................................... 12
Output date when .in file was used .............................................................................................. 13

CMDL interface SOCT Software revision A 2021 03 03

3
Description of CMDL protocol

This document describes the communication protocol of the external application with the SOCT
software version 10.0.0 or later. SOCT software is used to control REVO NX, REVO FC SOCT
Copernicus REVO devices. DICOM communication standard is described in another document.

SOCT software is designed as an independent system to control the Spectral Tomographer devices
and manage the patient/examination data. Additionally it is equipped with data exchange interfaces
to cooperate with external applications and EMR systems.

SOCT application can fulfill the following tasks basing on data exchange interface:

• register the patient data in the working list

• register the patient data in local database
• register the patient and open Acquire tab
• display on the screen the results of the given examination belonging to the given patient
• perform the examination according to the given setup for the given patient
• generate the output files as report, single tomogram or series of tomograms for the newly
performed examination or for the given historical examination.

SOCT application modes controlled by CMDL

1. Running application with logged user via CMDL interface.

2. Running application with transferring patients parameters via CMDL interface.

3. Running application via CMDL and transferring patients data via file .in, out.

Running application with logged user via CMDL interface

The mode with logged user via CMDL allows to run application with simultaneous logged user. In
this mode, the application opens the "PATIENT" tab. The operator login screen is omitted. In this
mode, the software offers full functionality. The output is sent to the predefined location
triggered by the user (e.g. at the moment of report).

The software runs only with parameters: ‘-u’ i ‘-p’.

Login should be specified after the parameter ‘-u’ (with space), user password should be specified
after ‘-p’ (with space).

Example: main.exe –u USERNAME –p USERPASSWORD

User login data created in the SOCT application are used for log in.
User name and password have to be the same as are in the SOCT application.
User login information is available in the SOCT application in the SETUP \ Users tab.
User login has to be used in other application modes.

NOTE: It is obligatory to login to SOCT application sending –u and –p parameters.

CMDL interface SOCT Software revision A 2021 03 03

4
Running application with transferring patients data via CMDL
interface

The mode allows to register patients on the one day worklist. You can send an examination
request together with patient data. The external application thanks sending login and password
launching SOCT application without typing by operator the user's login details.

User login and password in the command line is obligatory.

Transferred patients data appear in the SOCT application on the WORKLIST tab. Worklist tab
Appears next to the patient list.

The operator can starts the examination without finding or registering a new patient. If the
examination details is requested the soct will loading eye`s data, type of protocol or
examination.

The Work List in CMDL mode

The Work List is a temporary list of records of patients order to perform OCT exam. The Work
List displays records received from external software. Work List is stored in the SOCT application
until the end of the day (23:59). Closing and opening SOCT application in the same day doesn’t
reset WorkList. The WorkList is cleaned the next day, during first SOCT application start.

WORKLIST is created when CMDL interface is activated. WORKLIST contains the following
headings:
Status (patient status)
Patient identification number (Patient ID)
Patient Name (Last Name and Patient Name)
Date of birth (DOB)
Requested eye (Requested eye)
Required examination protocol (Requested protocol)
Required type of examination (Requested examinations)

the Status column displays internal information of the SOCT application and is visible only for
the operator. Available statuses:

Awaiting: before examination,

Completed: when at least one examination was acquired,
Discontinued: If the ‘ACQUIRE’ tab was open but any examination was not acquired.

Conducting the examination

The user selects manually the patient’s record on the Work List tab. Patients Filter is available for
easier patient search.

CMDL interface SOCT Software revision A 2021 03 03

5
 Ime

Image 1: Opened work List tab on the Patient screen.

For conducting new examination the user selects examination tab or double clicks on the patient
record. Before opening Acquire tab SOCT application finds requested patient or crates new
patient in the database based on the received data. If the parameters of examination have been
transferred with patient's demographic data, the software will load a new examination and set
the head across the patient`s eye.

Patient information transferred through CMDL

Patient data transferred through the interface CMDL:

NOTE: All Below data are obligatory

‘-lname’ Last name (Last name),

‘-fname’ First name (First name),
‘-yyyy’ Year of DOB (Year of DOB),
‘-mm’ Month of DOB (Month of DOB),
‘-dd’ Day of DOB (Day of DOB),
‘-ref’ Patient’s ID (Unique Patient’s ID).

Example: main.exe –ref 12121955123456 -lname Doe -fname John -yyyy 1993 -mm 09 -dd 06 –u
dr.Queen –p USERPASS

in the above mentioned case SOCT application will be launched on the „dr.Queen” user and the
patient John Brown, born on 05/09/1971 with ID 12121955123456 will be placed on the Work List.

If the SOCT application is closed it will open in the Patient tab.

CMDL interface SOCT Software revision A 2021 03 03

6
 If the SOCT application is continuously running, the patient record will be placed on the Work List,
and the application remains in current state.

NOTE: It is not allowed to send patient data without unique ID number (-ref)

Examination order for the awaiting patient.

SOCT application is able to receive orders to performed specific types of examinations. When the
CMDL interface receives the order, the information is displays on the Work list tab. When ACQUIRE
tab is open the SOCT software activates appropriate type of exam or protocol of examinations and
move the scanning head across desired eye.

Examinations parameters used by the CMDL interface:

‘-eye_code’ – possible values: Right=0, Left=1, Both=2,

If the parameter is given the application opens „ ACQUIRE” tab and sets the head on the indicated
eye. If parameter Both was indicated System activates OU mode „ both eyes” and the head sets on
the eye by setup settings. The last eye examined is selected as default .

‘-exam_area’ – possible parameters Retina=1, Disc=2, Central=3, Anterior=4, Anterior Wide=5,

Biometry=6.
It is recommended to specify „exam_type” parameter with „exa, type” parameter

‘-exam_type’ – possible values 3D=1, B-scan=2, Raster=3, Cross=4, Radial=5, Angio=6, Topo=7,
AL=8, ACD=9, Fundus Photo=10,
Exam_type parameter cannot be passed without – exam_area parameter

‘-exam_flags’ – Full Range=2

‘-protocol’ Name of protocol – Name of the protocol has to be compatible with names of protocols
created in SOCT software – giving the parameter runs proper protocol. Predefined default
protocols: Retina, Screening, Glaucoma

main.exe –ref 12121955123456 -lname Brown -fname John -yyyy 1971 -mm 09 -dd 05 –u dr.Queen
–p USERPASS –eye_code 1 -protocol Glaucoma

Table with Exam types in SOCT ver. 10.0.x

Retina Disc Central Anterior Anterior Wide Biometry

3D 3D 3D 3D 3D AL.
B-scan Raster B-scan B-scan B-scan ACD
Raster Radial Raster Raster Raster
Radial Angio Radial Radial Radial
Cross Cross
Angio Angio
Fundus Photo Fundus Photo Fundus Photo

CMDL interface SOCT Software revision A 2021 03 03

7
The Running application by CMDL and transferring patient data
by a .in file

External software can run SOCT application, transfer patient data by saving it in the .in file in
specified location and automatically open the bookmark “ACQUIRE”.
SOCT application is reading the patients parameters from the .in file. Information about the
location .in file should be given in the CMDL command.
Patient data (report, series of tomogram or tomogram) can be output to the destination identify
by .in file.

To call again SOCT application in CMDL .in file mode, SOCT application must be prior closed.

When Output path is identify in the program.

Example: C:\Program Files\Optopol\main.exe –u dr.Queen –p USERPASS \\bufer\Input\

454332.IN

In that mode the SOCT software loads patient data from given file .IN and go to the “ACQUIRE”
bookmark.

.in file has to have unique name (e.g. Visit ID), e.g.”454332.IN”

Sample file structure .IN:

patient]

patient_id=000

patient_family_name=Doe

patient_given_name=John

patient_birth_date=19930906

patient_sex=M

patient_address=Zabia 42 42-480 Zawiercie \\Since SOCT version 7.2.1 this record is displayed as
patient remarks and will be visible on the printout)

patient_country=POLAND \\Value is added to remarks record

patient_phone_numbers=+48326213271\\value is added to remarks record

[dirs]

study_dir=C:\export\ \\output folder where data will be output

[command]

command_line=26

If there is command ‘command_line=26’ in .IN file application SOCT provides full functionality of
the software.
CMDL interface SOCT Software revision A 2021 03 03
8
 If the parameter ‘command_line=26’ is having different value the user has full functionality of
analyses and measurements only for indicated patient. In this case, there is no possibility to change
to another patient, review the results of other patients, edit and add a new patient.

Notes to data in the file .IN:

Required fields are: unique patient’s id, Family name, Patient’s given name, patient birth date
Remaining section data [patient] are optional.

Record names are compatible with the previous interface, so the data from the address record are
entered into remarks field in SOCT application.IN files should have unique name (e.g. with XXX
extension, starting from 000) to folder that is set in the IN file.

File with the XXX extension will have the same name as used in .IN file. Its structure will look like the
shown below:

[patient]

patient_id=000

patient_family_name=Doe

patient_given_name=John

patient_birth_date=19930906

patient_sex=M

patient_address=Zabia 42 42-480 Zawiercie

patient_country=POLAND

patient_phone_numbers=+48326213271

[dirs]

study_dir=C:\export\

[command]

command_line=26

[study]

study_date=20170305

study_time=144721

laterality=L

[exam]

patient_id=000

fname=000_Doe_John_20170305_144721_Retina_3D_L_SINGLE_7mm_640x85.bmp

CMDL interface SOCT Software revision A 2021 03 03

9
Assumption for external applications:
External application monitors the “study_dir” directory indicated in .in file. When in that directory
output file will be given in a graphic format with .outfile the files are ready to be picked up.

After pressing [Output] and selecting ‘Export to EMR’ system will save the content e.g. Report (type
of data can by chosen by user in Output sets) to the INI file (with XXX extension, starting from 000) to
the directory specified in the IN file.

„File with XXX extension will have the same name as .IN file. Output file structure:

{file content 454332.IN}

[exam]

fname=plik.BMP (unique name of file)"

Data according to output set definition: BMP file.

Set as active patient on the patients list with specified PATIENT NUMBER ‘–ref’

SOCT application can set active patient on the Patients List. That function allows for quick call of
the application, quick setting of active patient on the Patients List. For sending, it is necessary to
send ‘-ref’ parameter.

Example: main.exe -ref 12341234 –u dr.Queen –p USERPASS

‘-ref’ parameter
In that case patient with parameter „PATIENT NUMBER” will be set as active. When there is no
suitable patient you will receive following message „Patient with Patient ID:12341234 was not
found”

'-reg' - if the parameter is passed, the application is launched or called and the given patient is active
(found and selected) on the Patients List. The user decides what to do next - perform the test or
view the results, if available. Obligatory is to passed id.

You need to pass with Name, lastName, DOB.

Closing SOCT application after setting patient on the WORKLIST

If parameter ‘-q’ was used after setting patient on the WORKLIST the application will be closed.

Example: main.exe -lname Nowak -fname Jan -yyyy 1971 -mm 09 -dd 05 -reg –q

CMDL interface SOCT Software revision A 2021 03 03

10
SOCT application settings in CMDL mode

Activation of CMDL mode

To start CMDL communication in SOCT application please tick in the SOCT Settings \ bookmark
“Preferences”/checkbox „Command line interface from different application instances”. (Figure
below).

Image 2: Preference tab

Checking of „Command Line Interface” causes:

- appearance of the WorkList tab next to the patient list. For CMDL with transfer .IN file Worklist tab
does not appear.
- create results export profile „Export to EMR” in function „OUTPUT” (“Save as”).

In SOCT application in CMDL mode the following types of exam are available:
Anterior Wide Retina Anterior Disc Central
3D 3D 3D 3D 3D
B-scan B-scan B-scan Raster B-scan
Raster Raster Raster Radial Raster
Radial Radial Radial Angio
Cross
Angio

CMDL interface SOCT Software revision A 2021 03 03

11
Output of the examination results
When CMDL interface is used operator triggers export data process to location specified in Output
set. In can be a local or network path.

Export data to EMR server

„Export to EMR” profile allows to save the examination results to the specified location. SOCT
application creates by default ‘EXPORT TO EMR’ profile.

Name of the recording scheme: Export to EMR;

Set Name – Export to EMR
Output contents – Report
Output type – BMP file
Output folder – C:\EMR Output
Folder creation – Create Study date folder
Automatic Output – When printing

Edit the default profile Export to EMR

User can edit any parameter of the recording scheme with the exception of its name. Access to
configuration Setup\Preferences\Output setting. To configure profile select “Export to EMR” on the
list and press [Edit].

Recording scheme „Export to EMR” is on the highest position in the list. User can change default
position on the list.

When CMDL mode is activated (selected checkbox in the setup) you cannot delete Export to EMR
profile from the list.

For CMDL with .in file the Output Folder can be specified inside .in file.

Note: It is possible to create few outputs sets. External aplicaiton can monitor specified in Output set
output location and pick up any type of exported data.

Profile parameters
Available options.

Output contents Report, Current Tomogram, Tomogram series, Report + Tomograms;

Output type: BMP, PNG, PDF, JPEG, DICOM;
Output folder: You can specify any local or network path;
Folder creation: Create Study date folder (Examinations are saved to the folder with
examination date;
Output date (Exported data are placed in the folder with saving date);
No create;
Automatic Output When printing – the data are saved when you press print;
No – User manually press [Output] and choose Export to EMR profile and
confirm OK;
After capture

Folder and filenames (Output file name and subfolder name)

CMDL interface SOCT Software revision A 2021 03 03
12
Output tomogram - file Name
Name of output files consists information about patient and examinantion.

Tomogram
File names: AAA_BBB_CCC_ C1C1C1_DDD_EEE_Lmm_X0_scan.no.xxx
AAA: Patient ID
BBB: Patient Name
CCC: Exam date (yyyymmdd)
C1C1C1: Exam time (hhmmss)
DDD: Scan mode name (3D Retina, Angio Retina, 3D Disc, Angio Disc,)
EEE: Right, left eye or Both (L,R,OU)
Lmm: Length of scan
X0: Number of A_scan_Number x B-scan x No of averaging
Scan.no.: Number of selected scan
xxx: Extension (jpg, bmp, png, avi or dcm)
Example:
123456_John_Smith_2016.09.01_15.30.30_ Angio Retina_R_7mm_200x300_scan2.jpg

Output Report – file name

Report
File name: AAA_BBB_CCC_DDD_EEE_FFF_Lmm_X0.xxx
000_Doe_John_20170305_144721_Retina_3D_L_SINGLE_7mm_640x85.xxx
FFF: View mode name (Single, Both, Comparison, Progression, 3D, Advance)
Example:000_Doe_John_20170305_144721_Retina_3D_L_SINGLE_7mm_640x85.bmp

Output Series sub-folder name

Output folder name for whole output set of data is defined in section [Folder Creation] in Add output
set
In case when series of tomograms are exported to graphic file, subfolder for each examination is
created.
Subfolder name for each examination: AAA_BBB_CCC_ C1C1C1_DDD_EEE_Lmm_X0
example
000_Doe_John_20170305_144721_Retina_3D_L_7mm_640x852009.01.20_14.27.42_L_Retina_3D_
5mm_743 x 50
File in subfolder has the name as described in Output tomogram - file Name

Output date when .in file was used

When in .IN file in the section [Dirs] a directory is listed where the examination is saved, the
examination is saved there without additional subdirectories. If there is no directory in .IN file the
examination is saved in the location given in configuration of Output. Subdirectories are created
according to the Output settings.

If after 'Export to EMR' there is no access path in .IN file, report bmp file is saved in directory set in
Setup and creates *.000.

[dirs]

study_dir=C:\export\

[command]
CMDL interface SOCT Software revision A 2021 03 03
13
command_line=26
[study]
study_date=20170305
study_time=144721
laterality=L
[exam]
patient_id=000
fname=000_Doe_John_20170305_144721_Retina_3D_L_SINGLE_7mm_640x85.bmp

Export data by user

Manual saving in electronic medical record (EMR) is available, by clicking [OUTPUT] which is next to
[PRINT] button.

After pressing button [Output] you will see window with output scheme.

When operator clicks „Export to EMR” button the system will save the report to the file.
If the option „When printing” is selected the system outputs data in the moment when user presses
[Print] button.

It is possible to create 10 Output profiles in the SOCT application. The external application can capture
data from any profiles.

CMDL interface SOCT Software revision A 2021 03 03

14