[indicators] Updated call-up policy API with new call-up policy type.

paths/qoc_checkupPolicy.yaml

@@ -3,8 +3,12 @@ get:
     - Quality of Care
   operationId: getCallupPolicy
   summary: Call-up policy
-  description: Gets all call-up policies of a patient for all indicators in which the patient participates, or for a specific indicator. The caller must supply one of `patUnid` and `bsn`. The `indicatorKey` is optional.
+  description: Gets all call-up policies of a patient for all indicators in which the patient participates, or for a specific indicator.
   parameters:
+    - name: policyType
+      in: query
+      schema:
+        $ref: ../schemas/CallupPolicyType-enum.yaml 
     - name: patUnid
       in: query
       schema: 
@@ -29,11 +33,15 @@ get:
             items: 
               type: object
               properties:
+                policyType: 
+                  $ref: ../schemas/CallupPolicyType-enum.yaml
                 patUnid:
                   $ref: ../schemas/pat-patUnid.yaml
                 indicatorKey:
                   type: string
                   example: ZOO-dm2-hb
+                userId:
+                  type: integer
                 doNotCallupUntil:
                   $ref: ../schemas/date.yaml
                 frequency:
@@ -54,13 +62,15 @@ post:
   operationId: postCallupPolicy
   summary: Call-up policy
   description: |-
-    Set a call-up policy for a combination of a patient and an indicator. A call-up policy for a patient and indicator filters the patient from the call-up list with a certain frequency or until a specific end date has passed. The calculation of the (call-up) indicator is not affected by this setting. It is solely meant as a tool for the general practitioner.
+    Set a call-up policy for a combination of a patient and/ or an indicator. A call-up policy for filters the patient from the call-up list with a certain frequency or until a specific end date has passed. The calculation of the (call-up) indicator is not affected by this setting. It is solely meant as a tool for the general practitioner. A patient is specified using a `patUnid` or a bsn. Both are checked in the GPIS import database for existance.
   requestBody: 
     content: 
       'application/json':
         schema: 
           type: object
           properties:
+            policyType:
+              $ref: ../schemas/CallupPolicyType-enum.yaml
             patUnid:
               $ref: ../schemas/pat-patUnid.yaml
             bsn:
@@ -70,9 +80,11 @@ post:
                 The key of the indicator as listed in the indicator set. The version of the indicator is ignored. That means that any suffix in the form: dash followed by a integer is ignored. The policy is therefore set for a indicator, and not for a specific version of the indicator. E.g. for ZOO-dm2-hb and not for ZOO-dm2-hb<em>-3</em>.
               example: ZOO-dm2-hb-3
               type: string
+            userId:
+              type: integer
             doNotCallupUntil:
               description: |-
-                The first date the patient will be taken in account in a call-up list. This date is always compared to a reference date, which is not necessary today.
+                The first date the patient will be taken (again) in account in a call-up list. This date is always compared to a reference date, which is not necessary today.
               $ref: ../schemas/date.yaml
             frequency:
               $ref: ../schemas/CallupPolicyFrequency.yaml
@@ -82,6 +94,7 @@ post:
             employee:
               $ref: ../schemas/employee-string.yaml
           required:
+            - policyType
             - indicatorKey
             - employee
           oneOf:
@@ -95,14 +108,25 @@ post:
               not: 
                 required: 
                 - patUnid
+  responses:
+    '200':
+      description: If the policy has been processed without any errors.
+    '401':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
+    '403':
+      $ref: '../zoo-api.yaml#/components/responses/NoAccess'
 delete:
   tags:
     - Quality of Care
   operationId: deleteCallupPolicy
   summary: Call-up policy
   description: |-
-    Unset a call-up policy for a combination of a patient and an indicator. This doesn't actual delete a policy, but withdraws all previous set policies.
+    Unset a call-up policy for a combination of a patient and an indicator. This withdraws all previous set policies.
   parameters: 
+    - name: policyType
+      in: query
+      schema:
+        $ref: ../schemas/CallupPolicyType-enum.yaml
     - name: patUnid
       in: query
       schema:
@@ -113,10 +137,15 @@ delete:
         $ref: ../schemas/pat-BSN.yaml
     - name: indicatorKey
       in: query
-    description: The version suffix of the indicator is ignored. 
+      description: The version suffix of the indicator is ignored (if any).
       schema:
         type: string
         example: ZOO-dm2-hb-1
+    - name: reason
+      in: query
+      description: Some random string describing the reason. May be omitted.
+      schema:
+        type: string
     - name: employee
       description: Employee who withdraws the policy for the patient and indicator combination.
       in: query

schemas/CallupPolicyType-enum.yaml

@@ -0,0 +1,7 @@
+description: |-
+  Call-up policy to deviate from the default call-up schema used for patients and/or indicators. A `PatientIndicator` policy allows the practice to set a call-up policy on an indicator limited to a certain patient. `PatientOnly` is a policy for all indicators the patient is involved in. `IndicatorUser` is a policy for a specific indicator, but this policy applies only for a specific practice user (assistant, doctor, etc.).
+type: string
+enum:
+  - PatientIndicator
+  - PatientOnly
+  - IndicatorUser