API Reference

Integration endpoints for connecting external systems to Path.systems. This reference covers the REST webhook endpoint, HL7 MLLP connection details, and CSV billing export.

REST Webhook Inbound Endpoint

External systems can push data into Path.systems by posting JSON payloads to your organization's inbound webhook endpoint.

Endpoint

URL

POST https://api.path.systems/api/webhook/inbound/:orgId

Authentication

Requests must include a valid API key in the Authorization header. Generate API keys in Settings → Integrations when configuring a webhook integration.

Headers

Authorization: Bearer <integration-api-key>
Content-Type: application/json

Request Body

The request body should be a JSON object. The expected structure depends on the type of data being sent (results, orders, etc.). Contact Path.systems support for payload format documentation specific to your integration use case.

Example Request

POST /api/webhook/inbound/org_abc123
Authorization: Bearer wh_key_xxxxxxxx
Content-Type: application/json

{
  "type": "result",
  "lab_reference": "LR-00142",
  "patient_id": "8801015800082",
  "tests": [
    {
      "code": "FBC",
      "name": "Full Blood Count",
      "results": [
        {
          "component": "WBC",
          "value": "8.4",
          "unit": "10^3/uL",
          "reference_range": "4.0-11.0",
          "flag": "N"
        }
      ]
    }
  ]
}

Response

Status	Description
200 OK	Payload received and queued for processing
401 Unauthorized	Missing or invalid API key
400 Bad Request	Malformed JSON or missing required fields
404 Not Found	Organization ID not found
500 Internal Server Error	Unexpected server error — retry the request

Success Response

{
  "status": "ok",
  "message_id": "msg_01HXYZ..."
}

HL7 MLLP Connection

Path.systems operates an MLLP server for receiving HL7 v2.x messages (typically ORU^R01 results) and can send HL7 messages (typically ORM^O01 orders) to external MLLP listeners.

Inbound Connection Details

Provide these details to systems that need to send HL7 messages to Path.systems:

Parameter	Value
Host	hl7.path.systems
Port	2575
Protocol	MLLP
TLS	Supported (optional)
Routing	Messages are routed by the Receiving Facility in the MSH segment

IP Allowlist

When the IP allowlist is enabled for your organization, only connections from allowlisted IP addresses will be accepted. Configure this in Settings → Integrations.

Outbound Connection

To send HL7 orders to an external system, configure an outbound HL7 MLLP integration in Settings → Integrations with the remote host, port, and TLS settings. Path.systems will parse the ACK response (AA = accepted, AE = error, AR = rejected) and update the message status accordingly.

Supported Message Types

Message Type	Direction	Description
ORM^O01	Outbound	Order message — sent to reference labs when a lab request is created
ORU^R01	Inbound	Unsolicited result — received from reference labs or instruments
ACK	Both	Acknowledgement — sent/received to confirm message receipt

CSV Billing Export

Billing data can be exported as CSV from the Billing section of the application. The export includes all billing-relevant fields for the selected requests.

How to Export

Navigate to Billing, filter requests by date range, status, or payment type, then click Export CSV to download the file.

Included Fields

Field	Description	Example
patient_name	Patient full name	John Smith
patient_id	SA ID number	8801015800082
account_number	Patient account number	MAN1SG5
medical_aid	Medical aid scheme name	Discovery Health
medical_aid_number	Membership number	12345678
medical_aid_plan	Plan / option	KeyCare Plus
referring_doctor	Referring doctor name	Dr A. Patel
practice_number	HPCSA practice number	MP0123456
icd10_code	ICD-10 diagnosis code	D50.9
tariff_code	GEMS tariff code	3755
test_description	Test name	Full Blood Count
amount	Amount in Rands	350.00
service_date	Date of specimen collection	2026-03-21
lab_reference	Lab reference number	LR-00142
payment_type	Cash or Medical Aid	medical_aid
status	Request status	completed

A JSON billing payload with the same field set can also be generated for API-based billing integrations. See the Integrations documentation for configuration details.

Security & Compliance→