XML-RPC is a popular standard for remote procedure calling. In OnePacs Workstation for macOS XML-RPC is used to allow external tools to integrate with the app.
XML-RPC runs in background and can be configured in the Listener preferences. It can be reached by XML-RPC clients, running on the same workstation or on another computer. XML-RPC is based on HTTP: by properly setting up your network infrastructure, you should be able to get your RIS/HIS to talk to OnePacs Workstation for macOS.
The implementation ignores letter case for method names, but not in parameters. These methods accept one parameter that should be a struct, and extracts values from the struct by their name; their response is also a struct, containing a numerical value with key error that contains a zero upon success.
The following methods are exposed by the XML-RPC listener. Additional methods may be exposed by plugins.
This method opens the study, specified by the parameters:
All parameters are optional, but at least one should be defined.
Upon success, the return struct will contain an array named elements, detailing the opened studies.
This method opens the series, specified by the parameters.
All parameters are optional, but at least one should be defined.
Upon success, the return struct will contain an array named elements, detailing the opened series.
Also exposed with the alias DBWindowFind, this method is a versatile database tool. Its behavior depends on the parameters.
Upon success, the return struct will contain an array named elements, detailing the matching items.
This method downloads the specified URL and adds its contents to the database.
Currently, the URL may point to the following file formats: DICOM, ZIP or WADO XML.
This method closes all open viewers.
This method opens the specified database.
This method opens the default database, in case another database is selected.
This method opens the specified album.
This method details the displayed series.
This method details the displayed studies.
This method closes the viewers that display the specified series.
This method closes the viewers that display the specified study.
This method sets the database window search string to the specified patient name.
This method sets the database window search string to the specified value.
This method retrieves the specified dataset from the specified server.
server - a string specifying the server to retrieve from, matched against the DICOM nodes descriptions;
accessionNumber - a string specifying the Accession Number of the dataset to retrieve.
This method retrieves the specified dataset from the specified server.
filterKeyN and filterValueN, with N between 1 and 9 - pairs of strings representing search key-values that specify the dataset to retrieve.
This method returns the file name or path of the file displayed in the active viewer.
onlyfilename - a string, if equal to yes then the filename will be returned instead of its path.
This method quits OnePacs Workstation for macOS.