[api] Added employee feat (or turnover) API.

paths/population_statistics_employeeFeat.yaml

@@ -0,0 +1,93 @@
+get: 
+  tags: 
+    - Population statistics
+  operationId: populationStatisticsEmployeeFeat
+  summary: Employee turnover
+  description: Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any HIS are ignored. Contract tariff as registered by Zorg op Orde or, if not present, national tariffs as published by the government are used.
+  parameters: 
+    - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
+    - name: periodStart
+      in: query
+      description: Start of the period (including) to summarize.
+      schema: 
+        $ref: ../schemas/date.yaml
+    - name: periodEnd
+      in: query
+      description: End of the period (excluding) to summarize. 
+      schema: 
+        $ref: ../schemas/date.yaml
+    - $ref: '../zoo-api.yaml#/components/parameters/DoctorCodes'
+      description: |-
+        Restricts to the doctors which were medical responsible for the feat. Uses the doctor at the time of the feat, or if not available, the doctor responsible for the patient at the time of the HIS-import. The doctor at the time of the feat is the most accurate.
+
+        The responsible doctor is not written in the response, due the structure of the agreggation.
+    - name: employees
+      in: query
+      description: "Restricts the selection of feats to one or more employees: an employee executed the feat."
+      schema: 
+        $ref: ../schemas/employee-alias.yaml
+    - name: excludeNilDeclarations
+      in: query
+      description: Declarations for which no tariff can determined, or which tariff equals zero, are omitted.
+      schema: 
+        type: boolean
+  responses: 
+    200:
+      description: Returns a object with a dictionary and an array of employees.
+      content: 
+        application/json:
+          schema:
+            type: object
+            properties:
+              dict:
+                $ref: ../schemas/TermsDictionary.yaml
+              employees:
+                type: array
+                items: 
+                  type: object
+                  properties:
+                    alias:
+                      type: string
+                      example: AA
+                    name:
+                      type: string
+                      example: H. Huisman
+                    periods:
+                      type: array
+                      items: 
+                        type: object
+                        properties: 
+                          year:
+                            type: number
+                            example: 2024
+                          month:
+                            type: number
+                            example: 5
+                          feats:
+                            type: array
+                            items: 
+                              type: object
+                              properties: 
+                                vektis:
+                                  $ref: '../schemas/med_dossier/FeatCode.yaml'
+                                alias:
+                                  type: string
+                                  example: C2
+                                count:
+                                  type: number
+                                  description: Count of the number of feats including feats without amount, except if those are excluded, see parameters.
+                                  example: 21
+                                amount:
+                                  type: number
+                                  example: 48342
+    400:
+      $ref: '../zoo-api.yaml#/components/responses/ReqFailure'
+    401:
+      $ref: '../zoo-api.yaml#/components/responses/JwtFailure'
+    403:
+      $ref: '../zoo-api.yaml#/components/responses/NotToBeShare'
+    404:
+      $ref: '../zoo-api.yaml#/components/responses/PatNotFound'        
+
+
+

schemas/TermsDictionary.yaml

@@ -49,3 +49,14 @@ properties:
         "text": "Aluminiumverbindingen"
       "A11GA01":
         "text": "Ascorbinezuur"
+  feats:
+    description: Vektis COD367 list 8 feat codes. The code list may change over time. The codes described here match with those used in the response.
+    type: object
+    additionalProperties: true
+    example:
+      "12001":
+        "text": "Consult regulier 20 minuten en langer"
+      "12904":
+        "text": "Materiaalkosten teststrips bloedsuikerbepaling diabetespati\u00ebnten (waaronder eyetone-teststrips)"
+      "99999":
+        "text": "Onbekende verrichting"

schemas/employee-alias.yaml

@@ -0,0 +1,3 @@
+description: Alias for the doctor, sometimes called _memocode_. Should be an unique identifier for a doctor in a HIS.
+type: string
+example: MH,RZ,AXW

zoo-api.yaml

@@ -56,6 +56,8 @@ paths:
     $ref: 'paths/population_statistics.yaml'
   /population/statistics/deprivedNeighborhood:
     $ref: 'paths/population_statistics_deprived.yaml'
+  /population/statistics/employeeFeat:
+    $ref: 'paths/population_statistics_employeeFeat.yaml'
   /population/frequentUser/count:
     $ref: 'paths/population_frequentUser_count.yaml'
   /population/frequentUser/patients: