TPP SystmOne Adapter for QuickFHIR
1.0.0 - draft

TPP SystmOne Adapter for QuickFHIR - Local Development build (v1.0.0). See the Directory of published versions


Official URL: Version: 1.0.0
Draft as of 2023-07-18 Computable Name: TppSystmOne


The TPP SystmOne Adapter for QuickFHIR provides an HL7 FHIR API for the TPP SystmOne clinical system.


A consumer can search for patients within the EHR and retrieve demographic and clinical information relating to the patient.

In addition, the consumer can write a batch of information to the EHR that will be recorded as a new encounter within the patient record.

Terms of use

The adapter uses components provided through NHS Frameworks to read and write data.

The adapter can only be used as part of an accredited IM1 product. Contact NHS Digital for more details about accrediting your product.

Where an endpoint is provided as a component of a Black Pear product that has already been accredited by NHS Digital, no further accreditation is required.


Each TPP SystmOne instance (e.g. GP practice) requires configuration before use, with an API user setup in SystmOne.

An API user must be created within TPP SystmOne to allow the adapter to read/write data (instructions)

The following details will be provided to enable Black Pear to complete the configuration:

  • Practice ODS code
  • Username
  • API Password

Black Pear will test the connection to confirm that the TPP SystmOne instance is correctly connected.

Operational dependencies

SystmOne Client API service

The adapter depends on the SystmOne Client API service, a proprietary XML web-services endpoint on the SystmOne Gateway instance. If this service becomes unavailable, the adapter will not be able to respond to requests.

SystmOne API user

The adapter depends on the API user created within SystmOne. On occasion, users inadvertently adjust the settings which means the adapter is unable to respond.

Black Pear will monitor connections to confirm that they are healthy and notify you in the event of problems.