[apidoc] [trivial] Renamed QoC to Quality of Care, modified a few descriptions.

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

@ -3,19 +3,10 @@ info:
title: Zorg op Orde API title: Zorg op Orde API
description: |- description: |-
Copyright Zorg op Orde All rights reserved. Copyright Zorg op Orde All rights reserved.
Security is done, for now, via cookies - i.e. just make the API request,
if done from a browser session that is logged in, the API request is handled.
All API requests can return an error state of 'not logged in' or 'not authorized'
(which means, some user is logged in, but is not allowed to see / act the thing they want to see / act on).
contact: contact:
name: Zorg op Orde tech lead name: Zorg op Orde
email: r.zwitserloot@zorgoporde.nl email: api@zorgoporde.nl
version: 0.1-DEV version: 0.1-DEV
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers: servers:
- url: https://tools.zorgoporde.nl/api1 - url: https://tools.zorgoporde.nl/api1
description: Production description: Production
@ -29,9 +20,9 @@ tags:
description: |- description: |-
API for retrieving medical dossier data and concerns based on looking up a API for retrieving medical dossier data and concerns based on looking up a
specific patient. specific patient.
- name: QoC - name: Quality of Care
description: |- description: |-
API related to Quality of Care features API related to Quality of Care (QoC) features
A care program (dutch: _ketenzorg_ or _zorgprogramma_) describes a specific disease (such as Diabetes or Astma) or a more abstract concern such as elderly care or general concern about cardiovascular health. The same care program can show up multiple times, as there are different care programs and standards for the same disease or concern. For example, there could be the InEen report 'take' on how one should provide Diabetes care, and there could be some regional group's slightly different take on it; these would show up as different care programs. A care program (dutch: _ketenzorg_ or _zorgprogramma_) describes a specific disease (such as Diabetes or Astma) or a more abstract concern such as elderly care or general concern about cardiovascular health. The same care program can show up multiple times, as there are different care programs and standards for the same disease or concern. For example, there could be the InEen report 'take' on how one should provide Diabetes care, and there could be some regional group's slightly different take on it; these would show up as different care programs.
@ -130,6 +121,10 @@ paths:
tags: tags:
- patient - patient
summary: Get detailed medical dossier info for the stated 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: parameters:
- name: bsn - name: bsn
in: query in: query
@ -404,7 +399,7 @@ paths:
/qoc/careprogram: /qoc/careprogram:
get: get:
tags: tags:
- QoC - 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 see, even ones that are unfavourited or not shown by default.
responses: responses:
@ -423,7 +418,7 @@ paths:
/qoc/careprogram/{careprogramKey}/fave: /qoc/careprogram/{careprogramKey}/fave:
put: put:
tags: tags:
- QoC - Quality of Care
summary: Favourite, unfavourite, or clear fav status for a given CareProgram summary: Favourite, unfavourite, or clear fav status for a given CareProgram
parameters: parameters:
- name: careprogramKey - name: careprogramKey
@ -472,7 +467,7 @@ paths:
/qoc/indicatorset/{setKey}: /qoc/indicatorset/{setKey}:
get: get:
tags: tags:
- QoC - Quality of Care
summary: Load an indicator-based report summary: Load an indicator-based report
parameters: parameters:
- name: setKey - name: setKey

Loading…
Cancel
Save