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/IndicatorSet.yaml

39 lines
1.6 KiB
YAML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

description: |-
A report about a care program based on showing a number of ratios, such as 'how many people in your practice have diabetes', or 'for all diabetes patients in your care with a recent blood pressure measurement, how do these blood pressure measurements split into "problematic" / "concern" / "okay" categories
type: object
properties:
key:
description: Unique identifier, not to be shown to the user, for referring to this indicator set in other API calls
type: string
example: ZOO-dm
name:
description: Human readable dutch text; should fit in one line.
type: string
example: Diabetes Mellitus type 2 per InEen 2023 accreditatie
refDate:
description: 'All calculations are done on this date (dutch: _peildatum_).'
type: string
format: date
example: 2023-04-01
chapters:
description: |-
Each chapter has a title and contains 1 or more indicators.
type: array
items:
type: object
properties:
title:
description: In dutch, *HTML* formatted; should fit on one line.
type: string
example: Populatie
indicatorGroups:
description: |-
A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should
always be shown together; they are each other's context. These arrays are never empty, but often contain
just one indicator. It is extremely rare for such a set to contain more than 2.
type: array
items:
type: array
items:
$ref: 'Indicator.yaml'