[qoc] Add indicator 'type'

schemas/Indicator.yaml

@@ -14,6 +14,26 @@ properties:
     description: Short, in dutch, *HTML* (but rarely includes formatting; at most, sup/superscript).
     type: string
     example: Prevalentie Diabetes
+  type:
+    description: |-
+      What kind of indicator this is.
+      
+      `basic` and `goal` are roughly the same: They represent the measurement/registration status of a certain medical aspect, such as blood pressure, and always
+      break down in 3 groups: "Patients for whom this measurement/registration has been performed", "same, but in a way that cannot be parsed or isn't the preferred registration/measurement method", "not measured/registered". A `goal` type also has a goal of some sort (a minimum % of patients for which this property needs to be measured/registered, for example to meet care group aims or a goal stipulated by
+      a national standard or insurance negotiation). A `basic` type doesn't have such a goal.
+      
+      `prevalence` is somewhat special: It measures how many patients are relevant for the care this indicatorset is about.
+      
+      `result` represents the patients for whom a certain medical aspect is registered/measured, divided into categories. For example, for bloodpressure, all those patients with a valid, standardized
+      blood pressure measurement are sorted into "their blood pressure is allright", "their blood pressure is a bit high", and "they suffer from high blood pressure". result type indicators have
+      legends.
+    type: string
+    example: basic
+    enum:
+      - basic
+      - goal
+      - prevalence
+      - result
   index:
     description: |-
       *OPTIONAL* Indicators usually are based on documentation that tends to take the form of an
@@ -34,7 +54,7 @@ properties:
     description: |-
       Numeric value of the far right of the bar; represents a ratio (0.0-1.0).
       Most indicators range from 0% to 100%, but for some, where the values to be shown represent only a small percentage,
-      the bar is 'zoomed in'; it represents only a slice of the total range.
+      the bar is 'zoomed in'; it represents only a slice of the total range. Generally, `prevalence` type indicators have an `xMax` that isn't 1.0.
     type: number
     example: .105
     default: 1.0
@@ -43,7 +63,7 @@ properties:
       A marker is rendered on the percentage bar and represents a noteworthy boundary, for example, for a prevalence indicator,
       one standard deviation up, respectively down, from the average, to provide context. Or, a goal as set forth by a zorggroep
       or national standards body e.g. for how many diabetes patients should have a recent HbA1c measurement. If the indicator itself
-      is shown as a horizontal bar, this would be a small vertical line rendered on top of it.
+      is shown as a horizontal bar, this would be a small vertical line rendered on top of it. Generally, `prevalence` and `goal` type indicators have markers.
     type: array
     items:
       type: number
@@ -80,6 +100,7 @@ properties:
     description: >-
       *OPTIONAL* If present, render a legend box with the card explaining what each kind of segment (see `bars > segments`) represents.
       Each item in this array maps maps a style (as used in `bars > segments > style`) onto a very short, dutch, *HTML* description.
+      Generally only `result` type indicators have a `legend`.
     type: array
     items:
       type: object