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/schemas/CareProgram.yaml

53 lines
1.8 KiB
YAML

type: object
properties:
name:
description: Human readable text in dutch, guaranteed to be quite short.
type: string
example: Diabetes Mellitus type 2 (ZEL)
description:
description: 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
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
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:
oneOf:
- description: An indicator set report. use the `/qol/indicatorset` API endpoint.
type: string
example: indicatorset
- description: Resolve by loading the URL in the `url` property (`window.location = ` style).
type: string
example: link
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: >-
A unique string (always ASCII, no spaces) identifying this care program.
Pass to `/qoc/indicatorset` API, or can be used for fave/unfave.
type: string
example: ZEL-dm2