Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

This is a description of the API for extracting statistics, management & usage reports as well as complete reports about individuals.

Reporting REST Endpoints

Each type of report has two endpoints:

...

Currently the following operations are supported:

Operation Input - Report Parameters

...

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

Code Block
{
  "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.

...

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

Code Block
{
  "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:

...