First draft for basic customer info API.

paths/customer_basic.yaml

@@ -0,0 +1,63 @@
+get: 
+  operationId: customerBasic
+  tags: 
+    - Customer management
+  summary: Basic info
+  parameters: 
+    - name: agb
+      in: query
+      description: AGB of the practice which is known as Zorg op Orde customer (via a care group). 
+      schema: 
+        $ref: ../schemas/agb.yaml
+    - name: unid
+      in: query
+      description: Internal number used by Zorg op Orde
+      schema: 
+        type: integer
+  responses: 
+    '200':
+      description: Basic information of a practice.
+      content: 
+        application/json:
+          schema: 
+            type: object
+            properties: 
+              practice:
+                type: object
+                properties:
+                  name:
+                    type: string
+                  agb:
+                    $ref: ../schemas/agb.yaml
+                  gpis:
+                    $ref: ../schemas/GPIS.yaml
+                  address:
+                    type: object
+                    properties:
+                      streetHouseNumber:
+                        type: string
+                      postcode:
+                        $ref: ../schemas/postcode.yaml
+                      city:
+                        $ref: ../schemas/city.yaml
+                  contact:
+                    type: object
+                    properties:
+                      tel:
+                        type: string
+                      email:
+                        type: string
+              fundus:
+                type: object
+                properties:
+                  broker:
+                    type: string
+                  someOrganization:
+                    type: string
+                    # In de mock up te lezen als: oproeporganisatie, Ksyos.
+    '400':
+      description: If the specified customer is not a practice but some other entity, e.g. a care group.
+    '401':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
+    '403':
+      $ref: '../zoo-api.yaml/#/components/responses/NoAccess'

schemas/PatIdentity.yaml

@@ -58,13 +58,9 @@ address:
       example: A
       default: ""
     postcode:
-      description: The post code, in `1234AB` format. If not known, blank.
+      $ref: ../schemas/postcode.yaml
-      type: string
-      example: 2611PV
     city:
-      description: The city or town.
+      $ref: ../schemas/city.yaml
-      type: string
-      example: Delft
 contact:
   type: object
   properties:

schemas/city.yaml

@@ -0,0 +1,3 @@
+description: The city or town.
+type: string
+example: Delft

schemas/fundus-status.yaml

@@ -8,10 +8,7 @@ properties:
   agb:
     description: |-
       The AGB code of the GP practice whose patients are provided in this object.
-    type: integer
+    $ref: agb.yaml
-    format: int32
-    minimum: 1
-    maximum: 99999999
   name:
     description: |-
       A human readable name describing the GP practice (The entity whose AGB code is sent as `agb`).

schemas/postcode.yaml

@@ -0,0 +1,3 @@
+description: The postcode, in `1234AB` format. If not known, blank.
+type: string
+example: 2611PV

zoo-api.yaml

@@ -87,6 +87,8 @@ paths:
     $ref: 'paths/customer_careprogram.yaml'
   /customer/careprogram/periodEnd:
     $ref: 'paths/customer_careprogram_periodEnd.yaml'
+  /customer/basic:
+    $ref: 'paths/customer_basic.yaml'
 components:
   parameters:
     Authorization: