Type operation fhir-requests-report

Given a period and an interval, in minutes, produces Parameters resource containing a list of "interval" parameter components, which each contain a list of...

Applies to: AuditEvent

Requires the CanAudit user permission.

Requires the operation URL (http://rosetta.careevolution.com/FHIR/OperationDefinition/AuditEvent-fhir-requests-report) as a scope, or a SMART scope granting read access to the resource type the operation is executed against.

In parameters

Name Cardinality Type Documentation
client-id 0..* String

Optional list of client ids to filter the report to only consider requests from those clients
client-identity-provider-id 0..1 String

Optional client identity provider id to filter the report: consider only requests from clients that are associated with the specified identity provider
client-role-id 0..1 String

Optional role id to filter the report: consider only requests from clients (system users) that have the specified role
endpoint 0..* String

Optional list of endpoint prefixes to filter the report to only include requests to those endpoints
group-by 0..* String

Optional list of fields to group requests by within each interval. Supported values are "endpoint", "client-id", "resource", "request-method", "request-status"
include-failed-requests 0..1 Boolean

Optional boolean value to include failed requests in report results. Defaults to false (exclude failed requests).
interval-minutes 1..1 PositiveInt

The length of the intervals, in minutes, to group the report results
period-end 1..1 Instant

End or "to" date of the report
period-start 1..1 Instant

Start or "from" date of the report
request-method 0..* String

Optional list of HTTP verbs to filter the report to only include requests with those HTTP verbs. Supported values are "GET", "HEAD", "POST", "PUT", "DELETE", "PATCH"
resource 0..* String

Optional list of FHIR resource types to filter the report to only include requests for those resource types

Out parameters

Name Cardinality Type Documentation
from 1..1 DateTime

Start date-time of the report
interval 1..*

Data for each interval
from 1..1 DateTime

Start date-time of the interval
to 1..1 DateTime

End date-time of the interval
distinct_user_count 0..1 Integer

Number of distinct users making requests during the interval (provided if there was at least 1 FHIR request during the interval and no 'group-by' types were requested)
request-count 0..1 Integer

Total number of requests during the interval (provided if there was at least 1 FHIR request during the interval and no 'group-by' types were requested)
elapsed-time-percentiles 0..1

Container for elapsed time percentiles, each part contains the percentile (50, 75, 95, 99) and the corresponding elapsed time in milliseconds (provided if there was at least 1 FHIR request during the interval and no 'group-by' types were requested)
50 1..1 Integer

Elapsed time in milliseconds at the 50th percentile
75 1..1 Integer

Elapsed time in milliseconds at the 75th percentile
95 1..1 Integer

Elapsed time in milliseconds at the 95th percentile
99 1..1 Integer

Elapsed time in milliseconds at the 99th percentile
grouping 0..*

Data for each 'group-by' grouping
client-id 0..1 String

Group by type: client-id
endpoint 0..1 String

Group by type: endpoint
resource 0..1 String

Group by type: resource
request-method 0..1 String

Group by type: request-method
request-status 0..1 Integer

Group by type: request-status
request-count 1..1 Integer

Total number of requests during for the interval grouping
distinct_user_count 1..1 Integer

Number of distinct users making requests for the interval grouping
elapsed-time-percentiles 1..1

Container for elapsed time percentiles, each part contains the percentile (50, 75, 95, 99) and the corresponding elapsed time in millisecond
50 1..1 Integer

Elapsed time in milliseconds at the 50th percentile
75 1..1 Integer

Elapsed time in milliseconds at the 75th percentile
95 1..1 Integer

Elapsed time in milliseconds at the 95th percentile
99 1..1 Integer

Elapsed time in milliseconds at the 99th percentile
to 1..1 DateTime

End date-time of the report