Added an explanation about the indicator set cache.

live
Eric Hoekstra 1 year ago
parent 1105a4a1f2
commit 4ca23d5eb5

@ -2,12 +2,12 @@ get:
operationId: indicatorSet
tags:
- Quality of Care
summary: Indicator report
description: Load an indicator-based report.
summary: Indicator set
description: Provides the data to generate an report showing indicators for a care program. An indicator set holds all indicators for a combination of a care program, reference date and a customer. Care groups and practices see different output based on the same database. The authorisation for the care group to access care program data is taken in account.
parameters:
- name: setKey
in: path
description: The key as listed in the `CareProgram` schema.
description: The key as listed in the [/qoc/careprogram](#tag/Quality-of-Care/operation/carePrograms) response.
required: true
schema:
type: string

@ -1,5 +1,5 @@
description: |-
A report about a care program based on showing a number of ratios, such as 'how many people in your practice have diabetes', or 'for all diabetes patients in your care with a recent blood pressure measurement, how do these blood pressure measurements split into "problematic" / "concern" / "okay" categories
A report about a care program based on showing a number of ratios, such as: "How many people in your practice have diabetes?", or: "For all diabetes patients in your care with a recent blood pressure measurement, how do these blood pressure measurements split into problematic / concern / okay categories?"
type: object
required:
- key
@ -20,7 +20,7 @@ properties:
careprogram:
$ref: '../schemas/CareProgram-enum.yaml'
refDate:
description: 'All calculations are done based on this date (dutch: _peildatum_).'
description: Reference date for which the indicators are calculated on the population (peildatum).
$ref: ./date.yaml
calculating:
description: |-
@ -103,5 +103,5 @@ properties:
items:
$ref: 'Indicator.yaml'
cache:
description: If true, the indicator set was retrieved from the API cache. This attribute is only for debugging purposes.
description: If true, the indicator set was retrieved from the API cache. The set is only retrieved from the cache if there is no recent calculation available in the database and if the set won't change anymore. This is the case for all indicator sets which were calculated with a reference date in the past and for which a certain period no new HIS-data is provided. The cached indicator set reflects the indicator definitions of the reference date. Cached indicators are not updated with new definitions.
type: boolean
Loading…
Cancel
Save