From 29a622d239dab67045860a770806a53f73cb383b Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Mon, 8 Jul 2024 11:37:39 +0200
Subject: [PATCH] Added array of all possible care programs to customer care
 program API.

---
 paths/customer_careprogram.yaml | 57 +++++++++++++++++++++------------
 1 file changed, 37 insertions(+), 20 deletions(-)

diff --git a/paths/customer_careprogram.yaml b/paths/customer_careprogram.yaml
index f85fd56..9888d88 100644
--- a/paths/customer_careprogram.yaml
+++ b/paths/customer_careprogram.yaml
@@ -23,29 +23,46 @@ get:
             items:
               type: object
               properties:
-                practice:
-                  type: object
-                  properties:
-                    name:
-                      type: string
-                    agb:
-                      $ref: ../schemas/agb.yaml
-                    gpis:
-                      $ref: ../schemas/GPIS.yaml
-                careprograms:
+                caregroup:
+                  type: string
+                  description: Identifying tag name of the care group.
+                  example: demo_fabel
+                practices:
                   type: array
                   items:
                     type: object
-                    properties:
-                      careprogram:
-                        $ref: '../schemas/CareProgram-enum.yaml'
-                      periodStart:
-                        $ref: ../schemas/date.yaml
-                      periodEnd:
-                        $ref: ../schemas/date.yaml
-                      active:
-                        type: boolean
-                        description: True if today is on or after `periodStart` and before `periodEnd`.
+                    properties: 
+                      agb:
+                        $ref: ../schemas/agb.yaml
+                      name:
+                        type: string
+                      gpis:
+                        $ref: ../schemas/GPIS.yaml
+                      careprograms:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            careprogram:
+                              $ref: '../schemas/CareProgram-enum.yaml'
+                            periodStart:
+                              $ref: ../schemas/date.yaml
+                            periodEnd:
+                              $ref: ../schemas/date.yaml
+                            active:
+                              type: boolean
+                              description: True if today is on or after `periodStart` and before `periodEnd`.
+                careprograms:
+                  description: All possible care programs for the care group. For every group it known to which programs they are participating. From this set the actual care programs reported in practices property can be substracted to get a list of missing programs.
+                  example:
+                    - OuderenZorg
+                    - DM
+                    - COPD
+                    - HVZ
+                    - VVR
+                  type: array
+                  items:
+                    $ref: '../schemas/CareProgram-enum.yaml'
     '401':
       $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
     '403':