[OnyxCeph³™ Wiki]

DokuWiki - World Wide Web

User Tools

Site Tools


en:cli

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:cli [2022/03/04 10:16] – [1. Patient Data Tags] holgeren:cli [2024/04/03 09:21] (current) – [4. Transfer via HTTP] holger
Line 9: Line 9:
 ===== 1. Patient Data Tags ===== ===== 1. Patient Data Tags =====
  
-^ Mandatory Parameters                                                                                            || +^ Mandatory Parameters                                                                                                || 
-| ''PatID''             | Unique ID, up to 50 Characters                                                           +| ''PatID''             | Unique ID, up to 50 Characters\\ If ''"<CLEAR>"'' is passed¹, the current patient is closed  
-| ''Firstname''                                                                                                  +| ''Firstname''                                                                                                      
-| ''Lastname''          |                                                                                          +| ''Lastname''          |                                                                                              
-| ''Birthday''          | Format: YYYYMMDD, e.g. "20090530" für 30.5.2009                                          +| ''Birthday''          | Birthday in date format²                                                                     
-| ''Sex''               | Format: "M" for Male and "F" for Female                                                  +| ''Sex''               | Format: "M" for Male and "F" for Female "I" oder "D" for Intersexual (or Diverse)            
-^ Optional Parameters                                                                                             || +^ Optional Parameters                                                                                                 || 
-| ''MiddleName''        |                                                                                          +| ''MiddleName''        |                                                                                              
-| ''PreferedName''      |                                                                                          +| ''PreferedName''      |                                                                                              
-| ''Title''                                                                                                      +| ''Title''                                                                                                          
-| ''Race''              |                                                                                          +| ''Race''              |                                                                                              
-| ''City''              |                                                                                          +| ''City''              |                                                                                              
-| ''State''                                                                                                      +| ''State''                                                                                                          
-| ''Street''            |                                                                                          +| ''Street''            |                                                                                              
-| ''Street2''                                                                                                    +| ''Street2''                                                                                                        
-| ''Doctor''            |                                                                                          +| ''Doctor''            |                                                                                              
-| ''Email''                                                                                                      +| ''Email''                                                                                                          
-| ''Cellular''          |                                                                                          +| ''Cellular''          |                                                                                              
-| ''HomePhone''                                                                                                  +| ''HomePhone''                                                                                                      
-| ''WorkPhone''                                                                                                  +| ''WorkPhone''                                                                                                      
-| ''PatTags''           | Patient keywords (separated by ";"                                                     +| ''PatTags''           | Patient keywords (separated by ";"                                                         
-| "PatMarker"           | Modify markers on patient tab: 5 chars: 1“ set marker  0“ reset marker  -“ no change  +| "PatMarker"           | Modify markers on patient tab: 5 chars: "1set marker  "0reset marker  "-no change      
-| "InsuranceID"         | Number/ID of health insurance                                                            +| "InsuranceID"         | Number/ID of health insurance                                                                
-| "Salutation"          |                                                                                          +| "Salutation"          |                                                                                              
-| ''ContactDate''       Format: YYYYMMDD, e.g. "20090530"                                                        +| ''ContactDate''       Contact date in date format²                                                                 
-| ''ModelNr''          | Additional cast ID                                                                       +| ''ModellNr''          | Additional cast ID                                                                           
-| ''Notes''                                                                                                      |+| ''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 ===== =====2. Image Data Tags =====
  
Line 43: Line 45:
 To hand over 2D images to OnyxCeph³™, the following tags can be used:\\ To hand over 2D images to OnyxCeph³™, the following tags can be used:\\
  
-| ''PicCount''      | Number of images to be transfered                        +| ''PicCount''      | Number of images to be transfered                                                                                                                                    
-| ''PicErase''      | "Y" or "1" OnyxCeph³ deletes the files after saving      +| ''PicErase''      | "Y" or "1" OnyxCeph³ deletes the files after saving                                                                                                                  
-| :::               | "N" or "0" (Default) OnyxCeph³ doesn't delete the files  +| :::               | "N" or "0" (Default) OnyxCeph³ doesn't delete the files                                                                                                              
-| ''PicPath#''      | Full Path oft the Image File #¹                          +| ''PicPath#''      | Full Path oft the Image File #¹                                                                                                                                      
-| ''PicInfo#''      | Additional Information, Just Like Tags, Comments, etc.   +| ''PicInfo#''      | Additional Information, Just Like Tags, Comments, etc.                                                                                                               
-| ''PicTags#''      | Keywords Concerning the Image (Separated by ";"        +| ''PicTags#''      | Keywords Concerning the Image (Separated by ";"                                                                                                                    
-| ''PicDate#''      | Date of Aquisition, Format: YYYYMMDD, e.g. "20090530"    +| ''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                      |+| ''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"\\ ¹ # will be replaced the image number starting with 1; e.g. the first entry is -PicPath="C:\tmp\img.jpg"\\
Line 65: Line 67:
 =====4. Transfer via HTTP ===== =====4. Transfer via HTTP =====
  
-If the infoserver is active in OnyxCeph³ master data can also be transferrred to OnyxCeph³ via HTTP+If the **HTTP Interface** is active in OnyxCeph³ master data can also be transferrred to OnyxCeph³ via HTTP
 requests.\\ requests.\\
 OnyxCeph³ operates as HTTP server and serves the configured port. 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.\\ 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" ... |+| Server:Port/SetPat -Tag="Value" -Tag="Value" ... |
  
 If no space character is in Value the quotation marks can be omitted.\\ 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 ===== =====5. Transfer by Text File =====
  
Line 85: Line 90:
 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: 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||+||-DICOM="File Name"||
  
 then the patient's master data is compared and the image is opened in module Add Imag 2D.\\ then the patient's master data is compared and the image is opened in module Add Imag 2D.\\
Line 98: Line 103:
 If the path of the container-file is transferred after the command line parameter: If the path of the container-file is transferred after the command line parameter:
  
-||-ContainerFile=File Name||+||-ContainerFile="File Name"||
  
 the patient's master data and image data is compared. For this purpose the import dialog opens. the patient's master data and image data is compared. For this purpose the import dialog opens.
Line 104: Line 109:
 ContainerFTP: ContainerFTP:
  
-||-ContainerFTP=C5UW5SJNN3....B6DKHUWUQKD73||+||-ContainerFTP="C5UW5SJNN3....B6DKHUWUQKD73"||
  
 The command line parameter ContainerNote allows handing over of a string that can be attached to the The command line parameter ContainerNote allows handing over of a string that can be attached to the
 comment of the images adopted: comment of the images adopted:
  
-||-ContainerNote=Auftrag #0-8-15||+||-ContainerNote="Auftrag #0-8-15"||
  
 After import OnyxCeph³ automatically opens the respective client and patient.\\ After import OnyxCeph³ automatically opens the respective client and patient.\\
Line 121: Line 126:
 \\ \\
 • **ActionBefore** ((prior to master data compariso) • **ActionBefore** ((prior to master data compariso)
-| Copy patient:  | -ActionBefore=CLONEPATIENT:123“ -PatID=123New“  |+| Copy patient:  | -ActionBefore="CLONEPATIENT:123-PatID="123New |
  
 • **ActionAfter** (after master data comparison or container import) • **ActionAfter** (after master data comparison or container import)
-| Presentation template:                 | -ActionAfter=PRESENTATION:TemplateName“                       | +| Presentation template:  | -ActionAfter="PRESENTATION:TemplateName"  |
-| Container with all data of a patient:  | -PatId="123" -ActionAfter="PATCONTAINER:C:\Temp\FileName.O3C |+
 \\ \\
  
Line 171: Line 175:
 Opens patient 123 and updates master data when indicate\\ Opens patient 123 and updates master data when indicate\\
      
-   http://127.0.0.1:24000/setpat PatId="123" Firstname="Test" Lastname="Patient"+   http://127.0.0.1:24000/setpat -PatId="123" -Firstname="Test" -Lastname="Patient"
 Birthday="19960313" PatMarker=”-1---” Birthday="19960313" PatMarker=”-1---”
  
Line 178: Line 182:
 Opens patient 123 and after that the presentation template Onyx_Images_8\\ 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+   http://127.0.0.1:24000/setpat -PatId=123 -ActionAfter="Presentation:Onyx_Images_8"
  
 __//h. Copying of a patient via HTTP//__ __//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 Copies the patient 123 inclusive of all images. The copy gets the new patient ID 123New and is renamed to
-Test Patient\\+"Test Patient"\\
      
-   http://127.0.0.1:24000/setpat -ActionBefore=ClonePatient:123“ -PatID=123Neu+   http://127.0.0.1:24000/setpat -ActionBefore="ClonePatient:123-PatID="123Neu"
 -Firstname="Test" -Lastname="Patient" -Firstname="Test" -Lastname="Patient"
  
Line 220: Line 224:
 The comment field of the recorded images is filled with the order number: 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+   "c:\Programme\Image Instruments\Onyx3Client\OnyxCeph.exe" -ContainerFTP="C5UW5SJNN3....B6DKHUWUQKD73" -ContainerNote=#42
  
 or via HTTP: or via HTTP:
  
-   http://127.0.0.1:2400/setpat ContainerFTP=C5UW5SJNN3....B6DKHUWUQKD73" ContainerNote=#42   +   http://127.0.0.1:2400/setpat -ContainerFTP="C5UW5SJNN3....B6DKHUWUQKD73" ContainerNote=#42   
 \\ \\
 \\ \\
en/cli.1646385373.txt.gz · Last modified: 2022/03/04 10:16 by holger