API Setup and Explanation

Enabled: Indicates whether the Hospital Communication Worklist API has been turned on.  If you plan to send your hospital communications manually via a third party email system, you can leave this disabled.

Auto Start:  This indicates that after the API server reboots, either on schedule or after an unexpected shutdown, the API should automatically come back on as well.  This should be turned on unless you are troubleshooting problems with the API, to ensure there is no lapse in the flow of communication.

Update Status Check Job:  This is the frequency which the API will check for and process new pending messages.  60 seconds is the default, but you can modify this to adjust performance as necessary (slower servers may want to have a longer check time to allow for processing, e.g. 300 seconds to only check and process messages once every 5 minutes.)  

Communication Error:  This will display any error states that returned the last time the API attempted to process messages.  This is useful information for troubleshooting any issues.

Messages to Print:  The "email to address"  will CC a copy of all print communications to the selected email addresses.

Error Notification:  The "email to address" will send a copy of the error notification to the selected email addresses.  If you have an automated ticket generation system set up, this can be used to trigger automatic escalation based on your ticketing system's parameters.

Enable Test Mode:  If you are working in a sandbox or are verifying the appearance of the automated emails, turn this on to route all emails to the selected email address instead of using the client's real email address.  Stop the interface and turn this off once you are ready to go live with the API on your production system.

Save allows you to save any changes you have made to the API prior to starting the interference.

Start Interface turns on the Hospital Communications Worklist API with the settings you have chosen.  If you want to make and save any changes, you must Stop Interface before applying the changes. 

Hospital Setup

Please see Defining Episode Types to understand how to set up automated messages for the API to send based on episode categories and triggering events in the medical record.

The How-to Guide for the Communication Worklist provides a more workflow based explanation for how the API catches and processes any queued communications from the comm worklist.