[apidoc] Updates to /qoc/careprogram along with example JSON and an example UI screenshot

EH/population-statistics-authorisation
Reinier Zwitserloot 3 years ago
parent 106406d0e6
commit 611daddd74
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -0,0 +1,227 @@
{
"programsets": [
{
"title": "Ketenzorg programma's (algemeen)",
"description": "Als jouw zorggroep nog niet aangesloten is, kun je altijd gebruik maken van onze algemene indicatoren. Wil je protocollen aanpassen of uitbreiden, <em>laat het ons dan weten!</em> Hier zijn geen kosten aan verbonden. Als je (of jouw zorggroep) andere manieren van registreren gebruikt of bijvoorbeeld een focus wil leggen op een bepaald aspect van een zorgprogramma passen wij de indicatoren daar voor aan.",
"programs": [
{
"key": "ZOO-dm",
"name": "Diabetes Mellitus type 2",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZOO-dm-poc"
},
{
"type": "indicatorset",
"name": "Accrediteren",
"key": "ZOO-dm-acc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-dm"
}
]
},
{
"key": "ZOO-copd",
"name": "COPD",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZOO-copd-poc"
},
{
"type": "indicatorset",
"name": "Accrediteren",
"key": "ZOO-copd-acc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-copd"
}
]
},
{
"key": "ZOO-oz",
"name": "Ouderenzorg",
"defaultShow": false,
"favState": "T",
"reports": [
{
"type": "indicatorset",
"description": "Voor inzichten in uw patiënten reeds aangemeld bij de Ouderenzorg keten.",
"name": "Oproepen",
"key": "ZOO-oz-poc"
},
{
"type": "link",
"description": "Loop door die patiënten heen die nog niet geregistreerd staan voor de ketenzorg, maar waar wel tekenen in het dossier zijn om ze te includeren.",
"name": "Casefinder",
"link": "/indicators/cf/oz/intro"
},
{
"type": "link",
"name": "InEen '22 innovatieset",
"link": "/indicators/accreditatie?sets=IE22-oz"
}
]
}
]
},
{
"title": "Ketenzorg programma's (ZEL)",
"description": "Alle programma's ondersteund door zorggroep ZEL (<em>regio NWN/DWO</em>), opgezet in overleg met de kaderartsen.",
"programs": [
{
"key": "ZEL-dm",
"name": "Diabetes Mellitus type 2",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZEL-dm-poc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-dm"
}
]
},
{
"key": "ZEL-copd",
"name": "COPD",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZEL-copd-poc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-copd"
}
]
},
{
"key": "ZEL-astma",
"name": "Astma",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZEL-astma-poc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-astma"
}
]
},
{
"key": "ZEL-hvz",
"name": "HVZ Ketenzorg (HVZ+AF+HF)",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "HVZ Ketenzorg overzicht",
"key": "ZEL-hvzt"
},
{
"type": "indicatorset",
"name": "HVZ Zorgprogramma",
"key": "ZEL-hvz-poc"
},
{
"type": "indicatorset",
"name": "Atriumfibrilleren (AF)",
"key": "ZEL-af-poc"
},
{
"type": "indicatorset",
"name": "Hartfalen (HF)",
"key": "ZEL-hf-poc"
},
{
"type": "link",
"name": "InEen '22 benchmark HVZ",
"link": "/indicators/accreditatie?sets=IE22-hvz"
}
]
},
{
"key": "ZEL-vvr",
"name": "VVR",
"defaultShow": true,
"favState": "X",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZEL-vvr-poc"
},
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-vvr"
}
]
}
]
},
{
"title": "Overige bepalingen",
"programs": [
{
"key": "ZOO-dexa",
"name": "DEXA scans obv Osteoporose",
"description": "Beoordeel of je patiënten moet opgeroepen voor een DEXA scan obv Osteoporose/penie (en 65+).",
"defaultShow": false,
"favState": "X",
"badge": "In ontwikkeling",
"reports": [
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZOO-dexa"
}
]
},
{
"key": "ZOO-nierfalen",
"name": "Nierfalen",
"description": "Controle op basis van het NHG-registratie advies bij Standard Chronische Nierschade (2019). Je beoordeelt per patiënt of er een (risico op een) nierfunctiestoornis is. Patiënten met een actieve episode U98.03, U99.00, of U99.01 worden door deze casefinder gezien als 'reeds beoordeeld'.",
"defaultShow": false,
"favState": "T",
"badge": "In ontwikkeling",
"reports": [
{
"type": "link",
"name": "Casefinding",
"url": "/indicators/cf/nierfalen/intro"
}
]
}
]
}
]
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 507 KiB

@ -9,9 +9,12 @@ get:
content: content:
application/json: application/json:
schema: schema:
type: object
properties:
programs:
type: array type: array
items: items:
$ref: '#/components/schemas/CareProgram' $ref: '#/components/schemas/CareProgramSet'
'401': '401':
$ref: '#/components/responses/NoAuth' $ref: '#/components/responses/NoAuth'
'403': '403':

