Home / Resources / API & integration overview

API & integration, without the guesswork.

For developers · Published 10 June 2026 · Last reviewed: June 2026 · 6 min read

This page is a developer-facing overview of the Catenix API and integration options — enough to plan an integration before you have credentials in hand. The Catenix API is a REST API served over HTTPS with token-based authentication, organised around the same resources you see in the platform.

Resource categories

The API exposes the platform's core records as resources. We describe the categories here rather than specific paths, because endpoint names and fields are confirmed against the live reference during onboarding:

  • Patients & encounters — the people being tested and the visits that group their results.
  • Orders — what has been requested for an encounter.
  • Results — values, units and the analyser-supplied status and flags, carried verbatim.
  • Devices & fleet status — connected analysers and the health of the edge agents that feed them.
  • QC — quality-control runs captured alongside the results they govern, for statistical data-quality monitoring.
  • Documents & reports — generated reports and the documents attached to a record.
  • Webhooks — event subscriptions, including result events, so your system is notified rather than polling.

An illustrative payload

The shape below shows roughly what a result event looks like — useful for picturing the data, not for building against. Field names and structure are confirmed in the live reference:

Webhook · result.created illustrative
// Illustrative shape, not the live schema
{
  "event": "result.created",
  "result": {
    "id": "<opaque-id>",
    "encounter_ref": "<opaque-id>",
    "analyte": "GLU",
    "value": "5.4",
    "unit": "mmol/L",
    "status": "final",
    "device_ref": "<opaque-id>"
  }
}

Integration patterns

Most integrations fall into one of three shapes, depending on who is building:

IVD manufacturers — stream device data in

If you make analysers, the goal is usually to get device output into Catenix cleanly and have it appear with full traceability. That is the connectivity layer's home ground: standards-based capture over the protocols your instruments already speak, with results carried through verbatim. See the IVD manufacturers page and how device connectivity works.

Distributors — white-label and connect catalogues

Distributors typically connect a portfolio of devices and present the platform under their own brand. The API supports onboarding catalogues and connecting fleets across the clinics you serve. See the distributors page for how that partnership works.

Clinic groups — pull results into an existing LIS or EHR

Groups that already run a laboratory information system or EHR usually want POCT results to land there. Catenix delivers over HL7 v2 into an existing LIS and is FHIR-friendly for EHR integration, so results join the record your clinicians already use rather than living in a second window. The devices & integrations page lists the standards involved.

Where interpretation stops

Every resource and every webhook carries data faithfully — value, unit, and the analyser-supplied status and flags, untouched. The API does not interpret results, re-calculate values or emit clinical alerts. Interpretation and decision-making remain with the clinician and the systems they authorise; Catenix moves the data and records the trail.

Getting access

The full API reference — exact endpoints, schemas, authentication detail and webhook event types — is shared during onboarding. To get started, request access through our team and we will scope the integration with you.

← Back to resources

Questions, answered

What developers ask first.

How does authentication work?

The API is served over HTTPS and uses token-based authentication. Credentials are issued to your integration during onboarding and scoped to your tenant, so a token can only ever reach your own data. We share the exact scheme and token lifecycle as part of the integration documentation.

Do you support webhooks for result events?

Yes. Alongside the REST resources you can subscribe to webhooks for events such as a result being created or updated, so your system is notified rather than having to poll. Webhook payloads carry the data verbatim and never include interpretation of clinical values.

Can we pull results into our existing LIS or EHR?

Yes. Clinic groups commonly read results from the API or receive them over HL7 v2 into an existing laboratory information system, and Catenix is FHIR-friendly for EHR integration. We scope the exact feed with you and share the full reference during onboarding.

Build on a clean feed.

Tell us what you're connecting and we'll share the reference and scope the integration with you.