Updated the "list of care programs" API to reflect the actual output.

live
Eric Hoekstra 1 year ago
parent 4080de0fbf
commit 1105a4a1f2

@ -2,7 +2,7 @@ get:
operationId: carePrograms operationId: carePrograms
tags: tags:
- Quality of Care - Quality of Care
summary: All care programs summary: Care programs
description: |- 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. 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: parameters:
@ -15,17 +15,43 @@ get:
Examples: Examples:
* <a href="examples/qoc_careprogram.1.json">Example complete response</a> * <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> * <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: content:
application/json: application/json:
schema: schema:
type: object type: object
properties: properties:
programs: 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 type: array
items: items:
type: object
properties:
key:
type: string
description: Key of the indicator set.
name:
type: string
description:
type: string
tags:
type: array
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' $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': '401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth' $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403': '403':

Loading…
Cancel
Save