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.
79 lines
2.8 KiB
YAML
79 lines
2.8 KiB
YAML
get:
|
|
tags:
|
|
- Frequent users
|
|
operationId: populationFrequentUserCount
|
|
summary: "Patient population projected on the number of visits"
|
|
parameters:
|
|
- name: periodStart
|
|
in: query
|
|
description: Start of the period (including) to analyze.
|
|
schema:
|
|
$ref: ../schemas/date.yaml
|
|
- name: periodEnd
|
|
in: query
|
|
description: End of the period (excluding) to analyze.
|
|
schema:
|
|
$ref: ../schemas/date.yaml
|
|
- name: doctorAgbCodes
|
|
in: query
|
|
description: |-
|
|
If present, restrict report to patients registered to any of the GP AGBs listed here.
|
|
The restriction is applied to the GP responsible for the patient now, not on the GP reponsislbe at the time of the feat.
|
|
example: 01015678,01018765,01014321
|
|
schema:
|
|
type: array
|
|
items:
|
|
- name: doctorCodes
|
|
type: integer
|
|
in: query
|
|
description: |-
|
|
If present, restrict report to patients registered to any of the GPs listed here; list the memocode as used in the GP Information System.
|
|
The restriction is applied to the GP responsible for the patient now, not on the GP reponsislbe at the time of the feat.
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../schemas/med_dossier/Practitioner.yaml
|
|
- name: featCodes
|
|
in: query
|
|
description: "The feats which are identified as time consuming or otherwise taking effort of the practice, defaults to: 12011,12411,12001,12401,12010,12410."
|
|
schema:
|
|
$ref: ../schemas/med_dossier/FeatCode.yaml
|
|
- name: patients
|
|
in: query
|
|
description: If present, restrict output to only patients in this list.
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../schemas/pat-patId.yaml
|
|
responses:
|
|
200:
|
|
description: "An object with at least the frequency property which holds an array with the number of visits and their frequency."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- frequencies
|
|
properties:
|
|
frequencies:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
visits:
|
|
type: integer
|
|
frequency:
|
|
type: integer
|
|
example:
|
|
- {visits: 1, frequency: 355}
|
|
- {visits: 2, frequency: 240}
|
|
- {visits: 4, frequency: 25}
|
|
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'
|