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.
42 lines
1.6 KiB
YAML
42 lines
1.6 KiB
YAML
get:
|
|
operationId: indicatorSet
|
|
tags:
|
|
- Quality of Care
|
|
summary: Indicator set
|
|
description: Provides the data to generate an report showing indicators for a care program. An indicator set holds all indicators for a combination of a care program, reference date and a customer. Care groups and practices see different output based on the same database. The authorisation for the care group to access care program data is taken in account.
|
|
parameters:
|
|
- name: setKey
|
|
in: path
|
|
description: The key as listed in the [/qoc/careprogram](#tag/Quality-of-Care/operation/carePrograms) response.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: ZEL-dm
|
|
- 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
|
|
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
|
|
responses:
|
|
'200':
|
|
description: |-
|
|
All data required to render an indicator set is returned.
|
|
|
|
Examples:
|
|
* <a href="examples/qoc_indicatorset.1.json">Example complete response</a>
|
|
* <a href="examples/qoc_indicatorset.ui_example.png">Example UI render</a>
|
|
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/IndicatorSet.yaml'
|
|
'401':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
'403':
|
|
$ref: '../zoo-api.yaml#/components/responses/NoAccess'
|
|
'404':
|
|
description: The provided `setKey` doesn't refer to a valid program.
|