customer careprogram: Updated docs to reflect that single practice bare mode is not enabled yet but will be soon. Also some slight rewording.

EH/population-statistics-authorisation
Reinier Zwitserloot 1 year ago
parent 6cb71d09bd
commit cc3796f866
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -7,8 +7,8 @@ get:
Gets all practices of a care group and their participation in any care program.
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. The care group must 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. For these care groups no practices are shown.
If the JWT identifies a single practice, then API runs in bare mode. The response in this mode has the same structure, but the list of care programs of the care group is always empty and the list of practices holds exactly one practice.
FUTURE: Soon this API will be updated to allow asking for a single practice; optionally, if a care group's AGB is also provided, the list of care programs contracted by the care group is also provided.
parameters:
- name: refDate
in: query
@ -30,14 +30,10 @@ get:
type: string
description: |-
Identifying tag name of the care group.
In bare mode the first of possible several care groups is written in the response (see above for bare mode).
example: demo_fabel
careprograms:
description: |-
All possible care programs for the care group. For every group it known to which programs they are participating. From this set the actual care programs reported in practices property can be substracted to get a list of missing programs.
Empty array in bare mode (see description above).
All care programs contracted by the care group. Subtract from this set the active care programs from any practice reported in `practices` to know which care programs they may want to activate.
example:
- OuderenZorg
- DM
@ -51,7 +47,7 @@ get:
type: array
items:
type: object
properties:
properties:
agb:
$ref: ../schemas/agb.yaml
name:
@ -81,16 +77,16 @@ get:
'403':
$ref: '../zoo-api.yaml/#/components/responses/NoAccess'
post:
tags:
tags:
- Customer management
operationId: setCustomerCareProgram
summary: Add a practice to a care program.
description: |-
Allows a care group manager to classify practices into care groups (ziektebeelden, ketens).
Allows a care group manager to configure which care programs are actively participated in by a GP practice. (care programs = ziektebeelden, ketens).
The caller must authorize itself as a care group (manager).
The care group must be allowed to take responsibility for the practices it holds. If not, the request is ignored and an empty Json-object is sent back to the caller. Indicating that processing was not successful.
The care group must be allowed to take responsibility for the practices it holds. If not, the request is ignored and an empty Json-object is sent back to the caller, indicating that processing was not successful.
The practice must be one of the care group practices. If not, the request is ignored and an empty Json-object is sent back to the caller.
@ -105,7 +101,7 @@ post:
type: object
properties:
careprogram:
description: The kind of care program that the practice participates in.
description: The kind of care program that the practice participates in.
$ref: '../schemas/CareProgram-enum.yaml'
agb:
description: The AGB of the practice (not the doctor).

Loading…
Cancel
Save