System operation resources-count-report

Generate a report of counts of FHIR resources in the system, grouped by resource type and optionally by time intervals (using resource "_lastUpdated") and resource data source. This operation is intended to be used for reporting and monitoring purposes.

In parameters

Name Cardinality Type Documentation
group-by-source 0..1 Boolean

Whether to group counts by source in addition to resource type. If not specified, counts will not be grouped by source.

interval-minutes 0..1 PositiveInt

The interval in minutes for grouping resources by time. If not specified, resources will not be grouped by time.

period-end 0..1 Instant

The end of the period to include in the report. If not specified, all time will be included.

period-start 0..1 Instant

The start of the period to include in the report. If not specified, all time will be included.

resource-type 0..* String

The resource type(s) to include in the report. If not specified, all resource types will be included.

source 0..* String

The source(s) to filter the resources to count by (regardless of whether or not grouped by source). If not specified, all sources are included.

Out parameters

Name Cardinality Type Documentation
from 1..1 DateTime

Start date-time of the report

interval 1..*

Container for interval results.

from 1..1 DateTime

The start of the interval.

to 1..1 DateTime

The end of the interval.

total-count 1..1 Integer

The total count of resources in this interval.

resource-grouping 0..*

Container for resource groupings

resource-type 1..1 String

The resource type for this grouping

source 0..1 String

The source for this grouping, supplied if grouping by source is enabled and the resources in this grouping have a source value

count 1..1 Integer

The count of resources in this grouping

to 1..1 DateTime

End date-time of the report