Skip to navigation

results-v1

View as Markdown

List test results

Retrieve a page of laboratory test results with sample context, test codes, reported values, units, and specification text. A sample can have multiple result records; preserve the test context alongside the sample identifier.

Request: GET {{baseUrl}}/{{results}}
Success: 200 OK with a JSON body. The recorded response media type is text/plain;charset=utf-8. No request body is used.

Query parameters

ParameterFormatUsage
api_tokenStringCredential for the selected environment, supplied through {{api_token}}.
pageInteger in the query stringPage to retrieve. The saved request starts at 1.
sample_idStringSample identifier filter. The saved request sends an empty value.
sample_submission_idStringSample-submission row identifier filter. The saved request sends an empty value.
start_dateYYYY-MM-DDStart of the requested date range. Replace the saved example date with your intended range.
end_dateYYYY-MM-DDEnd of the requested date range. Replace the saved example date with your intended range.

Filter requiredness, empty-versus-omitted behavior, matching rules, and filter combinations are unconfirmed. The filtered date field, timezone, and inclusive/exclusive boundaries are also unspecified. Do not assume this range selects collection, submission, or validation dates without confirmation.

Response envelope

FieldObserved typeDescription
pageStringReturned page number, for example "1".
hasNextPageBooleanIndicates whether another page is available.
resultsArray of objectsTest result records in this page.

Keep filters unchanged while paging. Increment page when hasNextPage is true and stop when it is false.

Result fields

Types below reflect the saved response.

FieldObserved typeDescription
sample_idStringDownstream sample identifier. Multiple tests can reference the same sample.
test_nameStringHuman-readable test name.
analyte_groupStringAnalyte grouping associated with the test.
test_codeStringTest catalog code, such as LSP-VID-ENV.
resultStringReported value. Examples include numeric text such as "78" and qualitative text such as "Presumptive".
unitStringReported unit or basis of measurement, such as CFU/exposure or per area swabbed.
specificationStringSpecification text reported by the service, such as in spec; the complete vocabulary is unspecified.
submitted_atStringSubmission date and time as display text.
collected_atStringCollection date and time as display text.
descriptionStringSample description; may be empty.
product_idStringProduct identifier returned by the service.
product_descriptionStringProduct description; may be empty.
lotStringLot reference. Preserve as text.
request_numberStringRequest reference; may be empty.
statusStringStatus returned with the result. completed appears in the saved response; the full set is unspecified.
due_dateStringDue date and time as display text.

Working with results

  • Preserve result as a string. Converting every result to a number loses qualitative values.

  • Store the reported unit and specification with each value; neither is inferred from the result text.

  • Date strings have no timezone offset and are in Central Time (UTC-5).

Saved example

The attached 200 example uses synthetic records to illustrate numeric and qualitative results and hasNextPage: false.

Query parameters

api_tokenstringOptional
pageintegerOptional
sample_idstringOptional
sample_submission_idstringOptional
start_datestringOptional
end_datestringOptional

Response

OK