Documents

Search a Patient's Documents

Find which of one patient's documents mention something, a page at a time. Send the criteria in the body; every one is optional. A document is found only once the search service has indexed it, so a document just added may not be found yet. Results arrive in the search service's order.

post/documents/search

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/documents/search
  • Auth: HTTP bearer

Query parameters

patientIdstring uuid required

The patient whose documents to search.

pageNumberinteger

The page to answer, counting from 1.

pageSizeinteger

The most documents to answer on a page.

Headers

ProjectIdstring required

The project the patient belongs to.

Request body

textstring

Words to look for in the documents.

documentDateFromstring date

The earliest clinical date of a document to answer, as yyyy-mm-dd, inclusive.

documentDateTostring date

The latest clinical date of a document to answer, as yyyy-mm-dd, inclusive.

sourcesstring[]

How the documents arrived, as the search service names the sources; at most 5.

classificationsstring[]

The classifications the search service assigns documents; at most 20.

Response

One page of the patient's documents the search found.

pageNumberinteger required

The page this is, counting from 1.

pageSizeinteger required

The most documents a page holds.

totalCountinteger required

How many documents the search counted across every page, as the search service counts them.

Changes

No recorded changes to this operation across all 1 revision of this API.