Skip to main content

patients

This query fetches a collection of patients that match the supplied search criteria. 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.

patients(
  search: String
  pagination: Pagination
  cursorPagination: CursorPagination
  options: QueryOptions
): PatientData

Arguments​

patients.search ● String scalar​

patients.pagination ● Pagination input​

patients.cursorPagination ● CursorPagination input​

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

patients.options ● QueryOptions input​

Type​

PatientData object​

A collection of patient data and how this data are paginated. With offset pagination, pageInfo is a standard PageInfo. With cursorPagination, pageInfo uses the PageInfoForCursorPagination shape (pageSize and hasMore only; page is unset).