Docs for customer care program GET added.

EH/population-statistics-authorisation
Eric Hoekstra 1 year ago
parent 40ce61ade2
commit 765583ccbf

@ -0,0 +1,30 @@
get:
operationId: customercareProgram
tags:
- Customer management
summary: All practices and their participation in care programs.
description: |-
Enumerates all practices for which the current customer (user) is responsible in the care group. The customer identified with the JWT must be the group manager, otherwise the API will respond with a HTTP not authorized response. The care group must also be responsible for the underlying practices. Some care groups are organized in a way that they are not allowed to process data of the member practices. These groups are ignored by this API and produce empty output.
responses:
'200':
description: All practices for which the care group takes responsibility.
content:
application/json:
schema:
type: array
items:
type: object
properties:
practice:
description: The name of the practice.
type: string
careprograms:
type: array
items:
$ref: '../schemas/CareProgram-enum.yaml'
gpis:
$ref: '../schemas/GPIS.yaml'
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'

@ -41,6 +41,7 @@ tags:
- Care programs that are shown by default to this customer which they did not explicitly unfavourite. - Care programs that are shown by default to this customer which they did not explicitly unfavourite.
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.
- name: Customer management
paths: paths:
/patient/dossier: /patient/dossier:
$ref: 'paths/patient_dossier.yaml' $ref: 'paths/patient_dossier.yaml'
@ -64,12 +65,12 @@ paths:
$ref: 'paths/population_frequentUser_patient.yaml' $ref: 'paths/population_frequentUser_patient.yaml'
/qoc/careprogram: /qoc/careprogram:
$ref: 'paths/qoc_careprogram.yaml' $ref: 'paths/qoc_careprogram.yaml'
/qoc/indicatorset/{setKey}:
$ref: 'paths/qoc_indicatorset_{setKey}.yaml'
/qoc/checkupList/{setKey}: /qoc/checkupList/{setKey}:
$ref: 'paths/qoc_checkupList_{setKey}.yaml' $ref: 'paths/qoc_checkupList_{setKey}.yaml'
/qoc/checkupList/setStatus: /qoc/checkupList/setStatus:
$ref: 'paths/qoc_checkupList_set_status.yaml' $ref: 'paths/qoc_checkupList_set_status.yaml'
/qoc/indicatorset/{setKey}:
$ref: 'paths/qoc_indicatorset_{setKey}.yaml'
/qoc/indicator/{setKey}/{indicatorKey}/patients: /qoc/indicator/{setKey}/{indicatorKey}/patients:
$ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml' $ref: 'paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml'
/qoc/indicator/{setKey}/{indicatorKey}/participants: /qoc/indicator/{setKey}/{indicatorKey}/participants:
@ -78,6 +79,8 @@ paths:
$ref: 'paths/qoc_list-groups.yaml' $ref: 'paths/qoc_list-groups.yaml'
/qoc/participating-practices: /qoc/participating-practices:
$ref: 'paths/qoc_participating-practices.yaml' $ref: 'paths/qoc_participating-practices.yaml'
/customer/careprogram:
$ref: 'paths/customer-careprogram.yaml'
components: components:
parameters: parameters:
Authorization: Authorization:

Loading…
Cancel
Save