ZorgOpOrde
/
zoo-api
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[qoc] Simplified the API for CarePrograms based on IAMIT feedback

Browse Source
EH/population-statistics-authorisation
Reinier Zwitserloot 3 years ago
parent 4690e80b67
commit 11c28bbf75
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296
4 changed files with 100 additions and 272 deletions
Show Stats Download Patch File Download Diff File

236
examples/qoc_careprogram.1.json
Unescape Escape View File

@ -1,210 +1,55 @@
{ {
"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": [ "programs": [
{ {
"key": "ZOO-dm", "key": "ZOO-dm-poc",
"name": "Diabetes Mellitus type 2", "name": "Diabetes Mellitus Oproepen",
"defaultShow": true, "description": "ZorgOpOrde standaard Diabetes Mellitus ketenzorg voor POHs (oproepen en patiënt populatie gezond houden). Indien er geen specifiek op uw zorggroep aangepaste DM definitie beschikbaar is.",
"tags": [
"DM",
"ZorgOpOrde",
"Oproepen"
],
"defaultShow": false,
"favState": "X", "favState": "X",
"reports": [ "type": "indicatorset"
{ },{
"type": "indicatorset", "key": "ZOO-dm-acc",
"name": "Oproepen", "name": "Diabetes Mellitus Accrediteren",
"key": "ZOO-dm-poc" "description": "ZorgOpOrde standaard Diabetes Mellitus ketenzorg voor accrediteren, vergelijken met andere zorggroepen, en onderhandelen met de zorgverzekeraars. Indien er geen specifiek op uw zorggroep aangepaste DM definitie beschikbaar is.",
}, "tags": [
{ "DM",
"type": "indicatorset", "ZorgOpOrde",
"name": "Accrediteren", "Accrediteren"
"key": "ZOO-dm-acc" ],
}, "defaultShow": false,
{
"type": "link",
"name": "InEen '22 benchmark",
"link": "/indicators/accreditatie?sets=IE22-dm"
}
]
},
{
"key": "ZOO-copd",
"name": "COPD",
"defaultShow": true,
"favState": "X", "favState": "X",
"reports": [ "type": "indicatorset"
{
"type": "indicatorset",
"name": "Oproepen",
"key": "ZOO-copd-poc"
},
{
"type": "indicatorset",
"name": "Accrediteren",
"key": "ZOO-copd-acc"
}, },
{ {
"type": "link", "key": "IE22-copd",
"name": "InEen '22 benchmark", "name": "InEen 2022 COPD",
"link": "/indicators/accreditatie?sets=IE22-copd" "description": "InEen '22 invulformat voor COPD ketenzorg"
} "tags": [
] "COPD",
}, "InEen2022",
{ ],
"key": "ZOO-oz",
"name": "Ouderenzorg",
"defaultShow": false, "defaultShow": false,
"favState": "T", "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", "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" "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", "key": "ZEL-dm",
"name": "VVR", "name": "Diabetes Mellitus (ZEL) Oproepen",
"description": "Zorggroep ZEL (<em>regio NWN/DWO</em>) Diabetes Mellitus ketenzorg voor POHs (oproepen en patiënt populatie gezond houden).",
"tags": [
"DM",
"ZEL",
"Oproepen"
],
"defaultShow": true, "defaultShow": true,
"favState": "X", "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", "type": "indicatorset",
"name": "Oproepen",
"key": "ZOO-dexa"
}
]
}, },
{ {
"key": "ZOO-nierfalen", "key": "ZOO-nierfalen",
@ -213,15 +58,8 @@
"defaultShow": false, "defaultShow": false,
"favState": "T", "favState": "T",
"badge": "In ontwikkeling", "badge": "In ontwikkeling",
"reports": [ "type": "casefinder",
{
"type": "link",
"name": "Casefinding",
"url": "/indicators/cf/nierfalen/intro" "url": "/indicators/cf/nierfalen/intro"
} }
] ]
}
]
}
]
} }

6
paths/qoc_careprogram.yaml
Unescape Escape View File

@ -2,7 +2,7 @@ get:
tags: tags:
- Quality of Care - Quality of Care
summary: List all available care programs 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. description: Includes all care programs that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default.e
responses: responses:
'200': '200':
description: |- description: |-
@ -10,7 +10,7 @@ get:
Examples:<ul> Examples:<ul>
<li><a href="examples/qoc_careprogram.1.json">Example complete response</a></li> <li><a href="examples/qoc_careprogram.1.json">Example complete response</a></li>
<li><a href="examples/qoc_careprogram.ui_example.png">Example UI render</a></li> <li><a href="examples/qoc_careprogram.ui_example.png">Example UI render (<em>Somewhat outdated</em>)</a></li>
</ul> </ul>
content: content:
application/json: application/json:
@ -20,7 +20,7 @@ get:
programs: programs:
type: array type: array
items: items:
$ref: '#/components/schemas/CareProgramSet' $ref: '#/components/schemas/CareProgram'
'401': '401':
$ref: '#/components/responses/NoAuth' $ref: '#/components/responses/NoAuth'
'403': '403':

34
schemas/CareProgram.yaml
Unescape Escape View File

@ -15,8 +15,24 @@ properties:
*OPTIONAL* in dutch and in *HTML*, can consist of multiple paragraphs, but won't be more than ~5 lines or so. *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.
tags:
description: |-
A list of very short dutch strings categorizing the care program.
Most care programs have 2 tags:
- one describing the entity that is responsible for the definition (e.g. a 'zorggroep' or standardizing institute such as 'InEen',
- one describing the care program itself, such as 'DM' or 'Ouderenzorg'.
type: array
items:
type: string
example: |-
["ZEL", "DM"]
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.
Care programs with the `defaultShow` property are considered, by the customer, by the customer's 'zorggroep', or
by Zorg op Orde as inherently relevant to the practice. non-`defaultShow` programs are there for practices that want
to look into expanding their care programs or which want to deviate from regional norms. These should be hidden behind
a settings pane where the GP can explicitly enable some non-`defaultShow` programs, or disable some `defaultShow` programs.
type: boolean type: boolean
example: true example: true
favState: favState:
@ -32,32 +48,22 @@ properties:
*OPTIONAL* A very short string to be shown in a badge; dutch text in *HTML*. If omitted, do not show any badge. *OPTIONAL* A very short string to be shown in a badge; dutch text in *HTML*. If omitted, do not show any badge.
type: string type: string
example: In ontwikkeling example: In ontwikkeling
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: type:
description: |- description: |-
The type of the report available for this care program.<dl> 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>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> <dt>link</dt><dd>Load the <code>url</code> property as main page (<code>window.location = ..</code>).</dt>
<dt>casefinder</dt><dd><em>Work in progress</em>; for now, load the <code>url</code> property as main page (<code>window.location = ..</code>).</dt>
</dl> </dl>
enum: enum:
- indicatorset - indicatorset
- link - link
- casefinder
type: string type: string
example: indicatorset example: indicatorset
name:
description: Short description in dutch text; show this in the button.
type: string
example: Indicatoren
url: url:
description: |- description: |-
Only for `type: "link"`. Only for `type: "link"` (<em>Work in progress</em>: For now also for `type: "casefinder"`).
type: string type: string
example: '/indicators/casefinder?t=dm' example: '/indicators/casefinder?t=dm'
key: key:

16
schemas/CareProgramSet.yaml
Unescape Escape View File

@ -1,16 +0,0 @@
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'
Write Preview
Loading…
Cancel
Save