From 1301918fce85b575e80af62644ce6ab421ad5fce Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Tue, 4 Jun 2024 14:24:25 +0200
Subject: [PATCH] [api] Added docs for call-up status API.

---
 paths/qoc_checkupList_set_status.yaml | 68 +++++++++++++++++++++++++++
 schemas/CallUpStatus-enum.yaml        |  6 +++
 zoo-api.yaml                          |  2 +
 3 files changed, 76 insertions(+)
 create mode 100644 paths/qoc_checkupList_set_status.yaml
 create mode 100644 schemas/CallUpStatus-enum.yaml

diff --git a/paths/qoc_checkupList_set_status.yaml b/paths/qoc_checkupList_set_status.yaml
new file mode 100644
index 0000000..7319dda
--- /dev/null
+++ b/paths/qoc_checkupList_set_status.yaml
@@ -0,0 +1,68 @@
+post:
+  tags:
+    - Quality of Care
+  operationId: setPatientCallUpStatus
+  summary: Set call-up status for patients in a care program.
+  requestBody: 
+    description: |-
+      The request is designed to set the status of several patients, specified by patId (mensId) or BSN, at once. The end point is idem potent for the combination of careprogram, callUpStatus and BSN or patId. That means that the call-up status for a patient in a certain care program is just set once, until a new status is set. As a consequence only the employee who set first a certain status is stored, until somebody else (or the same employee) overwrites the status.
+    content: 
+      'application/x-www-form-urlencoded':
+        schema:
+          type: object
+          properties: 
+            careprogram:
+              $ref: '../schemas/CareProgram-enum.yaml'
+            callUpStatus:
+              $ref: '../schemas/callUpStatus-enum.yaml'
+            employee:
+              type: string
+              description: Any string is accepted, but it is recommended to use a employee code derived from this API.
+            bsns:
+              type: array
+              items:
+                $ref: '../schemas/pat-BSN.yaml'
+                maxItems: 10000
+              example: 612345671,123456782,123456789
+              description: A list of BSN's or a list of patId's must be provided and not both at the same time, but one of them must be present.
+            patIds:
+              type: array
+              items:
+                $ref: '../schemas/pat-patId.yaml'
+                maxItems: 10000
+              example: 10012,32122,1212
+              description: A list of BSN's or a list of patId's must be provided and not both at the same time, but one of them must be present.
+          required: 
+            - careprogram
+            - callUpStatus
+            - employee
+          minItems: 4
+  responses:
+    '200':
+      description: |-
+        BSN's or patId's which are actually updated. BSN's or patId's which were not known in the HIS are ignored. The caller should determine the difference between the two sets to get the ignored patients.
+      content: 
+        'application/json':
+          schema: 
+            type: object
+            properties: 
+              bsns:
+                type: array
+                items: 
+                  type: integer
+                example:
+                  - 612345671
+                  - 123456782
+              patIds:
+                type: array
+                items:
+                  type: integer
+                example: 
+                  - 10012
+                  - 32122
+            minItems: 1
+            maxItems: 1
+    '401':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
+    '403':
+      $ref: '../zoo-api.yaml#/components/responses/NoAccess'
\ No newline at end of file
diff --git a/schemas/CallUpStatus-enum.yaml b/schemas/CallUpStatus-enum.yaml
new file mode 100644
index 0000000..728934c
--- /dev/null
+++ b/schemas/CallUpStatus-enum.yaml
@@ -0,0 +1,6 @@
+type: string
+enum:
+  - open
+  - callUp
+  - dontCallUp
+  - scheduled
\ No newline at end of file
diff --git a/zoo-api.yaml b/zoo-api.yaml
index 0358d6a..27cc8e1 100644
--- a/zoo-api.yaml
+++ b/zoo-api.yaml
@@ -70,6 +70,8 @@ paths:
     $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/indicator/{setKey}/{indicatorKey}/patients:
     $ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml'
   /qoc/indicator/{setKey}/{indicatorKey}/participants: