[OnyxCeph³™ Wiki]

DokuWiki - World Wide Web

User Tools

Site Tools


en:cli

Command Line Interface


Note
For PMS integration, OnyxCeph³™ supports the VDDS-media interface. For detailed information abou this interface, see www.vdds.org

Handing over patient data to OnyxCeph³™ is done by launching OnyxCeph.exe with specific command line parameters. There are two ways to hand over patient data: by command line parameters or by an INI text file. Tags are used in both cases. Following you will find a survey of the tags supported:

1. Patient Data Tags

Mandatory Parameters
PatID Unique ID, up to 50 Characters
If "<CLEAR>" is passed¹, the current patient is closed
Firstname
Lastname
Birthday Birthday in date format²
Sex Format: "M" for Male and "F" for Female "I" oder "D" for Intersexual (or Diverse)
Optional Parameters
MiddleName
PreferedName
Title
Race
City
State
Street
Street2
Doctor
Email
Cellular
HomePhone
WorkPhone
PatTags Patient keywords (separated by ";")
"PatMarker" Modify markers on patient tab: 5 chars: "1" set marker "0" reset marker "-" no change
"InsuranceID" Number/ID of health insurance
"Salutation"
ContactDate Contact date in date format²
ModellNr Additional cast ID
Notes Notes about the patient, If "<CLEAR>" is passed¹, the existing text is deleted


¹ As command line parameter "<CLEAR>" always in quotation marks.
² Format: YYYYMMDD, e.g. "20090530" or YYYY-MM-DD, e.g. "2009-05-30" or "Short Date" from Windows e.g. MM/DD/YYYY → "05/30/2009".

2. Image Data Tags

In addition, image files can be handed over to OnyxCeph's image acquisition. Supported image formats are BMP, TIF, JPG, GIF, CMP, PNG, PCX, IMG, DICOM and others.
In order to ensure correct image-to-patient assignment, at least parameter Patient ID needs to be handed over by tag PatID described above. Submitting additional information by optional tags is also possible.
To hand over 2D images to OnyxCeph³™, the following tags can be used:

PicCount Number of images to be transfered
PicErase "Y" or "1" OnyxCeph³ deletes the files after saving
"N" or "0" (Default) OnyxCeph³ doesn't delete the files
PicPath# Full Path oft the Image File #¹
PicInfo# Additional Information, Just Like Tags, Comments, etc.
PicTags# Keywords Concerning the Image (Separated by ";")
PicDate# Format: YYYYMMDD, e.g. "20090530" or
YYYY-MM-DD, e.g. "2009-05-30" or
"Short Date"-Format from Windows or
Date and Time of Aquisition, Format: YYYYMMDDHHMMSS
PicTypeCode# Code of the image type of the image

¹ # will be replaced the image number starting with 1; e.g. the first entry is -PicPath="C:\tmp\img.jpg"

3. Transfer by Command Line Parameters

If patient and image data is transferred via command line parameters the file OnyxCeph.exe is started with the tags and followed by the values as command line. Any value should be formatted as follows

-Tag="Value"

Empty space between multiple tags is required - find some examples in topic 6.

4. Transfer via HTTP

If the HTTP Interface is active in OnyxCeph³ master data can also be transferrred to OnyxCeph³ via HTTP requests.
OnyxCeph³ operates as HTTP server and serves the configured port. In case the checkbox Only Local is activated (Standard) only access from IP 127.0.0.1 is allowed.

Server:Port/SetPat -Tag="Value" -Tag="Value" …

If no space character is in Value the quotation marks can be omitted.

Please note that some characters in URLs are not valid and must be "escaped".
For example, instead of the space character %20 and instead of the backslash \, the character string %5C must be passed.
See also: https://en.wikipedia.org/wiki/URL-Encoding

5. Transfer by Text File

For this purpose, a text file in INI format has to be provided. The file has to contain a [PatDat] section. Patient and image data can be defined under this section using the tags described above.
In order to hand over data, OnyxCeph.exe has to be launched with parameters -PatID and -Data. Parameter -Data= should define the folder path where the INI file is located. OnyxCeph³™ doublechecks if the used patient ID is identical to the INI file -PatID parameter. Only if so, provided data will be handed over.

6. Transfer via DICOM File

A DICOM file includes patient data as well as image data. If name and path of a DICOM file is handed over after the command line parameters:

-DICOM="File Name"

then the patient's master data is compared and the image is opened in module Add Imag 2D.
Parameter -PicErase (see above) is also supported unterstützt.

All other parameters are ignored and do not have to be handed over.

7. Import of .O3C-Containers

An .O3C-container-file comprises patient data as well as image data. It may include data of several patients. If the path of the container-file is transferred after the command line parameter:

-ContainerFile="File Name"

the patient's master data and image data is compared. For this purpose the import dialog opens. If the container was uploaded to an FTP-server the key can be transferred via command line parameter ContainerFTP:

-ContainerFTP="C5UW5SJNN3….B6DKHUWUQKD73"

The command line parameter ContainerNote allows handing over of a string that can be attached to the comment of the images adopted:

-ContainerNote="Auftrag #0-8-15"

After import OnyxCeph³ automatically opens the respective client and patient.
All other parameters are ignored and do not have to be handed over.

