From b535350b9a9fb5e8dd7d0532ae62f3235d9fbc48 Mon Sep 17 00:00:00 2001 From: Eric Hoekstra Date: Tue, 17 Sep 2024 08:07:27 +0200 Subject: [PATCH] Added an explanation about the cache. --- .../qoc_indicator_{setKey}_{indicatorKey}_participants.yaml | 4 ++-- schemas/IndicatorParticipants.yaml | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml b/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml index e93e9f4..cd9bef9 100644 --- a/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml +++ b/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml @@ -3,7 +3,7 @@ get: tags: - Quality of Care summary: Indicator, practice details - description: Show per-practice details for each practice in a group for a specific indicator + description: Show per-practice details for each practice in a group for a specific indicator. parameters: - name: setKey in: path @@ -14,7 +14,7 @@ get: example: ZEL-dm - name: indicatorKey in: path - description: The key as listed in the indicatorset. + description: The key as listed in the indicator set. required: true schema: type: string diff --git a/schemas/IndicatorParticipants.yaml b/schemas/IndicatorParticipants.yaml index eed88fc..75c3e8d 100644 --- a/schemas/IndicatorParticipants.yaml +++ b/schemas/IndicatorParticipants.yaml @@ -91,6 +91,11 @@ properties: - amplitude - population - values + cache: + type: boolean + description: |- + If true, the indicator was retrieved from the API cache. The indicator is only retrieved from the cache if there is no recent calculation available in the database and if the indicator won't change anymore. This is the case when it was calculated with a reference date in the past and for which a certain period no new HIS-data is provided. The cached indicator reflects the indicator definition on the reference date. A cached indicator is not updated when the definition changes. + example: true required: - group - key