|
|
get:
|
|
|
operationId: indicatorSets
|
|
|
tags:
|
|
|
- Quality of Care
|
|
|
summary: Indicator sets
|
|
|
description: |-
|
|
|
List all available indicator sets. Includes all sets that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default.
|
|
|
|
|
|
This endpoint is also reachable using URL `/qoc/careprogram`, but that endpoint is deprecated.
|
|
|
parameters:
|
|
|
- name: carePrograms
|
|
|
in: query
|
|
|
description: |-
|
|
|
A comma separated list of care program types, for example `DM,COPD`. The response is limited to the specified care programs.
|
|
|
schema:
|
|
|
type: array
|
|
|
items:
|
|
|
$ref: '../schemas/CareProgram-enum.yaml'
|
|
|
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
|
|
|
responses:
|
|
|
'200':
|
|
|
description: |-
|
|
|
Indicator sets are returned.
|
|
|
|
|
|
Examples:
|
|
|
* <a href="examples/qoc_indicatorsets.1.json">Example complete response</a>
|
|
|
* <a href="examples/qoc_indicatorsets.ui_example.png">Example UI render (somewhat outdated)</a>
|
|
|
links:
|
|
|
GetIndicatorSet:
|
|
|
operationId: indicatorSet
|
|
|
parameters:
|
|
|
setKey: $response.body#/key
|
|
|
content:
|
|
|
application/json:
|
|
|
schema:
|
|
|
type: object
|
|
|
properties:
|
|
|
indicatorsets:
|
|
|
type: array
|
|
|
items:
|
|
|
type: object
|
|
|
properties:
|
|
|
key:
|
|
|
type: string
|
|
|
description: Key of the indicator set.
|
|
|
name:
|
|
|
type: string
|
|
|
description: |-
|
|
|
Something like `DM (Calisota)` – describes the careprogram itself (and not the purpose of this indicatorset - see `subName` for that).
|
|
|
subName:
|
|
|
type: string
|
|
|
description: |-
|
|
|
Something like `Oproepen` or `Rapportage 75+` – describes the purpose of this indicatorset; a number of sets all with the same name but with different subNames can exist, representing different views and protocol approaches to the same care program.
|
|
|
description:
|
|
|
type: string
|
|
|
description: A longer description in dutch describing e.g. the chronic care condition covered by this set.
|
|
|
tags:
|
|
|
type: array
|
|
|
description: A list of simple short dutch strings describing properties of this set.
|
|
|
defaultShow:
|
|
|
type: boolean
|
|
|
favState:
|
|
|
type: string
|
|
|
description: Always "X".
|
|
|
example: X
|
|
|
'type':
|
|
|
type: string
|
|
|
description: Always "indicatorset".
|
|
|
example: indicatorSet
|
|
|
careprogram:
|
|
|
$ref: '../schemas/CareProgram-enum.yaml'
|
|
|
description: The kind of chronic care that this care program caters to. Can be omitted in cases where this care program doesn't cover a generally accepted protocolized chronic care condition. That is often the case with new research projects.
|
|
|
callup:
|
|
|
type: boolean
|
|
|
description: |-
|
|
|
If this 'flavour' (as per `subName`) is intended to be used to call up patients and look to the future (this will be `true`) or if this set's intent is reporting and introspection, looking to the past (this will be `false`).
|
|
|
'401':
|
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
|
'403':
|
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'
|