This endpoint returns the document references available at Metriport which are associated with the
given Patient and match the provided filters, if any.To start a new document
query, see the Start Document Query endpoint.
The start date (inclusive) for which to filter document references - formatted YYYY-MM-DD as per
ISO 8601. If not provided, no start date filter will be applied.
The end date (inclusive) for which to filter document references - formatted YYYY-MM-DD as per
ISO 8601. If not provided, no end date filter will be applied.
Value to search within the document reference and the actual contents of the document (minimum 3 chars). For more details see the “search syntax” section
below.
Show Search syntax
search terms are separated by spaces;
star (*) allows to search using “contains” (pat* will return docs with patient and paternity);
double quotes (") group words into a single term (to add double quotes as part of the content, escape
them with \ like so: ” );
to exclude a term, add the minus sign (-) in front of it (fox -brown will return docs with fox but
without brown on it);
to require a term, add the plus sign (+) in front of it (fox +brown will docs with fox and brown
but also those with brown but no fox);
by default terms are considered as either (or);
to make terms to require all entries (and), append the plus sign (+) in front of every term.
Example search:
quick brown +fox -news "jumps over"
fox must be present
news must not be present
quick, brown, and jumps over are optional
won’t return documents with only jumps or over, unless they are grouped together as jumps over