Launching the Application via Command Line and URL Protocol

The application can be quickly launched in various operating modes via the command line and URL protocol

Launching the Application Using Command Line Arguments

• mode specifies the program's subsequent operation after launch
  The following modes are available:
  • show - default
    Load and display the study on the screen, without opening additional windows on top
    To download, you need to specify the studyUid of the selected study (argument uid) or a search filter (argument filter), as well as the PACS from which to load the study (argument pacs or an explicit set of server parameters)
  • query - find studies and show them in the "Import from PACS" window. The search is performed using the uid and filter arguments on the specified PACS (argument pacs or an explicit set of server parameters).
  • create - start creating a new study with predefined parameters (argument filter)
  • worklist - find worklist items and show them in the "Worklist" window
    The search is performed using the filter argument on the specified PACS (argument pacs or an explicit set of server parameters)
  • export - launch the program in download mode followed by writing the study to disk
    The search is performed using the uid and filter arguments on the specified PACS (argument pacs or an explicit set of server parameters)
  • archive - open the "Archive" window after launching the program
• pacs specifies the AETitle of the PACS from which the study is planned to be loaded
  This PACS must be configured
• uid sets the Study Instance UID value (tag 0020,000d) of the study to be downloaded from the PACS
  Multiple uid arguments can be specified to load multiple studies
• ip specifies the IP address of the PACS for interaction
• port specifies the port of the PACS for interaction
• aet specifies the AETitle of the PACS for interaction
• aec specifies the AETitle of the application that will be used when communicating with the PACS
• url specifies the URL of the DICOMweb service of the PACS for interaction
• urlWado specifies the URL of the WADO service of the DICOMweb PACS for interaction
• filter specifies a filter for searching studies on the server or pre-filling forms in dialog windows
  It is specified as a set of TAG=VALUE pairs, separated by the & symbol
  TAG is the group and code of the DICOM tag, VALUE is the tag value
  The resulting string is processed by urlEncode (percent encoding) and placed in quotes
  For example, a filter for studies of modality CR and CT for a patient named IVANOV would be specified as follows:
  "00100010%3DIVANOV%2600080061%3DCR,CT"
  General format:
  "<TAG>%3D<VALUE>%26<TAG>%3D<VALUE>"
If, as a result of applying the filter in export and show modes (i.e., with downloading), more than 4 studies are found on the PACS, the "Import from PACS" window will open to select the required studies
Otherwise (less than 4 studies or exactly four), they will all be loaded into the Preview Bar and the first one will be displayed on the screen
• find optional
  Specifies the method by which study information will be obtained
  Two methods are available: cfind and qido-rs for DICOM and DICOMweb servers, respectively
• get optional
  Specifies the method by which the images will be downloaded
  Two methods each are available for DICOM and DICOMweb servers: cget, cmove and wado-rs, wado-uri, respectively

Examples of Using Command Line Arguments

• vdviewer -mode show -uid 123.456.789 -pacs VIDAR
  Launch the program to load and display the study with Study Instance Uid 123.456.789 using default methods
  The PACS with AETitle VIDAR will be selected as the server
  After loading, the study will be displayed in the ribbon and on the screen
  
• vdviewer -pacs DCM4CHEE -filter "00080050%3D706135" -mode show
  Launch the program to load and display studies using the search filter Accession Number (tag 0008, 0050) = 706135 using default methods
  The PACS with AETitle DCM4CHEE is selected as the server
  After loading, the study will be displayed in the ribbon and on the screen
  Searching and filtering by the Accession Number tag (0008,0050) is useful when integrating with external HIS, when the value of this tag corresponds to the "study referral number" in the HIS
• vdviewer.exe -url http://192.168.128.1/dicom/dicomweb/ -urlWado http://192.168.128.1/wado/ -mode show -filter "00100010%3DIVANOVA*"
  Launch the program to load and display studies using the search filter Patient Name (tag 0010, 0010) = IVANOVA* using default methods
  A PACS with the DICOMweb address http://192.168.128.1/dicom/dicomweb/ and the WADO service address http://192.168.128.1/wado/ is manually specified as the server
  The * symbol at the end of the patient name indicates a prefix search: i.e., patients with Patient Name IVANOVA I.I. and IVANOVA E.V will be found
  If more than 4 studies are found by the filter, the program will show all found studies in the "Import Studies from PACS" window
  They can be downloaded manually using the "Import" button
