Content Comparison

...

• $fetch-<reportname>

  • run report - run report synchronously and return resource with result.

• $execute-<reportname>

  • run Run report - run report asynchronously. The returned result is an empty placeholder that identifies the resource to be retrieved later. When finished, the resource will be updated with the result. The report will be stored in the database and will be available for retrieval.

• $schedule-<reportname>

  • schedule Schedule report - schedule a report for later batch execution. The returned result is an empty placeholder that identifies the resource to be retrieved later. When the batch is run, the resource will be updated with the result. The report will be stored in the database and will be available for retrieval. The scheduled reports will be generated during the night, and will usually be available the next morning.

An additional endpoint is provided for retrieving the status of asynchronously executing reports (execute , or schedule):

• $get-report-job-status

Currently ,the following operations are supported:

...

All reports require a parameter anonymization that defines the anonymization anonymisation level of the data returned. Currently only two modes are available:,

• NONE - the data is returned without modification

• ANONYMIZED - the data is anonymized anonymised by removing identifying information from patient resources, and encrypting all resource idsIDs.

Each report endpoint may accept a number of other parameters for conditionally restricting the data included in the report. For example:

...

The report (fetch|execute|schedule)-questionnaireresponses takes a parameter _partition. It controls the bin size of query partitions and is made available for internal use during testing to be able to determine the optimal configuration. When the optimal partition size has been determined, the value of partition size will be determined by the deployment configuration.the

The availability and semantics of each parameter is are defined on an individual report level. See the operations listed above for details.

...

Report data is returned as a FHIR Binary resource with the following elements:

• contentType

  • the The mime type of the content (application/gzip-json)

• securityContext

  • a reference identifying the user that who requested the report. This restricts the retrieval of the report to the user.

• content

  • the The report data in base64 zip compressed JSON format (application/gzip-json)

...

• reportName

• reportTime

• parameters

EgE.g.. a report header returned by $fetch-careplan-customization-stats:

...

Each report group file is named by the id ID of the grouping data element. The type of grouping data element depends on the report type. It may be a FHIR resource, a FHIR bundle, an SSL resource, or a report summary type.

Each group file includes the grouping resource , and one or more related resources, depending on the type of report.

EgE.g... a report group returned by $fetch-careplan-customization-stats containing plan definition (group resource) and careplan customization summary:

...

• $fetch-<reportname>- when granted, a user is authorized authorised to perform the fetch, execute and schedule version of the report.

• report-non-anonymized - when When granted, a user is authorized to fetch or schedule reports with no anonymizationanonymisation.

The reporting service can be configured to disallow the fetch operation for selected report endpoints. This would be relevant if the operation is expected to exceed the normal request timeout (10 secseconds).

For system users, reports may include data from all managing organizationsorganisations. The organization parameter is optional in this case.

For practitioner users, only data from the practitioner's organization organisation will be included. The organization organisation parameter is mandatory in this case. 

Reports stored in the database can only be retrieved if the user is identical to the user that who scheduled or executed the report.

...