[review] `number` to `integer`, and some minor cleanup.

EH/population-statistics-authorisation
Reinier Zwitserloot 2 years ago
parent 1b1a7fa38b
commit 8bf8a53487
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -21,8 +21,8 @@ get:
schema: schema:
type: array type: array
items: items:
type: number
- name: doctorCodes - name: doctorCodes
type: integer
in: query in: query
description: Code of the doctor as known in the HIS. description: Code of the doctor as known in the HIS.
schema: schema:
@ -36,8 +36,11 @@ get:
$ref: ../schemas/med_dossier/FeatCode.yaml $ref: ../schemas/med_dossier/FeatCode.yaml
- name: patients - name: patients
in: query in: query
description: If present, restrict output to only patients in this list.
schema: schema:
$ref: ../schemas/pat-patId.yaml type: array
items:
$ref: ../schemas/pat-patId.yaml
responses: responses:
200: 200:
description: "An object with at least the frequency property which holds an array with the number of visits and their frequency." description: "An object with at least the frequency property which holds an array with the number of visits and their frequency."
@ -54,9 +57,9 @@ get:
type: object type: object
properties: properties:
visits: visits:
type: number type: integer
frequency: frequency:
type: number type: integer
example: example:
- {visits: 1, frequency: 355} - {visits: 1, frequency: 355}
- {visits: 2, frequency: 240} - {visits: 2, frequency: 240}
@ -69,4 +72,3 @@ get:
$ref: '../zoo-api.yaml#/components/responses/NotToBeShare' $ref: '../zoo-api.yaml#/components/responses/NotToBeShare'
404: 404:
$ref: '../zoo-api.yaml#/components/responses/PatNotFound' $ref: '../zoo-api.yaml#/components/responses/PatNotFound'

@ -20,8 +20,8 @@ get:
schema: schema:
type: array type: array
items: items:
type: number
- name: doctorCodes - name: doctorCodes
type: integer
in: query in: query
description: Code of the doctor as known in the HIS. description: Code of the doctor as known in the HIS.
example: 01015678,01018765,01014321 example: 01015678,01018765,01014321
@ -40,7 +40,8 @@ get:
$ref: ../schemas/pat-patId.yaml $ref: ../schemas/pat-patId.yaml
responses: responses:
200: 200:
description: "Lists for exactly one patient all feats per day. All ICPC codes which can be found on a given day are added to the combination of feat and day. This causes duplicate output of the ICPC codes if two or more different feats are registered on the same day. This is due a lack of the registration of the exact time of the contact moment in most HIS's." description: |-
Lists for exactly one patient all feats per day. All ICPC codes which can be found on a given day are added to the combination of feat and day. This causes duplicate output of the ICPC codes if two or more different feats are registered on the same day. This is due to a lack of the registration of the exact time of the contact moment in some GP information systems.
content: content:
application/json: application/json:
schema: schema:
@ -54,13 +55,13 @@ get:
type: object type: object
properties: properties:
featCode: featCode:
type: number type: integer
example: 12001 example: 12001
date: date:
type: string $ref: ../schemas/date.yaml
example: 2018-03-29
employee: employee:
type: string type: string
description: The memocode as used in the GP Information System for the employee that is responsible for these feats.
example: RH example: RH
memoCode: memoCode:
type: string type: string
@ -70,7 +71,6 @@ get:
example: consult huisarts langer dan 20 minuten example: consult huisarts langer dan 20 minuten
patId: patId:
$ref: ../schemas/pat-patId.yaml $ref: ../schemas/pat-patId.yaml
example: 13046
icpc: icpc:
type: array type: array
items: items:

@ -2,7 +2,7 @@ get:
tags: tags:
- Frequent users - Frequent users
operationId: populationFrequentUserPatients operationId: populationFrequentUserPatients
summary: "Lists the top 20 frequent users (patients)" summary: "Lists the top n (1-50) frequent users (patients)"
parameters: parameters:
- name: periodStart - name: periodStart
in: query in: query
@ -20,8 +20,8 @@ get:
schema: schema:
type: array type: array
items: items:
type: number
- name: doctorCodes - name: doctorCodes
type: integer
in: query in: query
description: Code of the doctor as known in the HIS. description: Code of the doctor as known in the HIS.
example: 01015678,01018765,01014321 example: 01015678,01018765,01014321
@ -36,8 +36,11 @@ get:
$ref: ../schemas/med_dossier/FeatCode.yaml $ref: ../schemas/med_dossier/FeatCode.yaml
- name: patients - name: patients
in: query in: query
description: If present, restrict output to only patients in this list.
schema: schema:
$ref: ../schemas/pat-patId.yaml type: array
items:
$ref: ../schemas/pat-patId.yaml
- name: ppi - name: ppi
in: query in: query
description: "Allow patient personal identifying information in the response. Defaults to false if omitted." description: "Allow patient personal identifying information in the response. Defaults to false if omitted."
@ -48,10 +51,12 @@ get:
in: query in: query
description: "Some integer between 1 and 50. Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range." description: "Some integer between 1 and 50. Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range."
schema: schema:
type: number type: integer
minimum: 1
maximum: 50
responses: responses:
200: 200:
description: "Responses an array with patients. Only the top 20 users is exported. The output is ranked with the most frequent user at position 0 of the array." description: "Responds with an array with patients. Only the top `limit` users are exported. The output is ranked with the most frequent user at position 0 of the array."
content: content:
application/json: application/json:
schema: schema:

@ -1,3 +1,4 @@
description: Date without time part in ISO-8601 format. description: Date without time part in ISO-8601 format.
type: string type: string
format: date
example: "1970-01-13" example: "1970-01-13"

@ -1,2 +1,2 @@
description: "Vektis COD367 list 8 feat code expressed as an integer." description: "Vektis COD367 list 8 feat code expressed as an integer."
type: number type: integer

@ -205,4 +205,4 @@ components:
- practice - practice
- patient - patient
NotToBeShare: NotToBeShare:
description: "Indicated practice is known but has not authorized ZOO to share this information with signer." description: Indicated practice is known but has not authorized ZOO to share this information with signer.
Loading…
Cancel
Save