patient-read-report-download
Must be executed asynchronously
Runs the patient READ report (see the $patient-read-report operation) for the period and interval, in minutes, as a background export job and produces the whole report as one CSV file: the header line is 'IntervalFrom,IntervalTo,<the report csv-header>', followed by one line per interval and distinct client, user and patient READ access. When the operation completes, its result contains the 'url' to download the file from.
Applies to: AuditEvent
Requires the CanAudit user permission.
Requires the operation URL (http://rosetta.careevolution.com/FHIR/OperationDefinition/AuditEvent-patient-read-report-download) as a scope, or a SMART scope granting read access to the resource type the operation is executed against.
| 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 |
| 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 |
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| expires | 0..1 | Instant |
When the export and its file are purged; absent if exports are not purged |
| export-id | 1..1 | String |
Id of the export producing the CSV file |
| line-count | 1..1 | Integer |
Number of data lines of the CSV file (the header line excluded) |
| url | 1..1 | Url |
Where to download the CSV file from, with the same access token (served to the user that started the operation, or to users that can manage exports) |