diff --git a/paths/customer_basic.yaml b/paths/customer_basic.yaml index 3162a08..dfe0a51 100644 --- a/paths/customer_basic.yaml +++ b/paths/customer_basic.yaml @@ -32,7 +32,10 @@ get: institutionAgb: description: The AGB of the institution, if the customer is a care group or other institute, otherwise omitted. One of practiceAgb or institutionAgb is always present. $ref: ../schemas/agb.yaml - gpis: + gpisMethod: + description: The current GPIS type and how medical dossiers are transferred to Zorg op Orde. + example: HealthConnected (automatische koppeling) + lastImport: $ref: ../schemas/GPIS.yaml doctors: description: AGBs of the doctors working in the practice. @@ -45,6 +48,7 @@ get: address1: type: string description: The first line of the practice postal address (street name and house number, generally). + example: Dorpsstraat 1 postcode: $ref: ../schemas/postcode.yaml city: @@ -54,23 +58,26 @@ get: properties: tel: type: string + example: "0612345678" email: type: string + example: "M.Dobbelsteen@zorgoporde.nl" dataProcessing: type: object properties: controllers: description: A list of personnel responsible for the data. Usually the practice owner. type: array + example: ["Mien Dobbelsteen", "Lydie van der Ploeg"] items: type: string agreement: - example: If set, the signer and date of the data processing agreement between the controller (responsible general practitioner) and processor (Zorg op Orde). type: object properties: signedBy: description: Full name of the signer. type: string + example: Lydie van der Ploeg signedOn: description: Date of signing the data processing agreement. example: 20160501T1344 @@ -83,7 +90,10 @@ get: '401': $ref: '../zoo-api.yaml/#/components/responses/NoAuth' '403': - $ref: '../zoo-api.yaml/#/components/responses/NoAccess' + description: |- + User is not allowed to access this API endpoint, or, + the practice identified by the `agb` parameter does not have a relationship with the + user (for example, they do not belong to your care group). post: operationId: customerBasicPost tags: