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.
70 lines
2.4 KiB
YAML
70 lines
2.4 KiB
YAML
type: object
|
|
properties:
|
|
key:
|
|
description: >-
|
|
A unique string (always ASCII, no spaces) identifying this care program.
|
|
Can be used to fave/unfave.
|
|
type: string
|
|
example: ZOO-dm
|
|
name:
|
|
description: Human readable text in dutch, guaranteed to be quite short.
|
|
type: string
|
|
example: Diabetes Mellitus type 2 (ZEL)
|
|
description:
|
|
description: |-
|
|
*OPTIONAL* in dutch and in *HTML*, can consist of multiple paragraphs, but won't be more than ~5 lines or so.
|
|
type: string
|
|
example: Ketenzorg DM2 volgens de standaard werkwijze van zorgggroep ZEL.
|
|
defaultShow:
|
|
description: If `true`, show this unless explicitly unfavourited. If `false`, do not show unless explicitly favourited.
|
|
type: boolean
|
|
example: true
|
|
favState:
|
|
description: If `T`, always show this. If `F`, never show it. If `X`, show if `defaultShow` is `true`.
|
|
type: string
|
|
example: X
|
|
enum:
|
|
- T
|
|
- F
|
|
- X
|
|
badge:
|
|
description: |-
|
|
*OPTIONAL* A very short string to be shown in a badge; dutch text in *HTML*. If omitted, do not show any badge.
|
|
type: string
|
|
example: In ontwikkeling
|
|
reports:
|
|
description: |-
|
|
A care program offers 1 or more reports; any given report is generally very different from another.
|
|
Each offered report should be shown as a button.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
description: |-
|
|
The type of the report available for this care program.<dl>
|
|
<dt>indicatorset</dt><dd>Use the <code>/qol/indicatorset</code> API endpoint.</dd>
|
|
<dt>link</dt><dd>Load the <code>url</code> property as main page (<code>window.location = ..</code>).</dt>
|
|
</dl>
|
|
enum:
|
|
- indicatorset
|
|
- link
|
|
type: string
|
|
example: indicatorset
|
|
name:
|
|
description: Short description in dutch text; show this in the button.
|
|
type: string
|
|
example: Indicatoren
|
|
url:
|
|
description: |-
|
|
Only for `type: "link"`.
|
|
type: string
|
|
example: '/indicators/casefinder?t=dm'
|
|
key:
|
|
description: |-
|
|
Only for `type: "indicatorset"`.
|
|
A unique string (always ASCII, no spaces) identifying this indicatorset.
|
|
Pass to `/qoc/indicatorset` API.
|
|
type: string
|
|
example: ZEL-dm2
|