PeriData LINK MODE: The interface to the Electronical Medical Record

Last update: PeriData Version 3.7.1.0 (Jan.2023)

Change history

Change of 08-Nov-2022: The parameter /ANSI:C was deactivated. The function will be controlled by the option switch "Change Umlaut".
The parameter /ANSI:F was deactivated. It is not needed.

This document contains all details of the ONEPAT interface. A quick introduction you will find here: >Quick guide to the ONEPAT Link Mode >>

1. General remarks

If PeriData receives the commandline parameter /MODE:ONEPAT, it will work as a server for a client (the EMR program). In the "Link Mode", 1 patient is defined and a separate database will be used for this one patient. All newly imported data are directed to this database Behaviour during Link Mode >>

.

Data flow: PeriData gets patient information from the client. In the other direction, PeriData sends examination information to the client. Data exchange is handled with the parameters of the command line and with files. The specification is proprietory for PeriData.

2. Command line and Call

The parameters are mandatory. Between parameter name and value there must be a double point, but no space. The order of parameters on the command line is not important. The parameters are not case sensitive. The number of characters may not exceed 255 Bytes (including whitespaces).

If the commandline codepage (OEMCP) is 850 or 437, but the calling batch file was written with CP-1252, the line has to be converted to avoid strange characters. Switched the flag "Change Umlaut" in the PeriData options tp ON.
 


Command line parameter Meaning
/MODE: ONEPAT Mode=ONEPAT
/CLIENT: < Clientname > Clientname = Name of patient record program
/NAME: < Last Name > Last name (family name) of patient
/FIRSTNAME: < First Name > First name of patient (including titles)
/BORN: < Date of birth > Date of birth = ISO format: YYYYMMDD without dots
/FILE: < Filename > Filename = Filename with path of the PeriData database (PHF-file) of this patient
/READONLY Optional, locks the file (read-only)
/ANSI:F This option has been terminated with Version 3.7.0.8
/ANSI:C This option has been terminated with Version 3.7.0.8

Parameter /MODE

ONEPAT = PeriData starts in the ONEPAT LINK MODE

Parameter /CLIENT

The name of the client, meaning the name of the EMR software. This name appears in the PeriData program window in brackets.

Parameter /NAME

Last name of the patient. If the argument is given in quotation marks, spaces are possible. Otherwise, the name will be read incompletely. Underscores will be replaced by spaces after after the command line was analyzed. - Titles should be added to the first name or ignored, all other name extensions should be left with the last name.

Example (Monsignore Mario Di Caprio):
  /NAME:"Di Caprio" -- read: Di Caprio
  /NAME:Di Caprio -- read: Di
  /NAME:Di_Caprio -- read: Di Caprio

Parameter /FIRSTNAME

First name of the patient. Same rules for spaces like the last name. - Titles belong to the first name.

Example (Monsignore Mario Di Caprio):
  /FIRSTNAME:"Monsignore Mario" -- read: Monsignore Mario
  /FIRSTNAME:Monsignore Mario -- read: Monsignore
  /FIRSTNAME:Monsignore_Mario -- read: Monsignore Mario

NOTE: PeriData composes the entire name with a comma like "Di Caprio, Monsignore Mario". Due to technical reasons (database legacy), the entire name is truncated to 23 characters. For the example, this would mean "Di Caprio, Monsignore". Without the title, the name would be complete.

Parameter /BORN

Date of birth using the ISO format without dots: YYYYMMDD

Example (30-April-1967): 19670430

Parameter /FILE

Name of the database file (complete path + name + extension PHF) of the current patient. The path should exist. UNC paths are allowed. The file may be missing (if no visual fields had been stored up to now), an empty file will be created by PeriData. The file name should be patient-related. The unique patient ID in the EMR system serves well.

Example: /FILE:\\Server01\DATA\PeridataFiles\004312.PHF

Parameter /READONLY

(optional) The database file will be opened for reading only. Changes or data import is impossible.

Please note: The specified file in the /file parameter can also be locked by PeriData without using the /READONLY parameter. This happens automaticaly if the file is allready in use by another process !

Behaviour in case of multiple launch of PeriData on one PC

Peridata may be loaded by the client several times. There is always only one instance of PeriData in the memory. If the patient is changed in the patient record program, and PeriData is called again, PeriData will read the new command line parameters, closes all open database and opens the database of the new patient.

3. MES file from PeriData to the client (EMR software)

Write and delete: Each time when a new examination is imported into the patient database, PeriData writes a MES file. Import may be data received from a perimeter or data copied from another PeriData database. The directory is the folder of the patient database file (parameter /FILE). The names of the created files are continuous numbers (00000000.MES, 00000001.MES etc.) using the format 8.3. The client deletes the files after reading. Files which are not picked up for more than 1 day are deleted by PeriData.

Contents of the file: The MES file is a text file. The codepage is always ANSI-1252. The MES file contains only identifying data of the examination, no examination results.

The contents is given in lines terminated with <CR><LF>. Each line starts with a slash and a tag in capitals.


Line contents Details
/PROGRAM: PERIDATA       Information about the source program
/NAME:< Last name > Last name of the patient (as given by the client)
/FIRSTNAME:<First name> Title + first name of the patient
/BORN:< Date of birth > Date of birth (ISO Format: YYYYMMDD without dots)
/FILE:< Filename > Name of PeriData data file (PHF file) WITHOUT path - may contain the patient number
/DATE:<Date of exam> Date of the examination (ISO format: YYYYMMDD without dots)
/TIME:<Time of exam> Time of exam (Format: HHMM)
/EYE:<Eye under exam> the examined eye (Latin format: OD / OS)
/EXAM:<Examination info> Information about the exam (Format: <Eye>: <Instrumentt> <Examination program> [30-50 char])

(Example OD: HFA2 CENTRAL 30-2 THRESHOLD TEST)

/INDICES:  *optional* Exam result (Indices)

(Example: MD: -10.2 DB / FD: -77 % / PSD: 5.2 DB)

/RELIABILITY:  *optional* Exam result (Reliability values)

(Example: FIXLOSS 0% / FPOS 6% / FNEG 0%)

Example of a MES file:

/PROGRAM: PERIDATA
/NAME: Di_Caprio
/FIRSTNAME: Monsignore_Mario
/BORN: 19670430
/FILE: C:\TEMP\TEMP.PHF
/DATE: 19991127
/TIME: 1142
/EYE: OD

/EXAM: OD: HFA2 CENTRAL 30-2 THRESHOLD TEST
/INDICES: MD: -10.2 DB / FD: -77 % / PSD: 5.2 DB
/RELIABILITY: FIXLOSS 0% / FPOS 6% / FNEG 0%

4. Command line parameter /COMMAND (independent of Link mode)

If the PeriData program is running, a repeated CALL of PeriData with the parameter /COMMAND allows to send several control commands to the app. The instance is preserved (except with CLOSE_APP).

The parameter /COMMAND has priority to all other parameters. They are all ignored.

If PeriData is not running, the CALL has no effect. PeriData is not started


Command line parameter Details
/COMMAND:CLOSE_APP Terminates the application
/COMMAND:POPUP_APP Put the main window in front of other windows (does not work with some Windows versions
/COMMAND:CLOSE_WND Closes all data windows, the program window remains open
/COMMAND:CLOSE_PAT Closes all data windows and terminates the link mode, the program window remains open