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_careprogram.yaml

33 lines
1.3 KiB
YAML

get:
operationId: carePrograms
tags:
- Quality of Care
summary: All 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>
content:
application/json:
schema:
type: object
properties:
programs:
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 protocollized chronic care condition (Often, new research).
type: array
items:
$ref: '../schemas/CareProgram-enum.yaml'
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'