From 765583ccbfc2bea067e67fcccae594cdbc14c7e5 Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Tue, 18 Jun 2024 11:39:19 +0200
Subject: [PATCH] Docs for customer care program GET added.

---
 paths/customer-careprogram.yaml | 30 ++++++++++++++++++++++++++++++
 zoo-api.yaml                    |  7 +++++--
 2 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 paths/customer-careprogram.yaml

diff --git a/paths/customer-careprogram.yaml b/paths/customer-careprogram.yaml
new file mode 100644
index 0000000..0a739e3
--- /dev/null
+++ b/paths/customer-careprogram.yaml
@@ -0,0 +1,30 @@
+get:
+  operationId: customercareProgram
+  tags:
+    - Customer management
+  summary: All practices and their participation in care programs.
+  description: |-
+    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, otherwise the API will respond with a HTTP not authorized response. The care group must also 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. These groups are ignored by this API and produce empty output.
+  responses:
+    '200':
+      description: All practices for which the care group takes responsibility.
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              type: object
+              properties:
+                practice:
+                  description: The name of the practice.
+                  type: string
+                careprograms:
+                  type: array
+                  items:
+                    $ref: '../schemas/CareProgram-enum.yaml'
+                gpis:
+                  $ref: '../schemas/GPIS.yaml'
+    '401':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
+    '403':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAccess'
diff --git a/zoo-api.yaml b/zoo-api.yaml
index 6fcaf29..84e5c20 100644
--- a/zoo-api.yaml
+++ b/zoo-api.yaml
@@ -41,6 +41,7 @@ tags:
       - Care programs that are shown by default to this customer which they did not explicitly unfavourite.
 
       As well as a 'config' view where they see _all_ care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default.
+  - name: Customer management
 paths:
   /patient/dossier:
     $ref: 'paths/patient_dossier.yaml'
@@ -64,12 +65,12 @@ paths:
     $ref: 'paths/population_frequentUser_patient.yaml'
   /qoc/careprogram:
     $ref: 'paths/qoc_careprogram.yaml'
-  /qoc/indicatorset/{setKey}:
-    $ref: 'paths/qoc_indicatorset_{setKey}.yaml'
   /qoc/checkupList/{setKey}:
     $ref: 'paths/qoc_checkupList_{setKey}.yaml'
   /qoc/checkupList/setStatus:
     $ref: 'paths/qoc_checkupList_set_status.yaml'
+  /qoc/indicatorset/{setKey}:
+    $ref: 'paths/qoc_indicatorset_{setKey}.yaml'
   /qoc/indicator/{setKey}/{indicatorKey}/patients:
     $ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml'
   /qoc/indicator/{setKey}/{indicatorKey}/participants:
@@ -78,6 +79,8 @@ paths:
     $ref: 'paths/qoc_list-groups.yaml'
   /qoc/participating-practices:
     $ref: 'paths/qoc_participating-practices.yaml'
+  /customer/careprogram:
+    $ref: 'paths/customer-careprogram.yaml'
 components:
   parameters:
     Authorization: