v1

latestSwagger 2.02026-07-1362109210.4 KB
patient

List patients

Get a list of patients.

get/patient

Query parameters

filter[groups]string

Comma-separated list of group ids. Note that either filter[group] or filter[organization] must be specified.

filter[organization]string

Fitbit Plus organization id. Note that either filter[group] or filter[organization] must be specified.

filter[identifier][system]string

Identifier system (example: "MyEHR") - requires a "filter[identifier][value]" parameter

filter[identifier][value]string

Identifier value (example: "12345") - requires a "filter[identifier][system]" parameter

filter[archived]boolean

If not specified, return all patients. If set to 'true' return only archived patients, if set to 'false', return only patients who are not archived.

filter[created_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for patients created in November 2017 (America/New_York): filter[created_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

filter[updated_at]string

The start (inclusive) and end (exclusive) dates are ISO date and time strings separated by ... Example for patients updated in November 2017 (America/New_York): filter[updated_at]=2017-11-01T00:00:00-04:00..2017-12-01T00:00:00-05:00

page[number]integer

Page number

page[size]integer

Page size

page[limit]integer

Page limit

page[cursor]string

Page cursor

Response

OK