System operation report-subscription-list

List all report subscriptions of the specified type, most recently created first, with their schedule and the details of the report they send

Requires the CanAudit user permission.

Requires the operation URL (http://rosetta.careevolution.com/FHIR/OperationDefinition/report-subscription-list) as a scope, or a SMART scope granting read access to any resource.

In parameters

Name Cardinality Type Documentation
schedule-type 1..1 String

Schedule type identifier for filtering schedules

Out parameters

Name Cardinality Type Documentation
schedule-summary 0..*

A report subscription

name 1..1 String

Name of the schedule

creation-date 1..1 DateTime

Creation date of the schedule

last-modification-date 0..1 DateTime

Last modification date of the schedule

state 0..1 String

State of the schedule: ENABLED or DISABLED

cron-expression 0..1 String

AWS cron expression the schedule fires on

user-timezone-id 0..1 String

Time zone the cron expression is evaluated in

to-email 0..* String

Email address(es) the report is sent to

user-id 0..1 String

ID of the user that created the subscription; the report runs on their behalf

client-id 0..1 String

ID of the client application the subscription was created from

endpoint 0..1 String

Endpoint the subscription was created from

custom-subject-line 0..1 String

Custom subject line of the report email

report-output-type 0..1 String

Output format of the report

quick-select-period 0..1 Code

Period covered by each report, relative to the time it runs

interval-minutes 0..1 Integer

Length of the intervals, in minutes, the report results are grouped by

period-start-offset-minutes 0..1 Integer

Start of the report period, in minutes before the time the report runs (custom periods only)

period-end-offset-minutes 0..1 Integer

End of the report period, in minutes before the time the report runs (custom periods only)

report-parameter 0..*

Parameter (filter, grouping, ...) passed to the report operation each time it runs

name 1..1 String

Name of the report operation parameter

value 1..1 String

Value of the report operation parameter