• vdviewer -pacs DCM4CHEE -get cmove -mode show -uid 123.456.789 -uid 987.654.321 -uid 1.234.567.000
  Launch the program to load and display studies with Study Instance Uids 123.456.789, 987.654.321, 1.234.567.000 using the default search method and the C-GET download method
  The PACS with AETitle VIDAR is selected as the server
  After loading, the studies will be displayed in the Preview Bar, and the last study (1.234.567.000) will be displayed on the screen
  Note that in this case, a pre-created PACS configuration of type Classic DICOM is used, which by default performs search and download using C-FIND and C-GET methods
  Using the get argument, we specify that we want to use the C-MOVE download method
• vdviewer -uid 123.456.789
  Launch the program to load and display the study with Study Instance Uid 123.456.789 using default methods
  The first PACS in the list will be selected as the server
  After loading, the study will be displayed in the ribbon and on the screen
  The following methods will be selected as defaults:
  • If the configuration type is DICOMweb - QIDO-RS and WADO-RS
  • If the configuration type is Classic DICOM - CFIND and CGET
• vdviewer.exe -mode export -pacs VIDAR -uid 123.456.789
  Launch the program to load and write to disk (export) the study with Study Instance Uid 123.456.789. Search and download methods are determined by the server configuration type
  The PACS with AETitle VIDAR is selected as the server
  After loading, the "Write" window will open
• vdviewer.exe -mode export -get wado-uri -uid 123.456.789 -pacs VIDAR
  Launch the program to load and write to disk (export) the study with Study Instance Uid 123.456.789 using the default search method and the WADO-URI download method
  The PACS with AETitle VIDAR is selected as the server
  After loading, the "Write" window will open
  Note that in this case, a pre-created PACS configuration of type DICOMweb is used, which by default performs search and download using QIDO-RS and WADO-RS methods
  Using the get argument, we specify that we want to use the WADO-URI download method
• vdviewer -ip 192.168.128.1 -port 104 -aet VIDAR -aec IMPORT -mode export -filter "00100020%3DIB345-24"
  Launch the program to load and write to disk (export) studies using the search filter Patient ID (tag 0010, 0020) = IB345-24 using default methods
  A PACS with address 192.168.128.1:104 and AETitle VIDAR is manually specified as the server
  Download will be performed under the name IMPORT
  After loading, the "Write" window will open
  Searching and filtering by the Patient ID tag (00100020) can be useful for viewing all studies of a patient if their "number" is entered in this field: outpatient card number, SNILS, medical history number
• vdviewer -mode query -pacs ORTHANC -filter "00080020%3D20240927-20240927"
  Launch the program to search for studies in the PACS using the search filter Study Date (Study Date, tag 0008, 0020) = 27.09.2024-27.09.2024, i.e., for one day
  The PACS with AETitle ORTHANC is selected as the server
  After the search, the "Import Studies from PACS" window will open with the found studies
  
• vdviewer.exe -mode query -pacs ORTHANC -filter "00080020%3D20240926-20240927%2600080061%3DCR,CT"
  Launch the program to search for studies in the PACS using the search filter Study Date (Study Date, tag 0008, 0020) = 26.09.2024-27.09.2024, i.e., for two days and with modalities CR, CT (Modalities in Study, tag 0008, 0061)
  The PACS with AETitle ORTHANC is selected as the server
  After the search, the "Import Studies from PACS" window will open with the found studies
  
