Please Note: this area of the Service Delivery Console was previously named Integration API Users
Clinical System Integrations allow Surgery Connect to integrate with your Clinical system and facilitate features such as Check and Cancel and Omni Consultation Forms
This Help guide will walk you through managing Clinical Integrations for both EMIS Web and SystmOne sites:
Accessing your Integration References
To manage the Integration References on your service, navigate to the Service Delivery Console Advanced Tab
Then select Manage Integration References, under Clinical System Integration
Your Integration References are added to your service automatically. Practices with multiple sites and/or ODS codes will have multiple integration references
If you believe you are missing Integration References on your service or cannot see the Clinical System Integration area in the SDC, please contact our Support Team by raising a ticket on the Support Portal
Depending on the Clinical System you use, please follow the below steps:
EMIS Web Sites
Creating an Integration User in EMIS Web
To begin, you will need to create an Integration User in your instance of EMIS Web. Click the Add button in EMIS to get started
User details
The First and Last names you enter for this User will help you identify it within the Clinical System. We would recommend setting these to "SurgeryConnect" and "IntegrationUser" to easily identify it
Set the Username to SurgeryConnect and create a Password
Do not tick "user must change password on next sign in" when the API User is created
You will need to use this Username and Password throughout the setup process
Role
Ensure the following settings are against the new API User:
Job Category to General Medical Practitioner
User Mnemonic to SCCC
Relationship to Employed by Practice
Contract Start Date to current date
Under User Role Profiles please ensure that the RBAC Role is set to Clinical Practitioner Access Role
Click OK
Then, in EMAS Manager, System Tools under Partner API, scroll down to Surgery Connect and select it
At the top, click Edit Users and in the window that opens sort by User Login and find the User you have just created. Click the checkbox and enter the same password as you used to create the user
Click Login Access and in the window that opens click the checkboxes for Auto Login and Allow Login for the User you have just created
Click OK
Managing your Integration References
Navigate to the Service Delivery Console Advanced Tab, and click Manage Integration References on the Clinical System Integration tile
The Integration References screen will show all of the configured references for your site(s), as well as the following information:
The Integration Reference Label
Clinical System Reference
Region
When the reference was created
When the reference has been validated, as well as the date and time of validation. If the reference has not yet been validated, this will be blank
If you're accessing this area for the first time, most of these fields will be blank. To make changes, click the Edit icon on the right hand side
The Edit Window will open. You will need to add the following information:
Label - set this to something easily identifiable, such as the name of the site the reference relates to
Region
The Username for the User you have created in EMIS Web
The Password for the User you have created in EMIS Web
Status Notifications - Any Users, Groups, or email addresses to be notified of any disruption to the connection to the Clinical System. This can be left blank if required
Once you're happy with your changes, click Save Integration Reference
Validating your Integration References
Validating your Integration Reference ensures that the connection between Surgery Connect and the Clinical System works
To validate your Reference, click Validate in the Edit Window
or click the Validate button on the right hand side of the table
If the validation is successful, a notification will appear in the top right hand side of your screen confirming the success
Once complete, the date and time the reference was validated will be added into the table automatically
If the validation is unsuccessful, a notification will appear in the top right hand corner of your screen notifying you of this
The validation date and time will be removed from the table if this is unsuccessful
If this occurs, check that the correct steps have been followed in EMIS Web and the Service Delivery Console and retry
If you continue to get an error message when validating the integration reference, please contact our Support Team by raising a ticket on the Support Portal
SystmOne Sites
Downloading the Gateway Application
Due to the integration requirements of TPP all third-party solutions, such as Surgery Connect, must connect to a physical computer running at the site. This computer is referred to as the "Gateway PC" by TPP, and must be switched on and logged into SystmOne so that services are able to sync data
You should already have a Gateway PC at your site. If you have any questions or concerns accessing this, the IT contact for your site should be able to assist you. The Gateway Application will only need to be downloaded and setup once on this PC
Click HERE to download the Gateway Application
For more information on installing the Gateway Application, see our Help Guide here
Managing your Integration References
Navigate to the Service Delivery Console Advanced Tab, and click Manage Integration References on the Clinical System Integration tile
The Integration References screen will show all of the configured references for your site(s), as well as the following information:
The Integration Reference Label
Clinical System Reference
When the reference was created
When the reference has been validated, as well as the date and time of validation. If the reference has not yet been validated, this will be blank
If you're accessing this area for the first time, the Label and Validated fields will be blank. To make changes, click the Edit icon on the right hand side
The Edit Window will open. You will need to add the following information:
Label - set this to something easily identifiable, such as the name of the site the reference relates to
Status Notifications - Any Users, Groups, or email addresses to be notified of any disruption to the connection to the Clinical System. This can be left blank if required
Once you're happy with your changes, click Save Integration Reference
Validating your Integration References
Validating your Integration Reference ensures that the connection between Surgery Connect and the Gateway Application works
To validate your Reference, click Validate in the Edit Window
or click the Validate button on the right hand side of the table
If the validation is successful, a notification will appear in the top right hand side of your screen confirming the success
Once complete, the date and time the reference was validated will be added into the table automatically
If the validation is unsuccessful, a notification will appear in the top right hand corner of your screen notifying you of this
The validation date and time will be removed from the table if this is unsuccessful
If this occurs, check that the correct steps have been followed for the Gateway Application and the Service Delivery Console and retry
If you continue to get an error message when validating the integration reference, please contact our Support Team by raising a ticket on the Support Portal
























