TPP (SystmOne)

SystmOne Client Integration API

TPP's local client-integration interface allowing an approved third-party application to interact with a running SystmOne client. Communication is performed with XML documents (validated against published XSD schemas) sent and received over a TCP socket connection. Documented functions include GetFunctions, GetOrganisationMetaData, GetCurrentActivity, GetCurrentSelection, PatientSearch, GetPatientRecord, UpdatePatientRecord, GetDocument, DeleteFromPatientRecord, GetAppointmentSlots, GetDiary, DataExtract, LaunchFunctionality, and ExitClient. Access requires TPP's Integration Request approval.

GitHub

Documentation

📖
Documentation
https://tpp-uk.com/resources/integration-request/

Other Resources

🔗
Specification
https://raw.githubusercontent.com/api-evangelist/tpp-systmone/refs/heads/main/schemas/SystmOne-Client-Integration-API-v33.4.pdf
🔗
Schema
https://raw.githubusercontent.com/api-evangelist/tpp-systmone/refs/heads/main/schemas/schemas/
🔗
ExampleMessages
https://raw.githubusercontent.com/api-evangelist/tpp-systmone/refs/heads/main/schemas/example-messages-2.zip
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/tpp-systmone/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
aid: tpp-systmone:systmone-client-integration-api
name: SystmOne Client Integration API
description: TPP's local client-integration interface allowing an approved third-party application to
  interact with a running SystmOne client. Communication is performed with XML documents (validated against
  published XSD schemas) sent and received over a TCP socket connection. Documented functions include
  GetFunctions, GetOrganisationMetaData, GetCurrentActivity, GetCurrentSelection, PatientSearch, GetPatientRecord,
  UpdatePatientRecord, GetDocument, DeleteFromPatientRecord, GetAppointmentSlots, GetDiary, DataExtract,
  LaunchFunctionality, and ExitClient. Access requires TPP's Integration Request approval.
humanURL: https://tpp-uk.com/resources/integration-request/
tags:
- Integration
- EHR
- Clinical System
- XML
properties:
- type: Documentation
  url: https://tpp-uk.com/resources/integration-request/
- type: Specification
  url: schemas/SystmOne-Client-Integration-API-v33.4.pdf
- type: Schema
  url: schemas/schemas/
- type: ExampleMessages
  url: schemas/example-messages-2.zip