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.
zoo-api/paths/qoc_indicator_{setKey}_{ind...

45 lines
1.5 KiB
YAML

get:
operationId: indicatorSetParticipants
tags:
- Quality of Care
summary: Indicator, practice details
description: Show per-practice details for each practice in a group for a specific indicator.
parameters:
- name: setKey
in: path
description: The key as listed in the `CareProgram` schema.
required: true
schema:
type: string
example: ZEL-dm
- name: indicatorKey
in: path
description: The key as listed in the indicator set.
required: true
schema:
type: string
example: ZOO-dm2-hb-3
- 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
- $ref: '../zoo-api.yaml#/components/parameters/CareGroup'
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses:
'200':
description: >-
Some descriptive text explaining this indicator in detail as well as per-practice stats that can be rendered as a table or graph.
content:
application/json:
schema:
$ref: '../schemas/IndicatorParticipants.yaml'
'401':
$ref: '../zoo-api.yaml/#/components/responses/NoAuth'
'403':
$ref: '../zoo-api.yaml#/components/responses/NoAccess'
'404':
description: The provided `setKey` and/or `indicatorKey` do not refer to a valid program or indicator.