• vdviewer.exe -mode create -filter "00100010%3DIVANOVA I.I.%2600100020%3DIB345-24%2600080050%3D706135%2600080060%3DCT"
  Launch the program and open the window for creating a new study with pre-filled data from the filter, namely:
  
  • Name (tag 0010, 0010) = IVANOVA I.I.
  • ID (tag 0010, 0020) = IB345-24
  • Accession Number (tag 0008, 0050) = 706135
  • Modality (tag 0008, 0060) = CT
  The following tags are also available for filling in the new study creation window:
  • Manufacturer - tag 0008, 0070
  • Sex - tag 0010, 0040. For example, M, F, O
  • Institution Name - tag 0008, 0080
  • Description - tag 0008, 1030
  • Study Date - tag 0008, 0020. For example, 20241129
  • Study Time - tag 0008, 0030. For example, 13:00
  • Birth Date - tag 0010, 0030. For example, 19900830
  • Weight - tag 0010, 1030
  • Height - tag 0010, 1020
  • Institution Address - tag 0008, 0081
  • Referring Physician - tag 0008, 0090
  • Requesting Physician - tag 0008, 1050
  • Operator's Name - tag 0008, 1070
• vdviewer.exe -mode worklist -filter "00100010%3DIVANOVA I.I" -pacs VIDAR
  Launch the program and open the "Worklist" (Modality Worklist) window, followed by a search for worklist items using the filter Patient Name (tag 0010, 0010) = "IVANOVA I.I."
  The search is performed on the PACS with AETitle VIDAR
  The following tags are also available for filtering:
  • ID - tag 0010, 0020
  • Accession Number - tag 0008, 0050
  • Modalities in Study - tag 0008, 0061. For example, "CR,CT"
  • Study Date - tag 0008, 0020. A range is required, e.g., 20241125-20241129
• vdviewer -mode archive
  Launch the program and subsequently open the local archive window

Launching the Application via URL Protocol

The arguments are the same as when launching from the command line, and the values follow the same rules as when launching from the command line

Possible launch examples are provided:

• vdviewer3://api?mode=show&uid=123.456.789&pacs=VIDAR
• vdviewer3://api?pacs=DCM4CHEE&filter="00080050%3D706135"&mode=show
• vdviewer3://api?url=http://192.168.128.1/dicom/dicomweb/&urlWado=http://192.168.128.1/wado/&mode=show&filter="00100010%3DIVANOVA*"
• vdviewer3://api?pacs=DCM4CHEE&get=cmove&mode=show&uid=123.456.789&uid=987.654.321&uid=1.234.567.000
• vdviewer3://api?uid=123.456.789
• vdviewer3://api?mode=export&pacs=VIDAR&uid=123.456.789
• vdviewer3://api?mode=export&get=wado-uri&uid=123.456.789&pacs=VIDAR
• vdviewer3://api?ip=192.168.128.1&port=104&aet=VIDAR&aec=IMPORT&mode=export&filter="00100020%3DIB345-24"
• vdviewer3://api?mode=query&pacs=ORTHANC&filter="00080020%3D20240927-20240927"
• vdviewer3://api?mode=query&pacs=ORTHANC&filter="00080020%3D20240926-20240927%2600080061%3DCR,CT"
• vdviewer3://api?mode=create&filter="00100010%3DIVANOVA I.I.%2600100020%3DIB345-24%2600080050%3D706135%2600080060%3DCT"
• vdviewer3://api?mode=worklist&filter="00100010%3DIVANOVA I.I"&pacs=VIDAR
• vdviewer3://api?mode=archive

Launching in DICOM File Integrity Check Mode

• (0) Success
• (1) ErrorOpenTaskFile
• (2) ErrorFileNotFound
• (3) ErrorNoMetaInformation
• (4) ErrorUnsupportedSopClass
• (5) ErrorParsing
• (6) PartiallyDamaged: multiframe, among damaged frames there are intact images
• (7) CompletelyDamaged: all images are damaged

Checking a Single File

Checking All Files in a Folder

Checking All Files According to a List in the Specified Input File

Loading DICOM from a File, Folder, Zip Archive

• Configuring Interaction with PACS
• Creating a New DICOM Study from Images/Movies, Adding Images/Movies to a Study
• Worklist (Modality Worklist)