Primary Sense Services Installation

Support

Supported Operating Systems

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

Note: Services are 64 bit (x64) and require a 64 bit operating system.

Desktop

  • Windows 10
  • Windows 8.1
  • Windows 7 with Service Pack 1 END OF LIFE

Server

  • Windows Server 2019
  • Windows Server 2016
  • Windows Server 2012 R2
  • Windows Server 2012
  • Windows Server 2008 R2 with Service Pack 1 END OF LIFE

Not Supported

The following operating systems are not supported:

Desktop

Server

  • Windows Server 2008 and earlier

End of Life

Operating systems marked as END OF LIFE are no longer supported by Microsoft. Primary Sense will run on these operating systems but we recommend you upgrade to continue to receive security and quality updates.

Microsoft .Net Framework

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

Notes:

  • The framework is already installed on many modern Windows computers, or may already be installed by your practice software.
  • We recommend installing the latest available version.
  • Installation or upgrading may require a reboot to complete.
  • Run Windows Update after installation to ensure all security and quality updates are installed.
Software Package Version Download
Microsoft .Net Framework 4.8 RECOMMENDED Download All Versions
Microsoft .Net Framework 4.6.2 MINIMUM Download

Installation

Notes:

  • Installation and use of this software is governed by the End User License Agreement (EULA),
  • A unique Practice Token is required to configure Primary Sense. Please contact Primary Sense Support if you do not have the token for your practice,
  • An internet connection is required to send data to Primary Sense,
  • A connection to the installed practice software database is required.
  • Install both the Primary Sense Services (Extractor) and Primary Sense Services (Extractor) Updater to enable automated service updates.
  • Full installation will take up approximately 60 megabytes of disk space.

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
Welcome

Click Next to continue.

License Agreement
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
Setup Type

Choose the Complete setup type.

Confirm Installation
Confirm Installation

Click Install to continue.

User Account Control
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
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).

Address
*.primarysense.com.au
*.gcphn.org.au
*.healthygc.com.au

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.

Folder
C:\ProgramData\Primary Sense\

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.

Primary Sense Services Setup
Primary Sense Services Setup

Practice Settings

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

Practice Settings
Practice Settings

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

Notes:

  • The Primary Sense software does not make any changes to the practice data,
  • All data requests are read-only, and extracted data is not stored on the computer.

Select your practice software:

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.

Best Practice Third Party Integration
Best Practice Third Party Integration

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.

Enable Best Practice Third Party Support
Enable Best Practice Third Party Support

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

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

Database Connection
Database Connection

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.

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.

Database Connection
Database Connection

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:

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.

Results Import Configuration
Results Import Configuration

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)
Results Import Configuration
Results Import Configuration

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.

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.

Manage Communications
Manage Communications

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.

Default Import Folder
Default Import Folder

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.

Setup Data Transfer Details
Setup Data Transfer Details
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:

Example Message
Example Message

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

Example Patient
Example Patient

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:

Services Window
Services Window

The following statuses are displayed for each service:

Icon Status Description
Stopped The service is stopped. Double-click the service to start it.
Running The service is running. Double-click the service to stop it.
Error The service is disabled, the status could not be determined, or it is not installed.

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:

Icon Command Description
Start All Start all Primary Sense services.
Stop All Stop all Primary Sense services.
Extract Run the data extraction process.
Use this option to test the Extraction process works.
Process Messages Run the HL7 Message process.
Use this option to test the HL7 Message process works.
Windows Services Open the Microsoft Windows Services console.
Use this option to further configure the services.

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

Service Statuses
Service Statuses

Advanced Settings

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

Advanced Settings
Advanced Settings

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:

Setting Description Default Value
Command Timeout Maximum time (in seconds) to run database queries. 300 Seconds
Environment Use the production or test environment. PHM
HL7 Import Folder Folder to place HL7 Message files into.

C:\ProgramData\Primary Sense\Messages\In

Note that older installs may be set to:
C:\ProgramData\Primary Sense\Messages
Telemetry Send error and logging details to Primary Sense.

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:

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.

Verification Log List
Verification Log List

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.

Note: If an Error 1001 occurs during uninstallation, please contact Primary Sense Support for a tool which can manually remove the software.

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.

Service Name Description
PrimarySenseApi Primary Sense™ API Provides data services for the Desktop application and the Extractor and Messages services.
PrimarySenseExtractor Primary Sense™ Extractor Extracts practice software data and sends it to Primary Sense.
PrimarySenseMessages Primary Sense™ Messages Delivers HL7 messages for alerts to the practice.
PrimarySenseUpdateAgent Primary Sense™ Update Agent Checks for and installs software updates.
PrimarySenseUpdater Primary Sense™ Updater Checks for and installs software updates.
Applications

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

Name Description
Primary Sense Services Setup Application to configure settings for the Primary Sense Services. Administrative privileges are required to run the application.
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.

Event Log Event Source Description
Primary Sense Primary Sense API Events generated by the Primary Sense API service.
Primary Sense Primary Sense Extractor Events generated by the Primary Sense Extractor service.
Primary Sense Primary Sense Messages Events generated by the Primary Sense Messages service.
Primary Sense Primary Sense Services Setup Events generated by the Primary Sense Service Setup application.
Primary Sense Primary Sense Update Agent Events generated by the Primary Sense Update Agent service.
Primary Sense Primary Sense Updater Events generated by the Primary Sense Updater service.
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.

Parent Folder
C:\ProgramData\Primary Sense\
Child Folder Description
Logs Contains daily log files. Files are deleted after 30 days. File names are in the format:
[USER]_[SOFTWARE]_[DATE].txt
For example:
SYSTEM_Primary_Sense_Extractor_20200101.txt
Messages\In Contains delivered HL7 message files.
May be changed to another location using the Primary Sense Service Setup application.
Messages\Out Unused: not currently supported.
Settings Contains settings files. Use the Primary Sense Service Setup application to change settings.

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: