[indicators] Call-up list now has Dymo responses.

paths/qoc_checkupList_{setKey}.yaml

@@ -4,7 +4,7 @@ get:
     - Quality of Care
   summary: Call-up status
   description: |-
-    Load call-up status for patients in a care program. Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
+    Load the call-up status for patients in a care program. Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
   parameters:
     - name: setKey
       in: path
@@ -49,15 +49,29 @@ get:
       description: Request inclusion of email addresses
       schema:
         type: boolean
+    - name: onlyNameAddress
+      in: query
+      required: false
+      description: |-
+        If true, only data needed for printing address labels is in the response. This output is also known as Dymo output. The format of the response depends on the HTTP Accept header. If the best match between the server en caller is:
+
+        * `text/csv`, then CSV according RFC 4180 is responded;
+        * `application/json`, then JSON;
+        * `application/vnd.ms-excel` or `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, then legacy MS Excel;
+        
+        While the server is still calculating, see calculating property in the response, the output is always `application/json`. 
+      schema: 
+        type: boolean
     - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
   responses:
     '200':
       description: |-
-        list of patients
+         A list of patients. The format of the response is default a comprehensive JSON, but can be limited to only data needed for printing address labels, using the `onlyNameAddress` parameter. Any non JSON response has a header row with field names.
       content:
         application/json:
           schema:
-            type: object
+            oneOf:
+            - type: object
               properties:
                 gpis:
                   $ref: '../schemas/IndicatorSet.yaml#/properties/gpis'
@@ -126,6 +140,8 @@ get:
                           An index (0-based) into the `doctors` entry: This is the GP responsible for this patient.
                       status:
                         $ref: '../schemas/callUpStatus-enum.yaml'
+                      name:
+                        $ref: '../schemas/pat-Name.yaml'
                       address1:
                         type: string
                         description: |-
@@ -175,6 +191,16 @@ get:
                 - name
                 - refDate
                 - calculating
+            - $ref: '../schemas/dymo.yaml'
+        text/csv:
+          schema:
+            $ref: '../schemas/dymo.yaml'
+        'application/vnd.ms-excel':
+          schema:
+            $ref: '../schemas/dymo.yaml'
+        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
+          schema:
+            $ref: '../schemas/dymo.yaml'
     '401':
       $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
     '403':

schemas/Indicator.yaml

@@ -20,6 +20,14 @@ properties:
     description: Short, in dutch, plain text.
     type: string
     example: Prevalentie Diabetes
+  htmlDescription:
+    description: In dutch, HTML formatted; if present, contains details on how this value is measured (in more readable, less technical terms than `htmlDetail`.
+    type: string
+    example: Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden
+  htmlDetail:
+    description: In dutch, HTML formatted; if present, contains specific details on how this value is measured (for example, contains information about which NHG bepaling codes are used).
+    type: string
+    example: LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))
   type:
     description: |-
       What kind of indicator this is.
@@ -183,6 +191,12 @@ properties:
           type: string
           example: Praktijk 2023Q3
           default: ''
+        pop:
+          description: |-
+            A number representing the total population that this indicator has calculated against; can have decimal values if this
+            indicatorset represents a group average.
+          type: number
+          example: 854.0
         segments:
           type: array
           items:

schemas/IndicatorSet.yaml

@@ -84,14 +84,6 @@ properties:
           description: In dutch, plain text formatted; should fit on one line.
           type: string
           example: Populatie
-        htmlDescription:
-          description: In dutch, HTML formatted; if present, contains details on how this value is measured (in more readable, less technical terms than `htmlDetail`.
-          type: string
-          example: Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden
-        htmlDetail:
-          description: In dutch, HTML formatted; if present, contains specific details on how this value is measured (for example, contains information about which NHG bepaling codes are used).
-          type: string
-          example: LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))
         indicatorGroups:
           description: |-
             A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should

schemas/dymo.yaml

@@ -0,0 +1,22 @@
+type: array
+items: 
+  type: object
+  properties:
+    patPubId:
+      $ref: '../schemas/PatIdentity.yaml#/patPubId'
+    patUnid:
+      $ref: '../schemas/PatIdentity.yaml#/patUnid'
+    displayName:
+      type: string
+      example: "Timmermans - de Vos"
+    addressLine1:
+      type: string
+      example: "Pieter Cordifstraat 88"
+    addressLine2:
+      type: string
+      example: "2552 XT  HAMOR"
+  required:
+    - patUnid
+    - displayName
+    - addressLine1
+    - addressLine2

schemas/pat-patUnid.yaml

@@ -1,5 +1,5 @@
 description: |-
-  Patient's unique and persistent ID in GPIS. Usually identical to `patid` but certain GPISes may
+  Patient's unique and persistent ID in GPIS. Usually identical to `patPubId` but certain GPISes may
   use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only
   if supplying GPIS does not send them.
 type: string