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/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