You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
Welcome to the CAREWare FAQ Page
announcement close button
Home > CAREWare > HL7 Socket Installation
HL7 Socket Installation
print icon

To install the Socket Project as a Windows Service:

  1. Download the Socket Project by clicking the link here.
  2. Right click
  3. Click Extract Files.
  4. Select a Destination Path.
  5. Click OK.
  6. Right click Command Prompt.
  7. Click Run as Administrator.
  8. In the Command Window, navigate to the folder where you put the cw_hl7socket.exe.
  9. Run the following command: cw_hl7socket install.

This installs the Socket as a Windows service with auto startup mode. Verify if the SocketServer service is listed in the Windows Services.

CAREWare Setup

The setup steps include modifying settings in CAREWare’s common storage table, turning on indexes, updating mappings, and completing the user notification and condition setup. This section provides instructions on how to complete these steps.

Note: CAREWare creates some default mappings when a user activates an index; these can be updated by the provider.

Configure Common Storage

There are three ways of editing common storage:

  1. CW Admin Utility
  2. HL7 Feed Settings screen
  3. SQL Server Management Studio

Note: It is a good idea to contact the CAREWare Help Desk and ask what build is currently recommended to use with the Socket Interface.


The steps for updating the common storage table in CW Admin are as follows:

  1. Make sure all users are logged out of CAREWare.
  2. Go to C:\Program Files\CAREWare Business Tier.
  3. Right click CW Admin.
  4. Click Run as Administrator.
  5. Click Stop Server.
  6. Click Common Storage Setting.
  7. Click cmm_st_pk to set the list in alphabetical order.
  8. Scroll to the HL7 settings listed below.
  9. Once updated, click Server Settings.
  10. Click Start Server.


These are the folders that require configuration for the HL7 Socket Interface:

HL7IncomingMessageFolder – HL7 files are placed here to begin processing.

HL7ParsingErrorMessageFolder – HL7 files are parsed here if errors occur. Resolving errors allows the file to continue with processing.

HL7ProcessedMessageFolder – HL7 files are stored here once processing is complete.

Note: The other HL7 Common Storage Settings can be updated in the CAREWare user interface.

When editing in SQL Management Studio, please follow these steps:

  1. Log into the CAREWare database instance.
  2. Expand Databases.
  3. Expand CW_Data.
  4. Expand Tables.
  5. Scroll to cw_common_storage.
  6. Include Where cmm_st_pk like '%HL7%' in the select or edit query to get HL7 settings.

When editing HL7 Feed Settings in CAREWare, please follow these steps:

    1. Log into Central Administration.
    2. Click Administrative Options.
    3. Click Server Management.
    4. Click Common Storage Values.
    5. Type HL7 in the search field.
    6. Click any setting to be adjusted to highlight it.
    7. Click View.
    8. Click Edit.

Requires restart – Changes to this setting take effect once the CAREWare Business Tier service is restarted.

Editable In List – Changes to this setting take effect once saved.

Administrative Options >... – The location where this setting can be edited in CAREWare is listed under Can Update. For example, the HL7SocketAutoDeleteClientScoreHigher setting is located at Administrative Options>Data Import and Export Features>HL7 Socket Interface>Interface Settings.


Users can edit HL7 Socket Interface settings in CAREWare by following these instructions:

    1. Log into Central Administration.
    2. Click Administrative Options.
    3. Click Data Import and Export Features.
    4. Click HL7 Socket Interface.
    5. Click Interface Settings.

Note: The file folder settings for HL7 imports and processes need to be edited in Common Storage Settings.


Once common storage is configured, the next step is to turn on the import process indexes. There are different indexes for each message type - ADT, BAR, SCH, PWX, IMM, MDC and ORU—and the index labels begin with those message type abbreviations. Each message type has three associated indexes: Map Provider, Map Client, and Process Records. They are separated to make it easier to track down the processes.

Click here for a list of indexes and field definitions.


For additional information about the HL7 Processes, refer to the HL7 Socket Tech guide here.

0 out of 0 found this helpful


scroll to top icon