...

Reporting REST Endpoints

Each type of report has two three endpoints:

• $fetch-<reportname>

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

• $execute-<reportname>

  • 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 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 for a limited time period. 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:

Operation Input - Report Parameters

...

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

{
  "reportName" : "CarePlanCustomizationStatsReport",
  "reportTime" : "2019-12-04T12:15:17.166804Z",
  "parameters" : {
    "resourceType" : "Parameters",
    "parameter" : [ {
      "name" : "anonymization",
      "valueString" : "None"
    }, {
      "name" : "organization",
      "valueReference" : {
        "reference" : "http://organization.local.ehealth.sundhed.dk/fhir/Organization/52078"
      }
    } ]
  }
}

Each report group file is named by the 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.

...

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

{
  "EHealthPlanDefinition" : {
    "resourceType" : "PlanDefinition",
    "id" : "99949",
    "meta" : {
      "versionId" : "1",
      "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition" ]
    },
    "extension" : [ {
      "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role",
      "extension" : [ {
        "url" : "reference",
        "valueReference" : {
          "reference" : "http://organization.local.ehealth.sundhed.dk/fhir/Organization/37133"
        }
      }, {
        "url" : "role",
        "valueCodeableConcept" : {
          "coding" : [ {
            "system" : "http://ehealth.sundhed.dk/cs/modifier-role",
            "code" : "owner"
          } ]
        }
      } ]
    } ],
    "version" : "fc72966e-68cf-4a4c-a128-1d77e03d6d1f",
    "status" : "active"
  },
  "CarePlanCustomizationSummary" : {
    "timingCustomizationCount" : 1,
    "referenceRangeCustomizationCount" : 1
  }
}

Security

Access to the reporting endpoints is restricted by security privileges:

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

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

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 sec).

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

...

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

Reporting Service Configuration

...

• The availability of synchronous execution (fetch) for each type of report. 

• The schedule for batch execution and retention purge.

• The time retention period that a batch report will remain in the database before being purged.

...