8. Starting Module in OnyxCeph³™

The parameters ActionBefore and ActionAfter allow starting of specific modules. At present starting the following modules is supported (will be extended):

ActionBefore ((prior to master data compariso)

Copy patient: -ActionBefore="CLONEPATIENT:123" -PatID="123New"

ActionAfter (after master data comparison or container import)

Presentation template: -ActionAfter="PRESENTATION:TemplateName"


9. Detecting OnyxCeph.exe

The command line interfaces needs to address the location of the executable OnyxCeph.exe. The default location for this program file is:

 <Program Files>\Image Instruments\Onyx3Client\OnyxCeph.exe

Since this location could be changed during setup or later, it beter should be read from the local registry. Search for the following registry key:

 HKEY_LOCAL_MACHINE\SOFTWARE\Image Instruments\OnyxCeph\Install Path

to find out where the executable is located.

10. Examples

a. Searching the Registry Key

 HKEY_LOCAL_MACHINE\SOFTWARE\Image Instruments\OnyxCeph\Install Path

The Value may be e.g. "C:\Program Files\Image Instruments\Onyx3Client\"

b. Creation of a new patient record:

 "C:\Program Files\Image Instruments\Onyx3Client\OnyxCeph.exe" -PatId="123" -Firstname="Test" -Lastname="Patient" -Birthday="19960313" -Sex="F" -PatMarker=-1---

c. Assigning 2 images to an existing patient record:

 "C:\Program Files\Image Instruments\Onyx3Client\OnyxCeph.exe" -PatId="123" -PicCount=2 -PicPath1="C:\temp\XRay.tif" -PicPath2="C:\My Images\Foto.jpg"

d. Transfer of two STL-files for a known patient, delete files after import:

 "C:\Programme\Image Instruments\Onyx3Client\OnyxCeph.exe" -PatId="123" -PicErase=1 -PicCount=2 -PicPath1="C:\scan\OK.stl" -PicPath2="C:\scan\UK.stl"
 

e. Performing b. and c. in one step:

Source files are to be deleted after images are saved to the database:

 "C:\Program Files\Image Instruments\Onyx3Client\OnyxCeph.exe" -PatId="123" -Firstname="Test" -Lastname="Patient" -Birthday="19960313" -Sex="F" -Title="Dr. med. dent." -City="Chemnitz" -PicCount=2 -PicErase=1 -PicPath1="C:\temp\XRay.tif" -PicInfo1="Lateral Ceph" -PicDate1="20000815" -PicPath2="C:\My  Images\Foto.jpg" -PicInfo2="Lateral Foto" -PicDate2="20000814"

f. Opening of a patient via HTTP and updating the name:

Opens patient 123 and updates master data when indicate

 http://127.0.0.1:24000/setpat -PatId="123" -Firstname="Test" -Lastname="Patient"

Birthday="19960313" PatMarker=”-1—”

g. Opening of a patient and presentation template via HTTP

Opens patient 123 and after that the presentation template Onyx_Images_8

 http://127.0.0.1:24000/setpat -PatId=123 -ActionAfter="Presentation:Onyx_Images_8"

h. Copying of a patient via HTTP

Copies the patient 123 inclusive of all images. The copy gets the new patient ID 123New and is renamed to "Test Patient"

 http://127.0.0.1:24000/setpat -ActionBefore="ClonePatient:123" -PatID="123Neu"

-Firstname="Test" -Lastname="Patient"

i. Using INI file: First, the INI file has to be created (e.g. C:\Temp\MyPatientData.INI):

MyPatientData.ini:

 [PatDat]
 PatId=123
 Firstname=Test 
 Lastname=Patient 
 Birthday=19960313 
 Sex=F
 Title=Dr. med. dent.
 City=Chemnitz 
 PicCount=1 
 PicPath1=C:\temp\XRay.tif 
 PicInfo1=Lateral Ceph
 PicDate1=20000815 

Launch OnyxCeph³™ with the following command line parameters:

 "C:\Program Files\Image Instruments\Onyx3Client\OnyxCeph.exe" -PatId="123" -Data="C:\Temp\MyPatientData.ini"

j. Transfer of patient and image via DICOM File:

OnyxCeph³™ is supposed to load patient and image data from the DICOM file and delete it after adoption:

 "C:\Programme\Image Instruments\Onyx3Client\OnyxCeph.exe" -DICOM=C:\Temp\XRayPost.DCM" -PicErase=1

k. Import of patients and images from a container:

OnyxCeph³ is supposed to load patient and image data from a container that is located on an FTP-server. The comment field of the recorded images is filled with the order number:

 "c:\Programme\Image Instruments\Onyx3Client\OnyxCeph.exe" -ContainerFTP="C5UW5SJNN3....B6DKHUWUQKD73" -ContainerNote=#42

or via HTTP:

 http://127.0.0.1:2400/setpat -ContainerFTP="C5UW5SJNN3....B6DKHUWUQKD73" ContainerNote=#42   



This website uses cookies. By using the website, you agree with storing cookies on your computer. Also you acknowledge that you have read and understand our Privacy Policy. If you do not agree leave the website.More information about cookies
en/cli.txt · Last modified: 2024/04/03 09:21 by holger