You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
101 lines
4.3 KiB
YAML
101 lines
4.3 KiB
YAML
get:
|
|
tags:
|
|
- Quality of Care
|
|
summary: Show each participating GP practice as well as the status of their data for a given indicator report and a given group.
|
|
parameters:
|
|
- name: setKey
|
|
in: query
|
|
description: The key as listed in the `CareProgram` schema. If omitted, information about participating in a specific care program will not be provided.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: ZEL-dm
|
|
- name: group
|
|
in: query
|
|
description: The key as listed in the `list-groups` endpoint. Defaults to the only allowed group if the authentication party only has one; otherwise required.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
example: hwf
|
|
- name: refDate
|
|
in: query
|
|
description: |-
|
|
The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
|
|
required: false
|
|
schema:
|
|
$ref: ../schemas/date.yaml
|
|
responses:
|
|
'200':
|
|
description: >-
|
|
A list of practices participating in this group.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
group:
|
|
description: The chosen group (repeats `group` parameter if present, otherwise, the group defaulted to for authenticating user).
|
|
type: string
|
|
example: hwf
|
|
calculatedAt:
|
|
description: |-
|
|
*OPTIONAL*. The timestamp when the group average was calculated. If not present, no group average calculation is available.
|
|
$ref: ../schemas/dateTime.yaml
|
|
refDate:
|
|
description: 'Groups reported are available for this date (dutch: _peildatum_).'
|
|
$ref: ../schemas/date.yaml
|
|
key:
|
|
description: Repeats the `setKey` parameter, if present.
|
|
type: string
|
|
example: ZOO-dm
|
|
title:
|
|
description: The title of the requested indicator set, if `setKey` was present.
|
|
type: string
|
|
example: Diabetes Mellitus type 2
|
|
participants:
|
|
description: A list of practices in this group.
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
agb:
|
|
description: The AGB code for this practice.
|
|
type: number
|
|
example: 1012345
|
|
name:
|
|
description: The name of this practice.
|
|
type: string
|
|
example: Huisartsenpraktijk Mien Dobbelsteen
|
|
gpis:
|
|
description: The type of GP Information System
|
|
type: string
|
|
exclusionReason:
|
|
description: |-
|
|
If present, this GP is excluded from this care program. The value describes (dutch, *HTML*) why.
|
|
If not present, `mostRecentDataAvailable` will be available.
|
|
type: string
|
|
calculationBasedOn:
|
|
description: |-
|
|
If present, this GP practice is calculated for this refDate for this care program, and the calculation
|
|
is based on a snapshot of GPIS data at this instant.
|
|
$ref: ../schemas/dateTime.yaml
|
|
mostRecentDataAvailable:
|
|
description: |-
|
|
If present, this GP practice's most recent available data is a GPIS snapshot with GPIS data at this instant.
|
|
Usually equal to `calculationBasedOn`, but can be newer. If not present, this GP practice has no data available.
|
|
$ref: ../schemas/dateTime.yaml
|
|
required:
|
|
- agb
|
|
- name
|
|
- gpis
|
|
required:
|
|
- group
|
|
- refDate
|
|
- participants
|
|
'401':
|
|
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
|
|
'403':
|
|
$ref: '../zoo-api.yaml#/components/responses/NoAccess'
|
|
'404':
|
|
description: The provided `group` and/or `setKey` do not refer to a valid group or program.
|