Merge branch 'customer-care-group-API-improvements'

paths/customer_careprogram.yaml

@@ -7,6 +7,8 @@ get:
     Gets all practices of a care group and their participation in any care program.
     
     Enumerates all practices for which the current customer (user) is responsible in the care group. The customer identified with the JWT must be the group manager. The care group must be responsible for the underlying practices. Some care groups are organized in a way that they are not allowed to process data of the member practices. For these care groups no practices are shown.
+    
+    FUTURE: Soon this API will be updated to allow asking for a single practice; optionally, if a care group's AGB is also provided, the list of care programs contracted by the care group is also provided.
   parameters:
     - name: refDate
       in: query
@@ -19,48 +21,72 @@ get:
       content:
         application/json:
           schema:
-            type: array
+            type: object
-            items:
+            properties:
-              type: object
+              caregroup:
-              properties:
+                type: object
-                practice:
+                properties:
+                  name:
+                    type: string
+                    description: |-
+                      Identifying tag name of the care group.
+                    example: demo_fabel
+                  careprograms:
+                    description: |-
+                      All care programs contracted by the care group. Subtract from this set the active care programs from any practice reported in `practices` to know which care programs they may want to activate.
+                    example:
+                      - OuderenZorg
+                      - DM
+                      - COPD
+                      - HVZ
+                      - VVR
+                    type: array
+                    items:
+                      $ref: '../schemas/CareProgram-enum.yaml'
+              practices:
+                type: array
+                items:
                   type: object
                   properties:
-                    name:
-                      type: string
                     agb:
                       $ref: ../schemas/agb.yaml
+                    name:
+                      type: string
                     gpis:
                       $ref: ../schemas/GPIS.yaml
-                careprograms:
+                    careprograms:
-                  type: array
+                      type: array
-                  items:
+                      items:
-                    type: object
+                        type: object
-                    properties:
+                        properties:
-                      careprogram:
+                          careprogram:
-                        $ref: '../schemas/CareProgram-enum.yaml'
+                            $ref: '../schemas/CareProgram-enum.yaml'
-                      periodStart:
+                          periodStart:
-                        $ref: ../schemas/date.yaml
+                            $ref: ../schemas/date.yaml
-                      periodEnd:
+                          periodEnd:
-                        $ref: ../schemas/date.yaml
+                            $ref: ../schemas/date.yaml
-                      active:
+                          active:
-                        type: boolean
+                            type: boolean
-                        description: True if today is on or after `periodStart` and before `periodEnd`.
+                            description: True if today is on or after `periodStart` and before `periodEnd`.
+                        required:
+                          - careprogram
+                          - periodStart
+                          - active
     '401':
       $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
     '403':
       $ref: '../zoo-api.yaml/#/components/responses/NoAccess'
 post:
-  tags: 
+  tags:
     - Customer management
   operationId: setCustomerCareProgram
   summary: Add a practice to a care program.
   description: |-
-    Allows a care group manager to classify practices into care groups (ziektebeelden, ketens).
+    Allows a care group manager to configure which care programs are actively participated in by a GP practice. (care programs = ziektebeelden, ketens).
     
     The caller must authorize itself as a care group (manager).
     
-    The care group must be allowed to take responsibility for the practices it holds. If not, the request is ignored and an empty Json-object is sent back to the caller. Indicating that processing was not successful.
+    The care group must be allowed to take responsibility for the practices it holds. If not, the request is ignored and an empty Json-object is sent back to the caller, indicating that processing was not successful.
     
     The practice must be one of the care group practices. If not, the request is ignored and an empty Json-object is sent back to the caller.
     
@@ -75,7 +101,7 @@ post:
           type: object
           properties:
             careprogram:
-              description: The kind of care program that the practice participates in. 
+              description: The kind of care program that the practice participates in.
               $ref: '../schemas/CareProgram-enum.yaml'
             agb:
               description: The AGB of the practice (not the doctor).