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.
zoo-api/paths/qoc_list-groups.yaml

40 lines
1.3 KiB
YAML

get:
operationId: indicatorReportGroups
tags:
- Quality of Care
summary: Show all groups available for indicator reports. A group is a group of GP practices that do (part) of chronic care together.
parameters:
- name: refDate
in: query
description: |-
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required: false
schema:
$ref: ../schemas/date.yaml
responses:
'200':
description: >-
A list of available groups.
content:
application/json:
schema:
type: object
properties:
refDate:
description: 'Groups reported are available for this date (dutch: _peildatum_).'
$ref: ../schemas/date.yaml
groups:
description: A list of available groups.
type: array
items:
description: A tag (generally lower-case, no spaces).
type: string
example: hwf
required:
- refDate
- groups
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml#/components/responses/NoAccess'