v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Reports

List Reports

get/api/2.0/reports/

Query parameters

document_date__gtstring date-time

Date/time in ISO 8601 UTC format that selects document dates that follow it (exclusive).

document_date__gtestring date-time

Date/time in ISO 8601 UTC format that selects document dates that follow it (inclusive).

document_date__ltstring date-time

Date/time in ISO 8601 UTC format that selects document dates that precede it (exclusive).

document_date__ltestring date-time

Date/time in ISO 8601 UTC format that selects document dates that precede it (inclusive).

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

order_bystring

Which field to use when ordering the results.

patientinteger[]

Multiple values may be separated by commas.

practiceinteger[]

Multiple values may be separated by commas.

reported_date__gtstring date-time

Date/time in ISO 8601 UTC format that selects report dates that follow it (exclusive). It may be null in some cases, use document_date instead.

reported_date__gtestring date-time

Date/time in ISO 8601 UTC format that selects report dates that follow it (inclusive). It may be null in some cases, use document_date instead.

reported_date__ltstring date-time

Date/time in ISO 8601 UTC format that selects report dates that precede it (exclusive). It may be null in some cases, use document_date instead.

reported_date__ltestring date-time

Date/time in ISO 8601 UTC format that selects report dates that precede it (exclusive). It may be null in some cases, use document_date instead.

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}