Type operation patient-read-report

Given a period and an interval, in minutes, produces a Parameters resource containing a list of "interval" parameter components, which each contain a list of parameter components containing (in CSV format) the client, user and patient details of each distinct READ access. The report is paged per interval: each interval returns at most 'page-size' lines and, when it has more lines, a 'next' continuation token; calling the operation again with the interval's from/to as the period and that token as the 'next' parameter returns the next page of the interval. Intervals without READ accesses are omitted.

Applies to: AuditEvent

Requires the CanAudit user permission.

Requires the operation URL (http://rosetta.careevolution.com/FHIR/OperationDefinition/AuditEvent-patient-read-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

interval-minutes 0..1 PositiveInt

The length of the intervals, in minutes, to group the report results

next 0..1 String

Continuation token of an interval, returned by a previous call: returns the next page of lines of that interval. The period must be the interval's from/to, and 'interval-minutes' is ignored (it is required otherwise)

page-size 0..1 PositiveInt

Maximum number of lines per interval per call (default 100, max 1000)

period-end 1..1 Instant

End or "to" date of the report

period-start 1..1 Instant

Start or "from" date of the report

Out parameters

Name Cardinality Type Documentation
csv-header 1..1 String

Comma-separated header for the interval data - details which data is in each report data line

from 1..1 Instant

Start instant of the report

interval 0..*

Data for each interval with READ accesses

from 1..1 Instant

Start instant of the interval

to 1..1 Instant

End instant of the interval

line 0..* String

Data for this interval (client name and id, user name and id and alternate id, patient details) as a comma-separated string

next 0..1 String

Continuation token to pass as the 'next' parameter, with the interval's from/to as the period, to get the next page of lines of the interval; absent when the interval has no more lines

to 1..1 Instant

End instant of the report