Skip to main content

patientDocuments

This query fetches a collection of patient documents held in the system. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.

patientDocuments(
  search: String
  pagination: Pagination
  cursorPagination: CursorPagination
  options: QueryOptions
  filters: PatientDocumentQueryFilters
): PatientDocumentData

Arguments​

patientDocuments.search ● String scalar​

patientDocuments.pagination ● Pagination input​

patientDocuments.cursorPagination ● CursorPagination input​

Cursor-based pagination alternative to pagination. Mutually exclusive with pagination. Use the last patient document's id as cursor for the next page. Results are always ordered by _id ascending for NEXT (and descending then reversed for PREVIOUS).

patientDocuments.options ● QueryOptions input​

patientDocuments.filters ● PatientDocumentQueryFilters input​

Type​

PatientDocumentData object​

A collection of patient documents and the related pagination information. With offset pagination, pageInfo is a standard PageInfo. With cursorPagination, pageInfo uses the PageInfoForCursorPagination shape (pageSize and hasMore only; page is unset).