Reference data entities can be imported and exported in bulk in XML format. These operations are done via a utility program located in the directory where the RIS server is installed. For the moment, however, the XML import/export schemas are not documented and, therefore, you must first "discover" the schema for the entity you wish to import by adding a couple of entities manually through the RIS Client GUI and then running the export utility on that entity.
Exporting Data
To export reference data, the following command should be executed from a command line prompt in the server's installation directory. The default installation directory is C:\Program Files\ClearCanvas\ClearCanvas RIS Server.
ClearCanvas.Ris.Server.Executable Export /class:CLASS PATH
The arguments CLASS and PATH should be replaced with the name of the dataset to export, and the path to the output file where the data should be written.
| • | User |
| • | AuthorityGroup |
| • | Configuration |
| • | Enumeration |
| • | StaffGroup |
| • | ProtocolGroup |
| • | Staff |
| • | ExternalPractitioner |
| • | DiagnosticService |
| • | Location |
| • | ProcedureTypeGroup |
| • | CannedText |
| • | Worklist |
| • | Facility |
| • | ProcedureType |
| • | PatientNoteCategory |
| • | Modality |
You may also omit the /class parameter entirely and use the /all switch instead. This causes all the reference datasets to be exported, and the path is interpreted to be a directory rather than a file.
ClearCanvas.Ris.Server.Executable Export /all PATH
Importing Data
To export reference data, the following command should be executed from a command line prompt in the server's installation directory. The default installation directory is C:\Program Files\ClearCanvas\ClearCanvas RIS Server.
ClearCanvas.Ris.Server.Executable Import /class:CLASS PATH
The arguments CLASS and PATH should be replaced with the name of the dataset to import, and the path of the input file containing the data.
The valid values of CLASS are the same as for exporting listed above.
Note that the /all switch cannot be used when importing, and that there are restrictions on the order in which the data classes can be imported (as some datasets have dependencies on other datasets). These dependencies are listed in the following table.
Class |
Dependencies |
User |
Enumeration, AuthorityGroup |
AuthorityGroup |
Enumeration |
Configuration |
Enumeration |
Enumeration |
(none) |
StaffGroup |
Enumeration, Staff |
ProtocolGroup |
Enumeration, ProcedureTypeGroup |
Staff |
Enumeration |
ExternalPractitioner |
Enumeration |
DiagnosticService |
Enumeration, ProcedureType |
Location |
Enumeration, Facility |
ProcedureTypeGroup |
Enumeration, ProcedureType |
CannedText |
Enumeration |
Worklist |
Enumeration, Staff, StaffGroup, ProcedureType, ProcedureTypeGroup, Facility, Location, ExternalPractitioner |
Facility |
Enumeration |
ProcedureType |
Enumeration, Modality |
PatientNoteCategory |
Enumeration |
Modality |
Enumeration |