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.
90 lines
4.2 KiB
YAML
90 lines
4.2 KiB
YAML
description: |-
|
|
A single ratio or flat number; should be shown as one box with a chart (generally, a single fixed-size bar with each ratio element rendered on this bar). The numbers in this object are on some axis, generally, percentage.
|
|
type: object
|
|
properties:
|
|
key:
|
|
description: Unique identifier, not to be shown to the user, for referring to this indicator in other API calls
|
|
type: string
|
|
example: ZEL-dm2-bp-result
|
|
basedOn:
|
|
description: |-
|
|
*OPTIONAL* Refers to the key of another indicator in this set; the data this indicator represents is a calculation
|
|
based on the population of the referred-to indicator. Not necessarily something that needs to be shown in the user interface.
|
|
type: string
|
|
example: ZEL-dm2-bp
|
|
title:
|
|
description: Short, in dutch, *HTML* (but rarely includes formatting; at most, sup/superscript).
|
|
type: string
|
|
example: Prevalentie Diabetes
|
|
xMin:
|
|
description: Numeric value of the far left of the bar.
|
|
type: number
|
|
example: 10.0
|
|
default: 0
|
|
xMax:
|
|
description: Numeric value of the far right of the bar.
|
|
type: number
|
|
example: 80.0
|
|
default: 100.0
|
|
xLow:
|
|
description: |-
|
|
*OPTIONAL* If present, draw a bar at this position indicating that this indicator can fall below this lower bound, but if it does, that is noteworthy. For example, because that is beyond 3 standard deviations of the dutch average, or, its a goal set by the practice, the insurer, or the care group and thus falling below it means the goal is not met.
|
|
type: number
|
|
example: 20.0
|
|
xHigh:
|
|
description: |-
|
|
*OPTIONAL* If present, draw a bar at this position indicating that this indicator can fall above this upper bound, but if it does, that is noteworthy. For example, beyond 3 standard deviations of the dutch average, or, a goal for an indicator where lower is better.
|
|
type: number
|
|
example: 65.0
|
|
unitDesc:
|
|
description: |-
|
|
*OPTIONAL* describes the unit that the stated legend values are in, in dutch, and *HTML*. For example, if showing blood pressure, `mmHg`. If missing, treat as the empty string (do not show unit at all).
|
|
type: string
|
|
example: mmHg
|
|
default: ''
|
|
style:
|
|
description: |-
|
|
A key that describes the render style for this entire indicator.
|
|
For example, 'failed' indicates that the indicator should be rendered
|
|
with a red hue to focus the user's attention on the fact that this
|
|
indicator represents a goal or requirement that they do not currently
|
|
meet.
|
|
type: string
|
|
example: failed
|
|
default: normal
|
|
enum:
|
|
- failed
|
|
- normal
|
|
- met
|
|
- focus
|
|
bars:
|
|
description: |-
|
|
A series of numbers, each of which needs to be put on the bar in sequence. For some indicators, the sum of the values adds up to be equal to `xMax - xMin`, if it doesn't, the final part of the bar remains blank (white, for example). For example, given the usual xMin/xMax of 0/100, one could have 3 bars: 40-Good, 35-Concern, 25-Problematic. Which should be rendered as green/yellow/red sub-bars of the appropriate size across the indicator.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
style:
|
|
description: |-
|
|
Describes what kind of ratio this bar describes.
|
|
Individual bars represent some kind of ratio and this describes the nature of it. Each key should result in some style, generally, the color of the bar. For example, `serious` (indicating a group of patients whose lab result for this indicator is of serious concern, i.e. medically speaking quite bad news) should be rendered dark red.
|
|
type: string
|
|
example: concern
|
|
enum:
|
|
- good
|
|
- concern
|
|
- problem
|
|
- serious
|
|
- measured
|
|
- nonPrefMeasured
|
|
- 'TBD: There are many more.'
|
|
legend:
|
|
description: |-
|
|
*OPTIONAL* If present, render the title of this one bar like a legend for a chart. In dutch, *HTML*, and very short.
|
|
type: string
|
|
example: '≤ 120'
|
|
value:
|
|
description: |-
|
|
The 'size' of the described ratio. Relative to the range of the bar (as described by `xMax`-`xMin`).
|
|
type: number
|
|
example: 20.5 |