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

104 lines
3.3 KiB
YAML

description: |-
A report about a specific aspect of a care program, listing the stats of each participating GP practice.
type: object
properties:
group:
description: The chosen group (repeats `group` parameter if present, otherwise, the group defaulted to for authenticating user).
type: string
example: hwf
key:
$ref: 'Indicator.yaml#/properties/key'
title:
$ref: 'Indicator.yaml#/properties/title'
type:
$ref: 'Indicator.yaml#/properties/type'
refDate:
$ref: 'IndicatorSet.yaml#/properties/refDate'
description:
$ref: 'IndicatorDetail.yaml#/properties/description'
descriptionDetail:
$ref: 'IndicatorDetail.yaml#/properties/descriptionDetail'
xMin:
$ref: 'Indicator.yaml#/properties/xMin'
xMax:
$ref: 'Indicator.yaml#/properties/xMax'
markers:
$ref: 'Indicator.yaml#/properties/markers'
unitDesc:
$ref: 'Indicator.yaml#/properties/unitDesc'
legend:
$ref: 'Indicator.yaml#/properties/legend'
skipped:
description: One entry for each GP practice participating in the chosen group but excluded from this chronic care program
type: array
items:
type: object
properties:
name:
description: Name of the GP practice
type: string
agb:
description: AGB of the GP practice, if known.
type: integer
format: int32
minimum: 1
maximum: 99999999
skipReason:
description: Human readable string describing why this GP practice is excluded (in dutch, *HTML*).
type: string
required:
- name
- skipReason
participants:
description: One entry for each GP practice participating in the chosen group and in this chronic care program
type: array
items:
type: object
properties:
gpis:
$ref: 'GPIS.yaml'
name:
$ref: '#/properties/skipped/items/properties/name'
agb:
$ref: '#/properties/skipped/items/properties/agb'
amplitude:
description: |-
The relative weight of this practice compared to all practices (the ratio of this practice's population vs. the total population).
A higher number means this practice has many patients in its `population`, a lower meaning means fewer.
type: number
format: double
minimum: 0.0
maximum: 1.0
population:
description: |-
The amount of patients for this GP practice that are relevant for this indicator: Each patient in this population is assigned
into one of the categories of this indicator (which may be the 'not measured for this patient' category).
type: integer
minimum: 0
format: int32
values:
description: |-
For each entry in the `legend`, one value representing how many patients are assigned into that category. For legend-less indicators,
this array will only contain a single number.
type: array
items:
type: integer
minimum: 0
format: int32
required:
- gpis
- name
- amplitude
- population
- values
required:
- group
- key
- title
- type
- refDate
- description
- markers
- skipped
- participants