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.
61 lines
2.4 KiB
YAML
61 lines
2.4 KiB
YAML
get:
|
|
operationId: carePrograms
|
|
tags:
|
|
- Quality of Care
|
|
summary: Care programs
|
|
description: |-
|
|
List all available care programs. Includes all care programs that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default.
|
|
parameters:
|
|
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
|
|
responses:
|
|
'200':
|
|
description: |-
|
|
Care programs are returned.
|
|
|
|
Examples:
|
|
* <a href="examples/qoc_careprogram.1.json">Example complete response</a>
|
|
* <a href="examples/qoc_careprogram.ui_example.png">Example UI render (<em>Somewhat outdated</em>)</a>
|
|
links:
|
|
GetIndicatorSet:
|
|
operationId: indicatorSet
|
|
parameters:
|
|
setKey: $response.body#/key
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
programs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
description: Key of the indicator set.
|
|
name:
|
|
type: string
|
|
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.
|
|
'401':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
'403':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'
|