From e30e8154c9b4c79910d87a00c29c7c7d7c156bfa Mon Sep 17 00:00:00 2001
From: Eric Hoekstra <e.hoekstra@zorgoporde.nl>
Date: Thu, 23 May 2024 15:56:17 +0200
Subject: [PATCH] [api] Added dossier to frequent user patients API.

---
 paths/population_frequentUser_patients.yaml | 45 +++++++++++++--------
 1 file changed, 29 insertions(+), 16 deletions(-)

diff --git a/paths/population_frequentUser_patients.yaml b/paths/population_frequentUser_patients.yaml
index 0a4d5ed..97e92e5 100644
--- a/paths/population_frequentUser_patients.yaml
+++ b/paths/population_frequentUser_patients.yaml
@@ -47,13 +47,13 @@ get:
           $ref: ../schemas/pat-patId.yaml
     - name: pii
       in: query
-      description: "Allow patient personal identifying information in the response. Defaults to false if omitted."
+      description: "Allow personal identifying information in the response. Defaults to false if omitted. If false, only category, doctor, patid, patUnid and feats are in the response. In other words: they are always in the response, but can be extended with other pii properties, see non-required properties below."
       example: true
       schema:
         type: boolean
     - name: limit
       in: query
-      description: "Some integer between 1 and 50. Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range."
+      description: "Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range."
       schema:
         type: integer
         minimum: 1
@@ -67,22 +67,35 @@ get:
             type: array
             items: 
               type: object
+              required:
+                - category
+                - doctor
+                - patid
+                - patUnid
+                - feats
               properties:
-                patId:
-                  type: string
-                  example: 1349
-                lastName:
-                  type: string
-                  example: van Loon - van de Ven
-                  description: Omitted if parameter pii is omitted or false.
+                bsn:
+                  $ref: '../schemas/PatIdentity.yaml#/bsn'
+                name:
+                  $ref: '../schemas/PatIdentity.yaml#/name'
                 gender:
-                  type: string
-                  example: V
-                  description: Omitted if parameter pii is omitted or false.
-                birthdate:
-                  type: string
-                  example: 1929-08-21
-                  description: Omitted if parameter pii is omitted or false.
+                  $ref: '../schemas/PatIdentity.yaml#/gender'
+                dob:
+                  $ref: '../schemas/PatIdentity.yaml#/dob'
+                category:
+                  $ref: '../schemas/PatIdentity.yaml#/category'
+                doctor:
+                  $ref: '../schemas/PatIdentity.yaml#/doctor'
+                address:
+                  $ref: '../schemas/PatIdentity.yaml#/address'
+                contact:
+                  $ref: '../schemas/PatIdentity.yaml#/contact'
+                insurance:
+                  $ref: '../schemas/PatIdentity.yaml#/insurance'
+                patid:
+                  $ref: '../schemas/PatIdentity.yaml#/patid'
+                patUnid:
+                  $ref: '../schemas/PatIdentity.yaml#/patUnid'
                 feats:
                   type: object
                   properties: