Search activities

Two queries are available for activity lookups:

1. activities: Search activities by status, type, patient, and other criteria.
2. activity: Get a single activity by its ID.

We suggest reading the page on our domain model first to get an understanding of the activity model.

Request

Search activities

Search for activities with various filters including status, type, patient ID, pathway definition, and more.

01

Variables

Required parameters

There are no required parameters for this query. However, you should provide pagination and sorting parameters. See Pagination and Sorting below.

Filters

The filter is optional: if you don't provide one, an unfiltered list of care flows will be returned.

01

All in filters accept a list of values and result in an is any of search criteria. The eq filter accepts a single string and results in is exact match search criteria.

When specifying multiple filters, the resulting criteria is the conjuction of all filters.

01

Pagination and sorting

Pagination and sorting are required for this query. If no pagination values are supplied, the API will return only the first 100 activities, or 100 activities from the specified offset. There is an upper limit of 100 records per query. Please be aware that setting count greater than 100 will successfully execute but return only 100 records.

Default sorting is based on the date field, in descending order (i.e. newest to oldest).

01

Get single activity

Retrieve a single activity by its ID.

Query:

01

Variables:

01

Parameters: