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.
71 lines
2.8 KiB
YAML
71 lines
2.8 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 zorggroep ZEL.
|
|
tags:
|
|
description: |-
|
|
A list of very short dutch strings categorizing the care program.
|
|
Most care programs have 2 tags:
|
|
- one describing the entity that is responsible for the definition (e.g. a 'zorggroep' or standardizing institute such as 'InEen',
|
|
- one describing the care program itself, such as 'DM' or 'Ouderenzorg'.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: |-
|
|
["ZEL", "DM"]
|
|
defaultShow:
|
|
description: |-
|
|
If `true`, show this unless explicitly unfavourited. If `false`, do not show unless explicitly favourited.
|
|
Care programs with the `defaultShow` property are considered, by the customer, by the customer's 'zorggroep', or
|
|
by Zorg op Orde as inherently relevant to the practice. non-`defaultShow` programs are there for practices that want
|
|
to look into expanding their care programs or which want to deviate from regional norms. These should be hidden behind
|
|
a settings pane where the GP can explicitly enable some non-`defaultShow` programs, or disable some `defaultShow` programs.
|
|
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
|
|
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>
|
|
<dt>casefinder</dt><dd><em>Work in progress</em>; for now, load the <code>url</code> property as main page (<code>window.location = ..</code>).</dt>
|
|
</dl>
|
|
enum:
|
|
- indicatorset
|
|
- link
|
|
- casefinder
|
|
type: string
|
|
example: indicatorset
|
|
careprogram:
|
|
$ref: '../schemas/CareProgram-enum.yaml'
|
|
url:
|
|
description: |-
|
|
Only for `type: "link"` (_Work in progress_: For now also for `type: "casefinder"`).
|
|
type: string
|
|
example: '/indicators/casefinder?t=dm'
|