@ -14,6 +14,8 @@ put:
application/x-www-form-urlencoded: application/x-www-form-urlencoded:
schema: schema:
type: string type: string
description: |-
The value `T`/`F`/`X`, respectively: "favourited", "unfavourited", "no favourite status"
example: T example: T
enum: enum:
- T - T
@ -28,7 +30,8 @@ put:
type: object type: object
properties: properties:
key: key:
description: The care program key as provided description: |-
The care program key as provided in `/qoc/careprogram`'s `key` property of a careprogram.
type: string type: string
example: ZEL-dm2 example: ZEL-dm2
value: value:

@ -1,16 +1,24 @@
type: object type: object
properties: properties:
key:
description: >-
A unique string (always ASCII, no spaces) identifying this care program.
Can be used to fave/unfave.
type: string
example: ZOO-dm
name: name:
description: Human readable text in dutch, guaranteed to be quite short. description: Human readable text in dutch, guaranteed to be quite short.
type: string type: string
example: Diabetes Mellitus type 2 (ZEL) example: Diabetes Mellitus type 2 (ZEL)
description: description:
description: in dutch and in *HTML*, can consist of multiple paragraphs, but won't be more than ~5 lines or so. description: |-
*OPTIONAL* in dutch and in *HTML*, can consist of multiple paragraphs, but won't be more than ~5 lines or so.
type: string type: string
example: Ketenzorg DM2 volgens de standaard werkwijze van zorgggroep ZEL. example: Ketenzorg DM2 volgens de standaard werkwijze van zorgggroep ZEL.
defaultShow: defaultShow:
description: If `true`, show this unless explicitly unfavourited. If `false`, do not show unless explicitly favourited. description: If `true`, show this unless explicitly unfavourited. If `false`, do not show unless explicitly favourited.
type: boolean type: boolean
example: true
favState: favState:
description: If `T`, always show this. If `F`, never show it. If `X`, show if `defaultShow` is `true`. description: If `T`, always show this. If `F`, never show it. If `X`, show if `defaultShow` is `true`.
type: string type: string
@ -19,6 +27,11 @@ properties:
- T - T
- F - F
- X - X
badge:
description: |-
*OPTIONAL* A very short string to be shown in a badge; dutch text in *HTML*. If omitted, do not show any badge.
type: string
example: In ontwikkeling
reports: reports:
description: |- description: |-
A care program offers 1 or more reports; any given report is generally very different from another. A care program offers 1 or more reports; any given report is generally very different from another.
@ -28,25 +41,29 @@ properties:
type: object type: object
properties: properties:
type: type:
oneOf: description: |-
- description: An indicator set report. use the `/qol/indicatorset` API endpoint. The type of the report available for this care program.<dl>
<dt>indicatorset</dt><dd>Use the <code>/qol/indicatorset</code> API endpoint.</dd>
<dt>link</dt><dd>Load the <code>url</code> property as main page (<code>window.location = ..</code>).</dt>
</dl>
enum:
- indicatorset
- link
type: string type: string
example: indicatorset example: indicatorset
- description: Resolve by loading the URL in the `url` property (`window.location = ` style).
type: string
example: link
name: name:
description: Short description in dutch text; show this in the button. description: Short description in dutch text; show this in the button.
type: string type: string
example: Indicatoren example: Indicatoren
url: url:
description: >- description: |-
Only for `type: "link"`. Only for `type: "link"`.
type: string type: string
example: '/indicators/casefinder?t=dm' example: '/indicators/casefinder?t=dm'
key: key:
description: >- description: |-
A unique string (always ASCII, no spaces) identifying this care program. Only for `type: "indicatorset"`.
Pass to `/qoc/indicatorset` API, or can be used for fave/unfave. A unique string (always ASCII, no spaces) identifying this indicatorset.
Pass to `/qoc/indicatorset` API.
type: string type: string
example: ZEL-dm2 example: ZEL-dm2

@ -0,0 +1,16 @@
type: object
properties:
title:
description: Human readable text in dutch, guaranteed to be quite short.
type: string
example: Ketenzorg programma's (algemeen)
description:
description: |-
*OPTIONAL* in dutch and in *HTML*, can consist of multiple paragraphs.
type: string
example: |-
Als jouw zorggroep nog niet aangesloten is, kun je altijd gebruik maken van onze algemene indicatoren. Wil je protocollen aanpassen of uitbreiden, <em>laat het ons dan weten!</em> Hier zijn geen kosten aan verbonden. Als je (of jouw zorggroep) andere manieren van registreren gebruikt of bijvoorbeeld een focus wil leggen op een bepaald aspect van een zorgprogramma passen wij de indicatoren daar voor aan.
programs:
type: array
items:
$ref: '#/components/schemas/CareProgram'

@ -2,6 +2,10 @@ 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 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 type: object
properties: 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: name:
description: Human readable dutch text; should fit in one line. description: Human readable dutch text; should fit in one line.
type: string type: string

@ -56,6 +56,8 @@ components:
$ref: 'schemas/Indicator.yaml' $ref: 'schemas/Indicator.yaml'
CareProgram: CareProgram:
$ref: 'schemas/CareProgram.yaml' $ref: 'schemas/CareProgram.yaml'
CareProgramSet:
$ref: 'schemas/CareProgramSet.yaml'
parameters: parameters:
Authorization: Authorization:

Loading…
Cancel
Save