Primary Sense Services Installation

Supported Operating Systems

Primary Sense is supported on the following Microsoft Windows^® operating systems.

Microsoft .Net Framework

Microsoft .Net Framework v4.6.2 or newer is a requirement for running the Primary Sense software.

Installation

Download the latest versions of both the Primary Sense Services (Extractor) and Primary Sense Services (Extractor) Updater installers from the installation page.

You will need to be logged in to Microsoft Windows with a user account with sufficient authorisation to install applications, such as an administrator.

Run the Primary Sense Services (Extractor) installer once it has completed downloading and complete the following steps.

Repeat the steps using the Primary Sense Services (Extractor) Updater installer.

	Welcome Click Next to continue.
	License Agreement Read the End User License Agreement (EULA) and tick I accept the terms in the License Agreement. Click Next to continue.
	Setup Type Choose the Complete setup type.
	Confirm Installation Click Install to continue.
	User Account Control (UAC) You may be asked to authorise the installation using Windows User Account Control. The UAC dialog on your computer may look different depending on your version of Windows, or you may be asked to enter an administrator user name and password. Check that the publisher is Gold Coast Primary Health Network. Click Yes to authorise and continue.
	Installation Complete Once installed click Finish to close the installer. If Launch Primary Sense™ Service Setup is ticked the setup application will start. We recommend running Windows Update after installation to ensure Windows and the Microsoft .Net Framework are up to date.

Firewall and Antivirus

Firewall and antivirus software may interfere with the correct operation of Primary Sense.

We recommend that you allow the following domains through your firewall. All domains will be available over a secure connection only (https).

We recommend that you allow the Primary Sense software read and write access to the following folder and it's subfolders in your antivirus software.

Setup

The Primary Sense Services Setup application will run as soon as the installation completes.

If it does not run, or to access it in the future, it can be selected from the Windows Start Menu. If it is not visible in the start menu, start typing “primary” and the Primary Sense Services Setup application should appear in the start menu search list.

Practice Settings

Double-click the Edit Practice & Database Connection icon to display the Settings window:

Enter the practice token for your practice in the Practice Token text field and then press the [...] button. It will take a moment to identify the practice details.

When the practice is identified, the Name and Software will be displayed. This cannot be changed. If it is incorrect, please contact Primary Sense Support to ensure it is set up correctly.

Continue setting up the Practice Software Database Connection, or click the OK button to save the settings, otherwise click Cancel to exit the Settings window.

Database Connection

Select your practice software:

Best Practice Jade with October 2019 Data Update (or newer)

If your practice is running Best Practice software and is updated to Jade with October 2019 Data Update or newer, then you will need to configure Third Party Access to allow Primary Sense to access the database.

You can configure this by selecting Setup within Best Practice, then selecting Configuration and then Database.

Click the Setup third-party integrations button and then scroll down the list of third-party providers and tick Primary Care Gold Coast.

Click Save, then Save again.

Return to the Primary Sense Settings window. An Enable Best Practice Third Party Support button should be available.

If the button does not appear, your practice is not configured to use Best Practice, or it is already configured to use third party integration.

Click the Enable Best Practice Third Party Support button and you will be prompted to confirm.

Once configured, your database settings will be configured or updated as follows. These default settings should work for most installations, however if the server or database are different, the Change Database Connection option can be used to configure custom settings.

Setting	Value
Server Name	.\BPSINSTANCE
Database Name	BPSPatients
User Name	BPSPartner
Password	Partner Password
Pooling (advanced)	False
Application Name (advanced)	Primary Sense

Best Practice (older)

In the Primary Sense Settings window, click the Change Database Connection button to set up the connection to the practice software database.

The following default settings will be configured automatically and should work for most installations, however if the server or database are different, configure as required. The password for the BPSRawData account will be required.

Setting	Value
Server Name	.\BPSINSTANCE
Database Name	BPSPatients
User Name	BPSRawData
Password	Enter BPSRawData Password
Application Name (advanced)	Primary Sense

Ensure that the Save my password option is ticked.

Click the Test Connection button to try the connection to the database. If the test succeeds click OK to save the database connection details.

Medical Director

If your practice is running Medical Director, you will need to download the SQL script below. This script will set up a read only user account which will be used by Primary Sense Services to access your database.

Replace the <insert password here> text with a secure random password.

Run the script on your Medical Director SQL Database using Microsoft SQL Management Studio.

Download Create User Script

If you previously have run the Create User Script and have recently updated Medical Director to a new version, the user may have lost access to the database. Run the following script to fix the user permissions.

Download Update User Script

In the Primary Sense Settings window, click the Change Database Connection button to set up the connection to the practice software database.

The following default settings will be configured automatically and should work for most installations, however if the server or database are different, configure as required. The password for the PHNUser account will be required.

Setting	Value
Server Name	.\HCNSQL07
Database Name	HCN
User Name	PHNUser
Password	Enter PHNUser Password
Application Name (advanced)	Primary Sense

Ensure that the Save my password option is ticked.

Click the Test Connection button to try the connection to the database. If the test succeeds click OK to save the database connection details.

Setup HL7 Messaging

Primary Sense will automatically create medication safety issue messages in the HL7 file format. Configure your practice software to import these files.

Select your practice software:

Best Practice

Note: The following configuration must be performed on the same computer as the Primary Sense Services are installed, usually your server.

Open Best Practice and from the Tools menu select the Configure option, then select the Results Import icon.

Best Practice may already have a report path configured. If this is configured it will be used by Primary Sense.

