Document Tools
Read the user's health documents, or save results from a report they showed you.
list_documents
The user's health documents (lab reports, body composition scans, test results, imaging and clinical reports), newest change first, with the reading status (reading, needs_you, ready, failed) and a short summary. Use it to find one before get_document.
| Parameter | Notes |
|---|---|
query | Words to search for in titles, summaries and document text |
type | lab, body_composition, performance_test, genetics, imaging_report, sleep_study, procedure_report, clinical_note, general_health or other |
limit | 1 to 50 (default 20) |
Permission: documents:read
get_document
One document: status, type, title, lab, collection date, summary and every result found (name, value, unit, reference range, flag).
| Parameter | Notes |
|---|---|
documentId | Required. From list_documents |
Permission: documents:read
add_document
Saves lab results from a report the user showed you (a PDF or photo you read), when the user asks for it. Send each value exactly as printed. It is saved as an unverified transcription, marked Unverified in Documents, and reaches the user's biomarkers only after they attach the original file at the documentUrl in the answer. The same document again within 10 minutes is saved once.
| Parameter | Notes |
|---|---|
title | Required. Name of the report, e.g. "Quest lipid panel" |
results | Required. Every result: name, value and, when printed, unit, referenceRange and flag (high, low, normal, abnormal or critical). At most 200. |
labName | The lab, as printed |
collectedDate | YYYY-MM-DD |
Permission: documents:write
To upload the PDF itself instead, see Upload lab results.