fhir-requests-report-subscribe
Subscribe to regular FHIR requests report email notifications
Applies to: AuditEvent
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| client-id | 0..* | String |
Optional list of client ids to filter the report to only include requests from those clients |
| client-identity-provider-id | 0..1 | String |
Optional client identity provider id to filter the report: include only requests from clients that are associated with the specified identity providers |
| client-role-id | 0..1 | String |
Optional role id to filter the report: include only requests from clients (users) that have the specified role |
| cron-expression | 1..1 | String |
Cron expression used to schedule fhir requests report operation execution events |
| custom-subject-line | 0..1 | String |
Custom subject line to use for the report email notifications. If not provided, a default subject line will be used. |
| 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 "request-method", "client-id", "resource", "request-method" |
| interval-minutes | 1..1 | PositiveInt |
The length of the intervals, in minutes, to group the report results |
| period-end-offset-minutes | 0..1 | PositiveInt |
The number of minutes before the operation execution time to end the reporting period (e.g. '0' for current operation execution time) |
| period-start-offset-minutes | 0..1 | PositiveInt |
The number of minutes before the operation execution time to start the reporting period (e.g. '60' for 1 hour before) |
| quick-select-period | 1..1 | Code |
Quick select period for the report. Allowed values are Custom|LastHour|LastDay|PastWeek|Past4Weeks|CurrentCalendarWeek|CurrentCalendarMonth|CurrentCalendarQuarter|LastCalendarWeek|LastCalendarMonth|LastCalendarQuarter|YearToDate. |
| report-output-type | 0..1 | Code |
The type of the operation results reports. Only "CSV" is currently supported and it is the default |
| 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 |
| schedule-name | 1..1 | String |
The name of the schedule for which the report subscription will be created. It is used to identify the schedule when updating or deleting the subscription. |
| to-email | 1..* | String |
Destination email address to receive the operation report results |
| user-timezone-id | 0..1 | String |
The IANA time zone ID to use for interpreting the period start and end offsets. If not provided, UTC time will be used. |
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| message | 1..1 | String |
A message indicating the result of the operation |