Replaced 'enddate' with 'active' in population statistics. Updated all statistics API's with AGB-subject parameter.

EH/population-statistics-authorisation
Eric Hoekstra 1 year ago
parent e07a92116c
commit 09795ff490

@ -6,6 +6,7 @@ get:
description: |- description: |-
Groups the patient population by any combination of age, preferred doctor, etc. and calculates the count of each category. Groups the patient population by any combination of age, preferred doctor, etc. and calculates the count of each category.
parameters: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/AgbSubject'
- $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday' - $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday'
- name: groupByItems - name: groupByItems
in: query in: query

@ -32,11 +32,10 @@ get:
properties: properties:
item: item:
$ref: ../schemas/StatisticsGroupBy-enum.yaml $ref: ../schemas/StatisticsGroupBy-enum.yaml
enddate: description: All possible enum values are always in the output.
$ref: ../schemas/date.yaml
active: active:
type: boolean type: boolean
description: False if the end date is today or in the past. description: True if authorised, otherwise false.
caregroups: caregroups:
type: array type: array
items: items:

@ -15,17 +15,15 @@ post:
in: path in: path
schema: schema:
$ref: '../schemas/tag.yaml' $ref: '../schemas/tag.yaml'
- name: agb - $ref: '../zoo-api.yaml#/components/parameters/AgbSubject'
in: query
schema:
$ref: '../schemas/agb.yaml'
description: AGB of the practice for which the authorisation should be set. This should match the JWT-authorisation.
required: true required: true
- name: enddate description: AGB of the practice for which the authorisation should be set. This should match the JWT-authorisation.
- name: active
in: query in: query
schema: schema:
$ref: ../schemas/date.yaml type: boolean
description: End date of the authorisation (exclusive). If omitted no end date is applied, or the end date is removed of an existing authorisation. Setting an end date to today or in past, effectively removes the authorisation. required: true
description: True to set the authorisation, false to remove.
- name: employee - name: employee
in: query in: query
schema: schema:

@ -11,17 +11,15 @@ post:
schema: schema:
$ref: '../schemas/StatisticsGroupBy-enum.yaml' $ref: '../schemas/StatisticsGroupBy-enum.yaml'
required: true required: true
- name: agb - $ref: '../zoo-api.yaml#/components/parameters/AgbSubject'
in: query
schema:
$ref: '../schemas/agb.yaml'
description: AGB of the practice for which the authorisation should be set. This should match the JWT-authorisation.
required: true required: true
- name: enddate description: AGB of the practice for which the authorisation should be set. This should match the JWT-authorisation.
- name: active
in: query in: query
schema: schema:
$ref: ../schemas/date.yaml type: boolean
description: End date of the authorisation (exclusive). If omitted no end date is applied, or the end date is removed of an existing authorisation. Setting an end date to today or in past, effectively removes the authorisation. description: True to set the authorisation, false to remove.
required: true
- name: employee - name: employee
in: query in: query
schema: schema:

@ -5,6 +5,7 @@ get:
summary: Deprived neighborhood, patients summary: Deprived neighborhood, patients
description: The list of patients belonging to one of the categories, see `neighborhood` below. description: The list of patients belonging to one of the categories, see `neighborhood` below.
parameters: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/AgbSubject'
- $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday' - $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday'
- name: neighborhood - name: neighborhood
in: path in: path

@ -4,10 +4,8 @@ get:
operationId: groupByItems operationId: groupByItems
summary: Group-by items summary: Group-by items
parameters: parameters:
- name: agb - $ref: '../zoo-api.yaml#/components/parameters/AgbSubject'
in: query required: true
schema:
$ref: ../schemas/agb.yaml
responses: responses:
200: 200:
description: |- description: |-

@ -133,6 +133,13 @@ components:
required: false required: false
schema: schema:
$ref: schemas/agb.yaml $ref: schemas/agb.yaml
AgbSubject:
name: agb
in: query
schema:
$ref: schemas/agb.yaml
description: |-
The AGB of the practice for which the operation is executed. In other words: the subject of the operation. It is expected that the AGB is the same as the AGB of the logged in practice or one of the AGB's of the care group its practices.
Pretty: Pretty:
name: pretty name: pretty
in: query in: query

Loading…
Cancel
Save