diff --git a/paths/customer_careprogram.yaml b/paths/customer_careprogram.yaml index 77372e3..fc24c3a 100644 --- a/paths/customer_careprogram.yaml +++ b/paths/customer_careprogram.yaml @@ -2,11 +2,12 @@ get: operationId: getCustomerCareProgram tags: - Customer management - summary: Get all practices and their participation in any care program. + summary: Practices and 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. - 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. - parameters: + 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. + parameters: - name: refDate in: query $ref: ../schemas/date.yaml @@ -22,8 +23,20 @@ get: type: object properties: practice: - description: The name of the practice. - type: string + type: object + properties: + name: + type: string + agb: + $ref: ../schemas/agb.yaml + gpisType: + description: The type of general practitioner information system (EDP). + type: string + example: Tetrapod + timestamp: + description: |- + The report is based on dossier data as it was on this timestamp; due to inaccuracies by general practitioner information systems that source the data, this value is not always accurate and can be off by as much as a week. + $ref: ../schemas/dateTime.yaml careprograms: type: array items: @@ -38,8 +51,6 @@ get: active: type: boolean description: True if today is on or after `periodStart` and before `periodEnd`. - gpis: - $ref: '../schemas/GPIS.yaml' '401': $ref: '../zoo-api.yaml/#/components/responses/NoAuth' '403': diff --git a/paths/customer_careprogram_periodEnd.yaml b/paths/customer_careprogram_periodEnd.yaml index 2d8abe0..a62cdbe 100644 --- a/paths/customer_careprogram_periodEnd.yaml +++ b/paths/customer_careprogram_periodEnd.yaml @@ -2,10 +2,9 @@ post: tags: - Customer management operationId: setCustomerCareProgramPeriodEnd - summary: Update the period end of a practice in a care program. + summary: Update only the period end description: |- - Updates only the period end date of the participation of a practice in a care program. This is equivalent to submitting a new participation to this API, but, the `periodStart` parameter is not needed. - Requires that this practice already participates in the provided care program (and that participation will get its end date updated). + Updates only the period end date of the participation of a practice in a care program. This is equivalent to submitting a new participation to this API, but, the `periodStart` parameter is not needed. Requires that this practice already participates in the provided care program (and that participation will have its end date updated). requestBody: content: 'application/x-www-form-urlencoded': @@ -19,8 +18,8 @@ post: description: The AGB of the practice (not the doctor). $ref: '../schemas/agb.yaml' employee: - type: string - description: The employee that is adding the practice. Any string is accepted, but it is recommended to use a employee code derived from this API. + type: string + description: The employee that is adding the practice. Any string is accepted, but it is recommended to use a employee code derived from this API. periodEnd: description: The end of the period of the participation. Allowed to be not set or empty, when no end date is known. If set, `periodEnd` must be at least a day after the `periodStart` which is stored for the combination of `careprogram` and `agb`. $ref: ../schemas/date.yaml