You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
130 lines
5.3 KiB
YAML
130 lines
5.3 KiB
YAML
get:
|
|
operationId: customerBasicGet
|
|
tags:
|
|
- Customer management
|
|
summary: Basic info
|
|
parameters:
|
|
- name: agb
|
|
in: path
|
|
description: AGB of the practice which is known as Zorg op Orde customer (via a care group).
|
|
schema:
|
|
$ref: ../schemas/agb.yaml
|
|
responses:
|
|
'200':
|
|
description: Basic information of a practice.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
practice:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
officialName:
|
|
type: string
|
|
practiceAgb:
|
|
description: The AGB of the practice, if the customer in the response is a practice, otherwise omitted. One of practiceAgb or institutionAgb is always present.
|
|
$ref: ../schemas/agb.yaml
|
|
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
|
|
setGpisType:
|
|
description: The intended GPIS type. This may differ from the actual import in the `gpis` property. Especially if the GPIS type is newly changed.
|
|
type: string
|
|
gpis:
|
|
$ref: ../schemas/GPIS.yaml
|
|
doctors:
|
|
description: AGB's of the doctors working in the practice.
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/PatIdentity.yaml#/doctor'
|
|
address:
|
|
type: object
|
|
properties:
|
|
address1:
|
|
type: string
|
|
description: The first line of the practice postal address (street name and house number, generally).
|
|
postcode:
|
|
$ref: ../schemas/postcode.yaml
|
|
city:
|
|
$ref: ../schemas/city.yaml
|
|
contact:
|
|
type: object
|
|
properties:
|
|
tel:
|
|
type: string
|
|
email:
|
|
type: string
|
|
dataProcessing:
|
|
type: object
|
|
properties:
|
|
controllers:
|
|
description: A list of personnel responsible for the data. Usually the practice owner.
|
|
type: array
|
|
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
|
|
signedOn:
|
|
description: Date of signing the data processing agreement.
|
|
example: 20160501T1344
|
|
$ref: ../schemas/date.yaml
|
|
required:
|
|
- name
|
|
- officialName
|
|
'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'
|
|
post:
|
|
operationId: customerBasicPost
|
|
tags:
|
|
- Customer management
|
|
summary: Basic info
|
|
description: Only certain properties of a practice can be updated. After updating the same response is outputted as when using GET.
|
|
parameters:
|
|
- name: agb
|
|
in: path
|
|
description: AGB of the practice which is known as Zorg op Orde customer (via a care group).
|
|
schema:
|
|
$ref: ../schemas/agb.yaml
|
|
requestBody:
|
|
description: |-
|
|
When authorized as a care group the GPIS type can be changed. As a practice the address and
|
|
contact data can be changed. This request cannot be used to remove or set any of these properties empty.
|
|
content:
|
|
'application/x-www-form-urlencoded':
|
|
schema:
|
|
oneOf:
|
|
- type: object
|
|
properties:
|
|
gpisType:
|
|
$ref: '../schemas/gpisType.yaml'
|
|
- type: object
|
|
properties:
|
|
address1:
|
|
type: string
|
|
description: The first line of the practice postal address (street name and house number, generally).
|
|
postcode:
|
|
description: Any valid Dutch postcode, with or without whitespacing and in lower- or uppercase.
|
|
$ref: ../schemas/postcode.yaml
|
|
city:
|
|
$ref: ../schemas/city.yaml
|
|
tel:
|
|
description: A Dutch phone number of 10 digits. Additional dashes and spacing are removed before validating.
|
|
type: string
|
|
email:
|
|
type: string
|
|
format: email
|
|
responses:
|
|
$ref: '#/get/responses'
|
|
|