summary:Get basic personal info not directly related to their medical dossier
parameters:
- name:bsn
in:query
description:|-
The SSN (dutch:_BSN_) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0.
required:true
schema:
type:string
example:123456789
- $ref:'#/components/parameters/Authorization'
responses:
'200':
description:Basic personal information for the patient is returned.
content:
application/json:
schema:
type:object
required:
- bsn
- name
- gender
- contact
- patid
- pat_unid
- category
- start_date
properties:
bsn:
description:|-
Patient SSN (dutch:_BSN_). If not known or patient has no BSN, this value will be `0`.
It is customary that BSNs are 9 digits; API caller may want to transform this value into
a string by explicitly left-padding `0` characters to the front to make the bsn value 9 digits.
type:number
example:123456789
name:
description:All relevant info about the patient's name.
type:object
properties:
firstname:
description:|-
Patient's first name(s), separated by spaces.
It's possible that no first names are known and instead only initials are known; in that case,
the initials are provided with dots (`.`) in between the letters, e.g. `"J.M."`.
type:string
example:Marie Antoinnette
initials:
description:|-
Patient's initials, with no separators.
Initials might be derived from a patient's first name if initials weren't explicitly provided by
the source HIS.
type:string
example:MA
infix_own:
description:|-
The prefix of the patient's own last name (what they were born with; not the name inherited from
a spouse):`van`, `de`, `van der` - a mostly uniquely dutch aspect to last names.
type:string
example:de
own_lastname:
description:|-
The patient's own last name without a prefix (what they were born with; not the name inherited from
a spouse).
type:string
example:Villepin
infix_partner:
description:|-
The prefix of the patient's (ex-)spouse's last name; not all patients that are married go by their spouse's last name and often, if they don't, this field will be blank.
type:string
example:van der
partner_lastname:
description:|-
The the patient's (ex-)spouse's last name without prefix; not all patients that are married go by their spouse's last name and often, if they don't, this field will be blank.
Note that by convention, patients whose birthdate is unknown pick a date and tend to pick either `xxxx-01-01` or `xxxx-07-01`. Can, in rare cases, be unavailable - if birth date is not known.
type:string
format:date
example:1970-07-01
category:
description:|-
The status of the patient's registration within this practice.
As per [NHG-table-5](https://referentiemodel.nhg.org/sites/default/files/NHG-Tabel%205-Categorie%20pati%C3%ABnt-versie-5-Inkijkexemplaar_1.pdf):
- `V` = Standard patient, part of the GP's population (dutch:_vast_).
- `T` = Temporary patient (likely do _not_ treat as part of GP's population).
- `P` = Opportunity patient (dutch: _passant_ - patient is not signed up with this GP. For example:tourist).
type:string
example:V
doctor:
description:|-
If known, the AGB code of the primary care GP (dutch:_Inschrijf arts_). Value 0 indicates
this HIS or practice doesn't assign patients to individual GPs, or this information isn't
known.
type:number
example:1051234
address:
description:Patient's address (where they live). If not known, this property will not be in the response.
type:object
properties:
street:
description:Full name of the street, excluding house number.
type:string
example:Lange Geer
housenumber:
description:|-
Just the house number; 0 if unknown or in the exotic case where no house number exists. This does
not include any addendums such as 'A' or 'room 15'. Guaranteed to be non-negative.
type:integer
example:4
housenumber_suffix:
description:|-
Often empty, the string that follows the numeric part of the address house number. For example, `"A"`, or
`"k22"`.
type:string
example:A
postcode:
description:The post code, in `1234AB` format. If not known, blank.
type:string
example:2611PV
city:
description:The city or town.
type:string
example:Delft
contact:
type:object
properties:
tel:
description:|-
Patient's phone number(s). By convention, the mobile number, if available, is always listed first.
Phone numbers are always in international format (they start with a `+` symbol).
If no phone numbers are available or patient has no phone, an empty list is returned.
type:array
example:["+31612345678","+31701234567"]
items:
type:string
email:
description:|-
Patient's email address(es); first one returned is indicated as preferred.
If no emails are known or available, or patient has no email, an empty list is returned.
type:array
items:
type:string
example:["info@zorgoporde.nl"]
insurance:
description:|-
Info about where the patient is insured. If patient is not insured, this field will not be present.
Only the main insurance used for reimbursement of GP costs will be returned, if any such insurance exists.
type:object
properties:
policy_number:
description:|-
Patient's insurance registration number (dutch:_polisnummer_).
type:string
example:123456789012345
uzovi:
description:|-
Insurer's identity number in the dutch insurance system (dutch:_UZOVI nummer_). Always
4digits exactly, 0-left-padded if needed. If unknown or not insured, 4 zeroes.
type:number
example:101
patid:
description:|-
Patient's "public" ID, as used and shown on the HIS patient page. Not necessarily unique,
and not necessarily present; 0 indicates no patid is known or this HIS does not use (numeric)
public IDs.
type:number
example:1234
pat_unid:
description:|-
Patient's unique and persistent ID in HIS. Usually identical to `patid` but certain HISes may
use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only
if supplying HIS does not send them.
type:string
example:1234
start_date:
type:string
format:date
description:|-
Date patient joined the practice (dutch:_inschrijf datum_).
In rare cases, a patient joined so long ago, this date is no longer known. In this case,
a sentinel value of `"1900-01-01"` is sent which is presumed to result in the desired behaviour
(which is to consider this patient as part of this practice's population regardless of how far
back you want to go).
example:1994-08-20
end_date:
type:string
format:date
description:|-
If not blank, patient has exited the practice on this date. (dutch:_uitschrijf datum_).
example:""
end_reason:
description:|-
Reason patient left the practice (dutch:_reden vertrek_).
This will always be blank if `end_date` is blank. Otherwise, this value _might_ contain
a non-blank letter as per [NHG-table-9](https://referentiemodel.nhg.org/sites/default/files/NHG-Tabel%209-Reden%20vertrek-versie-5-Inkijkexemplaar_1.pdf):
- `A` = To other practice
- `V` = Moved
- `O` = died
- `T` = Temporary
- `I` = Care home / institution
- `Q` = unknown
- `X` = Other
type:string
example:""
'400':
description:The request is invalid; for example, it doesn't contain the required `BSN` parameter.
'401':
$ref:'#/components/responses/JwtFailure'
'403':
description:Indicated practice is known but has not authorized ZOO to share this information with signer.
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:
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`).
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:
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.
As well as a 'config' view where they see _all_ care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default.
As well as a 'config' view where they see _all_ care programs that could possibly be relevant for that customer, where the customer can preview the report (essentially, run the report as normal), favourite something they don't get by default, or unfavourite something they get by default.
paths:
paths:
/springboard/apps:
/springboard/apps:
get:
$ref:'paths/springboard_apps.yaml'
tags:
- core
summary:Available springboard apps
description:WorkInProgress
responses:
'200':
description:List of available apps
content:
application/json:
schema:
type:object
properties:
notifications:
type:array
items:
type:object
properties:
type:
description:Describes the nature of the notification
type:string
example:Warning
enum:
- Warning
- Serious
- News
- Info
content:
description:Dutch text in _HTML_ - can consist of a few lines.
type:string
example:|-
De definities van opslagwijken verandert in 2024. Uw praktijk gaat van 15% naar 22% opslagwijk populatie.
id:
description:A unique ID that can be used to mark a notification as read.
type:number
example:1000
app_sections:
type:array
items:
type:object
properties:
title:
description:The section title, in dutch, in _HTML_. Apps are divided into sections. The main section has no title (blank string).
type:string
example:""
apps:
type:array
items:
type:object
properties:
title:
description:The title, in dutch, as _HTML_. Will be quite short.
type:string
example:HIS op Orde
icon:
description:|-
The material icon name, as per the [material icon set](https://fonts.google.com/icons).
type:string
example:Chevron Right
badge:
description:|-
If -1, don't show a badge. If 0, show a badge (a small red dot) with no content.
Otherwise, show the number inside the dot; it is permissible to show 10 and up as '9+'.
type:number
example:-1
url:
description:|-
The (usually relative) URL that hosts this app. Update the client URL to this when loading
this app; if API calls cannot render this app, set `window.location` to this URL.
type:string
example:/his-op-orde
app:
description:|-
A keyword that describes the app; can be blank or not present which means the only way to
load this app is by setting `window.location` with the URL. Otherwise, check the documentation
for that describes the app for information on what API is available for it.
type:string
example:HisOpOrde
/patient/dossier:
/patient/dossier:
get:
$ref:'paths/patient_dossier.yaml'
tags:
- patient
summary:Get detailed medical dossier info for the stated patient
description:|-
WorkInProgress:The API will require you to provide (as parameters) the purpose of the request and potentially
the person on whose authority this request is being made, which will be logged and reviewed for the
_Principle of Least Privilege_ policy.
parameters:
- name:bsn
in:query
description:|-
The SSN (dutch:_BSN_) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0.
Either `bsn` or `pu` must be present.
schema:
type:string
example:123456789
- name:pu
in:query
description:|-
The Patient unique ID, as e.g. reported by `/patient/base`'s `pat_unid` response.
Either `bsn` or `pu` must be present.
schema:
type:string
example:""
- name:q
in:query
description:|-
A space, comma, or bar-separated list of dossier aspects to query. If omitted, everything is returned.
The keys match the keys in the JSON structure that is returned on a success, such as `medication` or `measurements`.
schema:
type:string
example:"medication,measurements"
responses:
'200':
description:Detailed medical dossier information for the patient is returned.
content:
application/json:
schema:
type:object
properties:
tbd:
description:|-
Work in progress
type:string
example:Work in progress
/patient/base:
/patient/base:
get:
$ref:'paths/patient_base.yaml'
tags:
- patient
summary:Get basic personal info not directly related to their medical dossier
parameters:
- name:bsn
in:query
description:|-
The SSN (dutch:_BSN_) of a patient to look up. May only contain digits, cannot contain more than 9 digits, and cannot be 0.
required:true
schema:
type:string
example:123456789
- $ref:'#/components/parameters/Authorization'
responses:
'200':
description:Basic personal information for the patient is returned.
content:
application/json:
schema:
type:object
required:
- bsn
- name
- gender
- contact
- patid
- pat_unid
- category
- start_date
properties:
bsn:
description:|-
Patient SSN (dutch:_BSN_). If not known or patient has no BSN, this value will be `0`.
It is customary that BSNs are 9 digits; API caller may want to transform this value into
a string by explicitly left-padding `0` characters to the front to make the bsn value 9 digits.
type:number
example:123456789
name:
description:All relevant info about the patient's name.
type:object
properties:
firstname:
description:|-
Patient's first name(s), separated by spaces.
It's possible that no first names are known and instead only initials are known; in that case,
the initials are provided with dots (`.`) in between the letters, e.g. `"J.M."`.
type:string
example:Marie Antoinnette
initials:
description:|-
Patient's initials, with no separators.
Initials might be derived from a patient's first name if initials weren't explicitly provided by
the source HIS.
type:string
example:MA
infix_own:
description:|-
The prefix of the patient's own last name (what they were born with; not the name inherited from
a spouse):`van`, `de`, `van der` - a mostly uniquely dutch aspect to last names.
type:string
example:de
own_lastname:
description:|-
The patient's own last name without a prefix (what they were born with; not the name inherited from
a spouse).
type:string
example:Villepin
infix_partner:
description:|-
The prefix of the patient's (ex-)spouse's last name; not all patients that are married go by their spouse's last name and often, if they don't, this field will be blank.
type:string
example:van der
partner_lastname:
description:|-
The the patient's (ex-)spouse's last name without prefix; not all patients that are married go by their spouse's last name and often, if they don't, this field will be blank.
Note that by convention, patients whose birthdate is unknown pick a date and tend to pick either `xxxx-01-01` or `xxxx-07-01`. Can, in rare cases, be unavailable - if birth date is not known.
type:string
format:date
example:1970-07-01
category:
description:|-
The status of the patient's registration within this practice.
As per [NHG-table-5](https://referentiemodel.nhg.org/sites/default/files/NHG-Tabel%205-Categorie%20pati%C3%ABnt-versie-5-Inkijkexemplaar_1.pdf):
- `V` = Standard patient, part of the GP's population (dutch:_vast_).
- `T` = Temporary patient (likely do _not_ treat as part of GP's population).
- `P` = Opportunity patient (dutch: _passant_ - patient is not signed up with this GP. For example:tourist).
type:string
example:V
doctor:
description:|-
If known, the AGB code of the primary care GP (dutch:_Inschrijf arts_). Value 0 indicates
this HIS or practice doesn't assign patients to individual GPs, or this information isn't
known.
type:number
example:1051234
address:
description:Patient's address (where they live). If not known, this property will not be in the response.
type:object
properties:
street:
description:Full name of the street, excluding house number.
type:string
example:Lange Geer
housenumber:
description:|-
Just the house number; 0 if unknown or in the exotic case where no house number exists. This does
not include any addendums such as 'A' or 'room 15'. Guaranteed to be non-negative.
type:integer
example:4
housenumber_suffix:
description:|-
Often empty, the string that follows the numeric part of the address house number. For example, `"A"`, or
`"k22"`.
type:string
example:A
postcode:
description:The post code, in `1234AB` format. If not known, blank.
type:string
example:2611PV
city:
description:The city or town.
type:string
example:Delft
contact:
type:object
properties:
tel:
description:|-
Patient's phone number(s). By convention, the mobile number, if available, is always listed first.
Phone numbers are always in international format (they start with a `+` symbol).
If no phone numbers are available or patient has no phone, an empty list is returned.
type:array
example:["+31612345678","+31701234567"]
items:
type:string
email:
description:|-
Patient's email address(es); first one returned is indicated as preferred.
If no emails are known or available, or patient has no email, an empty list is returned.
type:array
items:
type:string
example:["info@zorgoporde.nl"]
insurance:
description:|-
Info about where the patient is insured. If patient is not insured, this field will not be present.
Only the main insurance used for reimbursement of GP costs will be returned, if any such insurance exists.
type:object
properties:
policy_number:
description:|-
Patient's insurance registration number (dutch:_polisnummer_).
type:string
example:123456789012345
uzovi:
description:|-
Insurer's identity number in the dutch insurance system (dutch:_UZOVI nummer_). Always
4digits exactly, 0-left-padded if needed. If unknown or not insured, 4 zeroes.
type:number
example:101
patid:
description:|-
Patient's "public" ID, as used and shown on the HIS patient page. Not necessarily unique,
and not necessarily present; 0 indicates no patid is known or this HIS does not use (numeric)
public IDs.
type:number
example:1234
pat_unid:
description:|-
Patient's unique and persistent ID in HIS. Usually identical to `patid` but certain HISes may
use UUID, or has globally unique keys (e.g. very large numbers). Can be blank, but only
if supplying HIS does not send them.
type:string
example:1234
start_date:
type:string
format:date
description:|-
Date patient joined the practice (dutch:_inschrijf datum_).
In rare cases, a patient joined so long ago, this date is no longer known. In this case,
a sentinel value of `"1900-01-01"` is sent which is presumed to result in the desired behaviour
(which is to consider this patient as part of this practice's population regardless of how far
back you want to go).
example:1994-08-20
end_date:
type:string
format:date
description:|-
If not blank, patient has exited the practice on this date. (dutch:_uitschrijf datum_).
example:""
end_reason:
description:|-
Reason patient left the practice (dutch:_reden vertrek_).
This will always be blank if `end_date` is blank. Otherwise, this value _might_ contain
a non-blank letter as per [NHG-table-9](https://referentiemodel.nhg.org/sites/default/files/NHG-Tabel%209-Reden%20vertrek-versie-5-Inkijkexemplaar_1.pdf):
- `A` = To other practice
- `V` = Moved
- `O` = died
- `T` = Temporary
- `I` = Care home / institution
- `Q` = unknown
- `X` = Other
type:string
example:""
'400':
description:The request is invalid; for example, it doesn't contain the required `BSN` parameter.
'401':
$ref:'#/components/responses/JwtFailure'
'403':
description:Indicated practice is known but has not authorized ZOO to share this information with signer.
'404':
$ref:'#/components/responses/PatNotFound'
/qoc/careprogram:
/qoc/careprogram:
get:
$ref:'paths/qoc_careprogram.yaml'
tags:
- Quality of Care
summary:List all available care programs
description:Includes all care programs that the user is allowed to see, even ones that are unfavourited or not shown by default.
summary:Favourite, unfavourite, or clear fav status for a given CareProgram
parameters:
- name:careprogramKey
in:path
description:key of care program for which the fav status needs to be changed
required:true
schema:
type:string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type:string
example:T
enum:
- T
- F
- X
responses:
'200':
description:Fav status is updated
content:
application/json:
schema:
type:object
properties:
key:
description:The care program key as provided
type:string
example:ZEL-dm2
value:
description:The current fav status of this careprogram
type:string
example:T
enum:
- T
- F
- X
defaultShow:
description:Whether this care program should be default-shown or not.
type:boolean
'401':
$ref:'#/components/responses/NoAuth'
'403':
$ref:'#/components/responses/NoAccess'
/qoc/indicatorset/{setKey}:
/qoc/indicatorset/{setKey}:
get:
$ref:'paths/qoc_indicatorset_{setKey}.yaml'
tags:
- Quality of Care
summary:Load an indicator-based report
parameters:
- name:setKey
in:path
description:The key as listed in the `CareProgram` schema.
required:true
schema:
type:string
example:ZEL-dm2
- name:refDate
in:query
description:|-
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
required:false
schema:
type:string
format:date
example:2023-04-01
responses:
'200':
description:all data required to render an indicatorset is returned
content:
application/json:
schema:
$ref:'#/components/schemas/IndicatorSet'
'401':
$ref:'#/components/responses/NoAuth'
'403':
$ref:'#/components/responses/NoAccess'
'404':
description:The provided `setKey` doesn't refer to a valid program.
components:
components:
schemas:
schemas:
IndicatorSet:
IndicatorSet:
description:|-
$ref:'schemas/IndicatorSet.yaml'
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:
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
indicators:
description:The indicators in this chapter
type:array
items:
$ref:'#/components/schemas/Indicator'
Indicator:
Indicator:
description:|-
$ref:'schemas/Indicator.yaml'
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:
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
CareProgram:
CareProgram:
type:object
$ref:'schemas/CareProgram.yaml'
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.
Reinier Zwitserloot
3 years ago