VDDS-media 1.4 defines an interface for the exchange of multimedia data between practice management software and the X-ray/camera software
The Trust1Connector has a custom `vdds` module which can be used in combination with the `file-exchange` module.
The `file-exchange` module exposes an API for abstract file management. For more information see: File Exchange. In summary, the `file-exchange` module allows you to define `scoped` abstractions for folders and files, in a web context (based on the origin of the requesting web applciation).
The additional functionality exposed by the `vdds` module, is mainly:
open the Image viewer with a pre-defined image ID
import/export data to/from an IPS(Image Processing System)
The typical client application is a web PMS (Practice Management System).
Integration
The following communication diagram depicts the information exchange defined in the specification:
Security Considerations
The executable names are hard-coded and statically extended to the abstract file descriptor on the T1C-API.
The HTTP/REST API is used by the T1C-SDK-js (javascript client).
A file descriptor is defined in terms of the entity and entity type, the absolute path can be used to build a relative folder path starting from the folder mapping (linked to the entity type).
The following responses are returned when an exception is thrown:
# InvalidInput{"success":false,"code":106997,"description":"Invalid Input"}# ConfigurationError{"success":false,"code":505126,"description":"Configuration Error"}# FileNotFoundException{"success":false,"code":505126,"description":"File not found"}
InvalidInput
wrong or missing arguments in request body defined by (entity, entity-type, file-name or args)
wrong or missing executable path reference defined by (entity, entity-type, command)
ConfigurationError
file-exchange has not been initialized prior to the documented use case
FileNotFoundException
referencing file is not found on the local device file system, this is typically the case when a wrong entity-type of relative folder has been provided in the request
Use an REST client of curl to create an entity and entity type -> this will pop-up a file-chooser, where you need to select the folder (where you want the entity-type to link to):