Skip to content
Wellness Reporting Suitepowered by OLS
Menu

Developers

Three ways in, one report out

Whichever path your laboratory takes, the result is the same cleared report. The API reference below is generated from the server's own description of its API.

  1. 1

    Connect directly (API)

    Your system posts each panel result to one documented endpoint and receives the cleared report back, or a webhook when it clears. One base URL, one key per laboratory, worked examples with fictitious data.

  2. 2

    Upload in the portal

    Enter a case in the guided form, or upload a file for a batch. Validation happens before anything is interpreted, so a missing date or an unrecognized name is caught on the spot.

  3. 3

    We handle delivery

    Prefer not to build anything? We set up delivery into your LIS so the report lands next to the result, and your staff keeps working exactly as today.

The integration guide

Your IT team receives the full onboarding guide at kickoff, with a key for your laboratory and worked examples that use obviously fictitious data. It covers:

  • What the reporting engine does
  • Onboarding at a glance
  • Connecting and authenticating
  • Request limits, response headers, and errors
  • Generating a report
  • Reading the report
  • Input checks and how to resolve them
  • Retrieving the report PDF
  • The pending-review release flow
  • Reference data endpoints
  • Worked examples (fictitious data)
  • Specimen labels, glossary, and quick reference

What every submission carries

The detected organisms and resistance markers, the specimen type, the patient's date of birth and the collection date, and optionally allergies, pregnancy and weight. Names the engine does not recognize, or dates that disagree, are returned with a specific error rather than interpreted on a guess.

What you get back

An opaque result identifier immediately, the report's status as it moves through review, and the cleared PDF once it clears, either by polling or by webhook. Nothing identifying a patient ever appears in a URL.

Public endpoints on this site's API

Generated from the server's OpenAPI document.

  • get /api/health

    Responses: 200

  • post /api/v1/leads

    Responses: 202

  • post /api/v1/results

    Submit a panel result Responses: 200, 202

  • get /api/v1/results

    List results changed since a cursor Responses: 200

  • get /api/v1/results/{id}

    Get one result Responses: 200, 404

  • get /api/v1/results/{id}/pdf

    Download the cleared PDF Responses: 200

  • get /api/v1/health

    Service health Responses: 200

  • get /api/v1/reference/organisms

    Reference list: organisms Responses: 200

  • get /api/v1/reference/genes

    Reference list: genes Responses: 200

  • get /api/v1/reference/specimen-types

    Reference list: specimen-types Responses: 200

  • post /api/v1/provider-deliveries

    Confirm a report reached the ordering provider Responses: 200, 202, 400, 422

  • get /api/v1/webhooks

    List webhook endpoints Responses: 200

  • post /api/v1/webhooks

    Register a webhook endpoint Responses: 201, 400

  • get /api/v1/webhooks/deliveries

    Recent webhook deliveries Responses: 200

Every endpoint under /api/v1 is called with your laboratory's key (Authorization: Bearer). Webhook payloads carry identifiers and state only and are signed with your endpoint's secret. Culture results travel with the submission.

Request the integration guide