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/population_statistics_emplo...

94 lines
3.8 KiB
YAML

get:
tags:
- Population statistics
operationId: populationStatisticsEmployeeFeat
summary: Employee turnover
description: Summaries the performance of employees expressed in feat count and turnover amounts. Only contract and national tariffs are used. Tariffs imported from any HIS are ignored. Contract tariffs as registered by Zorg op Orde or, if not present, national tariffs as published by the government are used. Only to most recent years of national tariffs are available.
parameters:
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
- name: periodStart
in: query
description: Start of the period (including) to summarize.
schema:
$ref: ../schemas/date.yaml
- name: periodEnd
in: query
description: End of the period (excluding) to summarize.
schema:
$ref: ../schemas/date.yaml
- $ref: '../zoo-api.yaml#/components/parameters/GpCodes'
description: |-
Restricts to the GP's which were medical responsible for the feat. Uses the GP at the time of the feat, or if not available, the GP responsible for the patient at the time of the HIS-import. The GP at the time of the feat is the most accurate.
The responsible GP is not written in the response, due the structure of the agreggation.
- name: employees
in: query
description: "Restricts the selection of feats to one or more employees: an employee executed the feat."
schema:
$ref: ../schemas/employee-alias.yaml
- name: excludeNilDeclarations
in: query
description: Declarations for which no tariff can determined, or which tariff equals zero, are omitted.
schema:
type: boolean
responses:
200:
description: Returns a object with a dictionary and an array of employees.
content:
application/json:
schema:
type: object
properties:
dict:
$ref: ../schemas/TermsDictionary.yaml
employees:
type: array
items:
type: object
properties:
alias:
type: string
example: AA
name:
type: string
example: H. Huisman
periods:
type: array
items:
type: object
properties:
year:
type: number
example: 2024
month:
type: number
example: 5
feats:
type: array
items:
type: object
properties:
vektis:
$ref: '../schemas/med_dossier/FeatCode.yaml'
alias:
type: string
example: C2
count:
type: number
description: Count of the number of feats including feats without amount, except if those are excluded, see parameters.
example: 21
amount:
type: number
example: 48342
400:
$ref: '../zoo-api.yaml#/components/responses/ReqFailure'
401:
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
403:
$ref: '../zoo-api.yaml#/components/responses/MandateMissing'
404:
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'