Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Modelling overview - Reporting model

The reporting service is a FHIR server that provides REST endpoints for extracting ehealth data. Data is returned as a FHIR Binary resource with a content element containing the data in zip compressed JSON format (application/gzip-json).

Reporting REST endpoints

Each type of report has two endpoints:

  • $fetch-<reportname>

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

  • $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.

Currently the following reports are supported:

Report parameters

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

  • NONE 

    • the data is returned without modification

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

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

  • organization

  • period

  • patient

  • practitioner

  • condition

  • devicetype

  • status

  • seller

The availability and semantics of each parameter is defined on individual report level. See IG Operations for details.

Report security

The access to the reporting endpoints are restricted by security privileges:

  • $fetch-<reportname>

    • if granted, this will allow a user to run and schedule the report.

  • report-non-anonymized - if granted, this will allow a user to fetch or schedule reports with no anonymization.

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

For practitioners, only data from the practitioners organization will be included. The organization parameter is mandatory in this case. 

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

Report structure and format

Report data is returned as a FHIR Binary resource (See http://hl7.org/fhir/STU3/binary.html) with the following elements:

  • contentType

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

  • securityContext

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

  • content

    • the report data

A report content contains a report header file and zero or more report group files, and the files are put in a zip archive in a directory structure:

  • directory: <name><timestamp>

    • file: ReportHeader

    • directory: <groupname> 

      • files: <group1>

      • file: <group2>

      • ...

      • file: <groupN>

The report header file, ReportHeader, contains a JSON object with elements:

  • reportName

  • reportTime

  • 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, 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.

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
  }
}


See IG Example operations  for more examples

Reporting service configuration

The configuration of the reporting service determines:

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

  • The schedule for batch execution.

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


  • No labels