From 4080de0fbf7ca61977bbd6ffaa0064789125dc97 Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Tue, 10 Sep 2024 17:21:03 +0200
Subject: [PATCH] Added properties on indicator (set) as a consequence of the
 indicator calculation cache.

---
 paths/qoc_indicatorset_{setKey}.yaml |  1 -
 schemas/Indicator.yaml               |  3 ++
 schemas/IndicatorSet.yaml            | 43 ++++++++++++++++++++++++++++
 3 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/paths/qoc_indicatorset_{setKey}.yaml b/paths/qoc_indicatorset_{setKey}.yaml
index cdd718f..c188dd5 100644
--- a/paths/qoc_indicatorset_{setKey}.yaml
+++ b/paths/qoc_indicatorset_{setKey}.yaml
@@ -39,4 +39,3 @@ get:
       $ref: '../zoo-api.yaml#/components/responses/NoAccess'
     '404':
       description: The provided `setKey` doesn't refer to a valid program.
-
diff --git a/schemas/Indicator.yaml b/schemas/Indicator.yaml
index 136da06..cbe17e2 100644
--- a/schemas/Indicator.yaml
+++ b/schemas/Indicator.yaml
@@ -173,6 +173,9 @@ properties:
       required:
         - segments
       properties:
+        calculated:
+          description: The timestamp on which the bar was calculated. This can be different from the reference date. Mainly for debugging purposes.
+          $ref: ../schemas/dateTime.yaml
         legend:
           description: |-
             *OPTIONAL* A short *HTML* (dutch) description of the entity+measurement date represented by this bar.
diff --git a/schemas/IndicatorSet.yaml b/schemas/IndicatorSet.yaml
index c1eb890..bd05fe0 100644
--- a/schemas/IndicatorSet.yaml
+++ b/schemas/IndicatorSet.yaml
@@ -30,6 +30,46 @@ properties:
     format: number
     minimum: 0.0
     maximum: 1.0
+  bars:
+    description: Describes the bars in the indicators used in the indicatorGroups.
+    schema:
+    type: array
+    items:
+      type: object
+      properties:
+        calculated:
+          type: object
+          properties:
+            from:
+              description: Timestamp of the oldest indicator calculation in the set.
+              $ref: ../schemas/dateTime.yaml
+            to:
+              description: Timestamp of the newest indicator calculation in the set.
+              $ref: ../schemas/dateTime.yaml
+        population:
+          type: object
+          properties:
+            entity:
+              type: string
+              enum:
+                - gp
+                - tag
+            tag:
+              description: The name of a care group or other population, but never a practice.
+              type: string
+            unid:
+              description: For internal use by Zoo.
+              type: integer
+            snapshotId:
+              description: For internal use by Zoo.
+              type: integer
+        refDate:
+          description: |-
+            Reference date for which the indicators are calculated on the population.
+          $ref: '../schemas/dateTime.yaml'
+        title:
+          description: Title for use in the GUI as a legend for bar.
+          type: string
   chapters:
     description: |-
         Each chapter has a title and contains 1 or more indicators.
@@ -62,3 +102,6 @@ properties:
             type: array
             items:
               $ref: 'Indicator.yaml'
+  cache:
+    description: If true, the indicator set was retrieved from the API cache. This attribute is only for debugging purposes.
+    type: boolean
\ No newline at end of file