Skip to main content
GET
Retrieve clinical and genetic lab results for an appointment, along with document references for lab report PDFs. Every biomarker ordered for the appointment appears in the response, so you can track the whole order rather than only what has come back. Read status on each result before using its value:
  • Tests still outstanding appear with status planned while the appointment is in_progress.
  • Results the lab delivered but that must not be used clinically appear with status fault or undeliverable, and carry a status_reason explaining why. A fault result still has its value populated — that value is wrong. Never present it as a finding.
Every received result and document carries the lab_code (tube barcode) it was filed under, and the submissions array lists each laboratory requisition of the draw with its own status — a draw across several tubes or laboratories completes requisition by requisition. Use Download Document to download lab report PDFs referenced in the documents array. You do not need to poll this endpoint. Subscribe to appointment.results.updated or appointment.results.completed webhooks, and call it when an event arrives. Polling still works as a fallback. Requires the results_view scope.

Request

Path parameters

string
required
Unique identifier (UUID) of the appointment to retrieve results for.

Response

On success, the API returns 200 OK with the results object.
string
required
Overall results status. One of:
  • in_progress — some requisitions are still at the laboratory.
  • completed — every requisition has closed and at least one reported.
  • fault — every requisition died without reporting. Nothing is owed.
object[]
required
One entry per laboratory requisition — a draw spanning several tubes or laboratories has several. The top-level status is completed once every entry has closed and one reported.
object[]
required
Array of clinical biomarker results.
object[]
required
Array of genetic biomarker results.
object[]
required
Lab report documents. Use GET /api/v1/documents/{id} to download each file.

Error responses