Added array of all possible care programs to customer care program API.

paths/customer_careprogram.yaml

@@ -23,29 +23,46 @@ get:
             items:
               type: object
               properties:
-                practice:
+                caregroup:
-                  type: object
+                  type: string
-                  properties:
+                  description: Identifying tag name of the care group.
-                    name:
+                  example: demo_fabel
-                      type: string
+                practices:
-                    agb:
-                      $ref: ../schemas/agb.yaml
-                    gpis:
-                      $ref: ../schemas/GPIS.yaml
-                careprograms:
                   type: array
                   items:
                     type: object
-                    properties:
+                    properties: 
-                      careprogram:
+                      agb:
-                        $ref: '../schemas/CareProgram-enum.yaml'
+                        $ref: ../schemas/agb.yaml
-                      periodStart:
+                      name:
-                        $ref: ../schemas/date.yaml
+                        type: string
-                      periodEnd:
+                      gpis:
-                        $ref: ../schemas/date.yaml
+                        $ref: ../schemas/GPIS.yaml
-                      active:
+                      careprograms:
-                        type: boolean
+                        type: array
-                        description: True if today is on or after `periodStart` and before `periodEnd`.
+                        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':