Web services index: Reference

A web service is a component that runs on a web server and allows client programs to call its methods over HTTP or HTTPS. Each method on the component appears as a URL and may return data and accept parameters. IMPAX uses web services to provide access to the patient data and images over a secure Internet connection, and each web service controls a different part of the application. The following table identifies the web service, and the functions within the IMPAX application that it is responsible for.

Web service	Description
AccessControlAdminWebService	Supports the following activities in the users and roles section of the Configure area: Groups permissions and operations. Retrieves operations—access operations are the Client functions which are controlled, such as Dictate Study and View Reports. GettingAccessControlRules—these determine what studies can be accessed, such as VIP and unverified studies.
AdminConfigService	Provides the following functions: Associates and deletes the keywords for a study. Returns system keywords. Returns available columns for a worklist. Retrieves static data for the image viewer. Retrieves enumerated values for the List area. Stores which features are used by the Client. Retrieves and updates study comments.
AuditWebService	Audits user actions on the IMPAX Client. These actions are inserted into the MAP_EVENT table.
ClientInstaller	Identifies the location of the Client Installer. The Client Installer automatically updates workstations with the latest release of the Client.
DicomScuService	Provides DICOM SCU proxy service for remote Clients. Currently, only C_STORE and C_ECHO are supported. If request payload is empty, it is treated as a C_ECHO DICOM request. If request payload is not empty, it is treated as a C_STORE DICOM request and the payload is the DICOM file sent.
EnumeratedValuesWebService	Provides the following functions: Associates and deletes the keywords for a study. Returns system keywords. Returns available columns for a worklist. Retrieves static data for the image viewer. Retrieves enumerated values for the List area. Stores which features are used by the Client. Retrieves and updates study comments.
FileDownloadService	Used for downloading large files such as the contents for a CD burn request.
HolidayMaintenanceWebService	Maintains Scheduled Worklist holidays.
ImageMetaDataService	Retrieves the image tree information for a study. This information is known as the metadata, and is used to assist in presenting images to the user.
ImagePixelDataService	Retrieves the image pixel data for display in the Image area.
InstantMessagingService	Used for the Instant Messaging feature in the IMPAX Client. For this feature to work, the InstantMessagingService must be configured to use HTTPS using port 443. Uses the MessagingService infrastructure for sending/receiving messages.
JobMonitorWebService	Queries and modifies data related to jobs in the IMPAX system.
KeyObjectWebService	Fetches, creates, deletes, and updates the lists of key images.
LastUpdatedService	Checks whether or not the Client should refresh its cached data because the data has changed.
LogFileService	Transfers log files from the IMPAX Client to the Application Server.
LoginWebService	Authenticates the user based on credentials passed to IIS through basic authentication credentials handled by the TranslateBasicAuthenticationHttpModule, or Windows credentials handled natively by IIS. This login overload authenticates the given credentials against the default domain. It does not obtain a license.
MediaExportService	Handles the following interactions with the CD export server: Prepares volumes and communicates with the CD export server to create the compressed studies. Communicates with the CD export server to delete burn jobs after the Client no longer needs them.
MessagingService	Handles the messaging used to notify a Client of certain activities it would otherwise not know about. For example, when one radiologist begins to dictate a study in another radiologist's worklist. Used for the Instant Messaging feature in the IMPAX Client. For this feature to work, the MessagingService must be configured to use HTTPS using port 443. The InstantMessagingService uses the MessagingService infrastructure for sending/receiving messages.
NetworkManagementWebService	Retrieves the available cache and search locations, and retrieves a list of available Modality Worklist Query locations.
OrderInfoService	Fetches order objects.
PatientInfoService	Fetches patient objects.
PrintWebService	Allows the IMPAX Client to print images, studies, and series to a printer installed on the hospital network.
ReportService	Provides sites with access to Radiology and Cardiology reports.
RisDistributionService	Sends reports through a printer, email, or fax machine when an IMPAX RIS is configured.
RisGenericInfoService	Returns information associated with an order, such as scanned requisitions, from the IMPAX RIS.
RisReportInfoService	Retrieves reports from the IMPAX RIS database when an IMPAX RIS is configured.
RisSignoffService	Signs off and locks reports for signoff when an IMPAX RIS is configured.
RisWorklistService	Retrieves the signoff worklists when an IMPAX RIS is configured.
StationWebService	Retrieves and updates station information.
StudyInfoService	Fetches study objects.
StudyOpsService	Provides the following operations: Creates a summary study. Adds objects to a summary study. Deletes an image, study and other objects associated with a study. Starts and ends dictation. Fixes up studies. Retrieves the AE title of the HIS. Prepares a version of the study that is web compressed. Resets study statuses. Retrieves studies from archive or another PACS. Splits and segments studies. Transmits images, studies, or other objects associated with a study to another DICOM location.
TeachingFileService	Allows Clients to view, access, retrieve, and add cases to their teaching files.
UserAdminWebService	Supports the following activities in the users and roles section of the Configure area: Adds, updates, and deletes users. Adds, updates, and deletes users from a role. Retrieves all active license information. Retrieves all capabilities for a user. Capabilities are license options merged with operations. Retrieves all preferences for a group. Retrieves a list of Application Servers. Retrieves a list of storage groups. Retrieves and updates preferences.
UserWebService	Retrieves and updates user preferences.
WorkListMetaDataWebService	Provides worklist metadata for the following functions: Retrieves the LDAP role list, which includes the role information used to organize a worklist. Retrieves all active worklists for a user. Updates the default columns for a specific worklist. Retrieves worklist metadata by type. This is used in the Worklist Library to provide the user with a list of worklists by name so they can select what to display in the List area.
WorkListWebService	Provides the following functions for dealing with worklists: Retrieves saved worklists. Retrieves search worklists. Retrieves scheduled worklists. Adds studies to scheduled worklists. Removes studies from scheduled worklists. Receives worklist updates.