Alternatively the default Primary Sense folder can be configured as a report path. Click the Add button and select the following folder:

Setting	Value
Folder	C:\ProgramData\Primary Sense\Messages\In(see notes)

Notes:

• Best Practice uses folder selectors to choose the report paths. If you do not have the show hidden files option enabled in Windows you will not be able to select the C:\ProgramData\ folder, as it is hidden by default.
• The folder can be changed to a custom folder. Ensure that the HL7 Import Folder setting is also set to the same folder in the Primary Sense Services Setup Advanced Settings and that the services have sufficient permissions to read and write to the folder.
• If no report paths are configured, Primary Sense will write message files to it's default folder, however messages will not be imported into Best Practice:
  C:\ProgramData\Primary Sense\Messages\In

Click Save on the Configuration window.

Best Practice will automatically import messages as they are created by Primary Sense.

Medical Director

Note: The following configuration must be performed on the same computer as the Primary Sense Services are installed, usually your server.

Review the configured import folders by opening Medical Director and from the Tools menu select the Manage Communications... option, then select the Setup Data Transfer tab.

Medical Director may already have an import folder called MD Messages configured as below. If this is configured it will be used by default by Primary Sense.

Alternatively the Primary Sense folder can be configured directly.

Click the Add button and in the Setup Data Transfer Details window enter the following settings.

Setting	Value
Description	Primary Sense
Category	Primary Sense
Import Folder	C:\ProgramData\Primary Sense\Messages\In(see notes)
Export Folder	C:\ProgramData\Primary Sense\Messages\Out(see notes)
Automatic Import Enabled (SDI)
Manual Import Enabled (Manual)
Generate Acknowledgement (ACK)
Available Network Wide (Global)

Click OK to close the Setup Data Transfer Details window and then click Close on the Manage Communications window. You will be asked to save the settings.

Notes:

• Medical Director uses a folder selector to choose the import and export folders. If you do not have the show hidden files option enabled in Windows you will not be able to select the C:\ProgramData\ folder, as it is hidden by default.
• The import and export folders can be changed to a custom folder. Ensure that the HL7 Import Folder setting is also set to the same folder in the Primary Sense Services Setup Advanced Settings and that the services have sufficient permissions to read and write to the folders. It is recommended to use different folders for import and export.
• If no folders are configured, Primary Sense will write message files to it's default folder, however messages will not be imported into Medical Director:
  C:\ProgramData\Primary Sense\Messages\In

Medical Director will automatically import messages as they are created by Primary Sense. Files can be reviewed by pressing the F5 key. Messages are displayed as below:

Messages that are processed are added to the patients Results tab, as below:

Start Services

The Services are not started automatically on installation, but are configured to start automatically when the operating system starts up.

The services may be started and stopped from the Primary Sense Service Setup application. They may also be controlled using the Microsoft Windows Service Manager.

Double-click any service icon to display the Services window, then double-click the Start All option to start all services:

The following statuses are displayed for each service:

Note that the Extractor and Messages services depend on the API service, therefore starting those services will also start the API service.

There may be a delay of up to 10 seconds while a service starts or stops.

Use the following additional commands to control the services:

Once all services are started successfully the statuses should display Running:

Advanced Settings

Additional advanced settings are available in the Advanced tab of the Settings window.

The Command Timeout and Environment settings should only be changed if directed to by Primary Sense support staff.

These options are set to the following defaults:

Click the OK button to save the settings, otherwise click Cancel to exit the Settings window.

Verify Setup

Double-click the Verify Setup icon under the Settings section of the Settings window. Click the Verify button to start verification. The following tests will be performed:

• The latest version of Primary Sense Services is installed,
• Connection to the practice software database is successful,
• The HL7 Messaging folder is configured and the folder exists,
• Connection to Primary Sense servers is successful.
• All Primary Sense Services are running,

Results of the verification tests will be displayed. Double-click an entry in the list to display more details, for example to view an error log entry. Click the Log File button to open the daily log file in the default text editor.

Uninstall Extractor v1

The new Primary Sense Services completely replace the older Primary Sense Extractor (v1).

If Primary Sense Extractor (v1) is installed, please uninstall it using the standard Microsoft Windows uninstall method.

Installed Software

The Primary Sense installers install the following software. All software is installed into the following folder:

C:\Program Files\Primary Sense\

Windows Services

The following Windows Services are installed. Services are not started automatically on installation, but are configured to start automatically when the operating system starts up. Services are configured to use the SYSTEM account.

Use the Microsoft Windows Services console to start and stop services, and enable or disable services on system startup if required.

Applications

The following application is installed. A shortcut to the application is created in the start menu.

Windows Event Logs

The following Windows Event Logs are configured. Note that the logs are not removed from the system when the software is uninstalled. Logs may be manually deleted using the Windows Event Viewer.

Data Folders

The data folders are created inside the following parent folder. These folders and files are not removed from the system when the software is uninstalled.

Troubleshooting

If the database connection fails, use the Database Connection settings to set up and test the database connection.

If the Primary Sense API connection fails, check your network, internet connection or firewall.

If you have recently updated Medical Director to a new version, the PHNUser user may have lost access to the database. See Database Connection - Medical Director for a script to run to fix this issue.

If Primary Sense Services are using excessive database resources or otherwise causing an issue, please stop and disable all Windows Services and contact Primary Sense Support.

More Options

Several options are available under the More Options section of the Settings window:

• Online Help opens the Primary Sense website help page in the default browser,
• About displays information about the application, including version number and copyright notice,
• Primary Sense Website opens the website home page in the default browser.