# SystmOne Client Integration API

**Canonical:** https://apis.io/apis/tpp-systmone/systmone-client-integration-api/  
**Provider:** TPP (SystmOne) — https://apis.io/providers/tpp-systmone/  
**Documentation:** https://tpp-uk.com/resources/integration-request/

SystmOne Client Integration API is one of 6 APIs that [TPP (SystmOne)](https://apis.io/providers/tpp-systmone/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Integration, EHR, Clinical System, and XML. The published artifact set on APIs.io includes API documentation.

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.

## Machine-readable artifacts (5)

- **Documentation** — https://tpp-uk.com/resources/integration-request/
- **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

## Other TPP (SystmOne) APIs (5)

- [SystmOne Patient Facing Services (PFS) API](https://apis.io/apis/tpp-systmone/systmone-pfs-api/)
- [SystmOne Generic HTML API](https://apis.io/apis/tpp-systmone/systmone-generic-html-api/)
- [SystmOne Telephony API](https://apis.io/apis/tpp-systmone/systmone-telephony-api/)
- [Interface Mechanism 1 (IM1)](https://apis.io/apis/tpp-systmone/im1-interface-mechanism-1/)
- [GP Connect (FHIR)](https://apis.io/apis/tpp-systmone/gp-connect/)

## Tags

Integration, EHR, Clinical System, XML

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/tpp-systmone/systmone-client-integration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/tpp-systmone/.