Reword summaries to short names.

EH/population-statistics-authorisation
Eric Hoekstra 1 year ago
parent 5df969ddda
commit 14dc280edc

@ -2,7 +2,8 @@ get:
operationId: patientBase operationId: patientBase
tags: tags:
- Patient - Patient
summary: Get basic personal patient info not directly related to their medical dossier summary: Basic personal patient
description: Get basic personal patient info not directly related to their medical dossier
parameters: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/AgbGP' - $ref: '../zoo-api.yaml#/components/parameters/AgbGP'
- name: bsn - name: bsn

@ -2,8 +2,10 @@ get:
operationId: patientDossier operationId: patientDossier
tags: tags:
- Patient - Patient
summary: Get detailed medical dossier info for the stated patient summary: Detailed medical dossier
description: |- description: |-
Get detailed medical dossier info for the stated patient.
WorkInProgress: The API may require you to provide the person on whose authority this request is being made, WorkInProgress: The API may require you to provide the person on whose authority this request is being made,
which will be logged and reviewed for the _Principle of Least Privilege_ policy. which will be logged and reviewed for the _Principle of Least Privilege_ policy.

@ -2,8 +2,10 @@ get:
operationId: patientFundusByGroup operationId: patientFundusByGroup
tags: tags:
- Patient - Patient
summary: Get per-patient funduscopy status for one care group summary: Funduscopy, care group
description: |- description: |-
Get per-patient funduscopy status for one care group.
Returns patients that have an indication for requiring funduscopy across all practices of a care group, taking into account Returns patients that have an indication for requiring funduscopy across all practices of a care group, taking into account
the medical dossier of each patient as well as the care group's policies. the medical dossier of each patient as well as the care group's policies.

@ -2,8 +2,10 @@ get:
operationId: patientFundusByPractice operationId: patientFundusByPractice
tags: tags:
- Patient - Patient
summary: Get per-patient funduscopy status for one GP practice summary: Funduscopy, practice
description: |- description: |-
Get per-patient funduscopy status for one GP practice.
Returns patients that have an indication for requiring funduscopy, taking into account the medical dossier of each patient as well as the relevant care group's policies. Returns patients that have an indication for requiring funduscopy, taking into account the medical dossier of each patient as well as the relevant care group's policies.
For each patient, information about their funduscopy status as well as basic personal information is provided. For each patient, information about their funduscopy status as well as basic personal information is provided.

@ -2,7 +2,8 @@ get:
tags: tags:
- Frequent users - Frequent users
operationId: populationFrequentUserCount operationId: populationFrequentUserCount
summary: "Patient population projected on the number of visits" summary: Visits report
description: Patient population projected on the number of visits.
parameters: parameters:
- name: periodStart - name: periodStart
in: query in: query

@ -2,7 +2,8 @@ get:
tags: tags:
- Frequent users - Frequent users
operationId: populationFrequentUserPatient operationId: populationFrequentUserPatient
summary: "Get the feats of a specific patient" summary: Feats
description: Get the feats of a specific patient. Intended for use after the frequent user report. Is intended for statistical analysis purposes, does not replace the medical dossier.
parameters: parameters:
- name: periodStart - name: periodStart
in: query in: query
@ -18,7 +19,7 @@ get:
in: query in: query
description: |- description: |-
If present, restrict report to patients registered to any of the GP AGBs listed here. 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. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.
example: 01015678,01018765,01014321 example: 01015678,01018765,01014321
schema: schema:
type: array type: array
@ -28,7 +29,7 @@ get:
in: query in: query
description: |- 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. 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. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.
schema: schema:
type: array type: array
items: items:

@ -2,7 +2,8 @@ get:
tags: tags:
- Frequent users - Frequent users
operationId: populationFrequentUserPatients operationId: populationFrequentUserPatients
summary: "Lists the top n (1-50) frequent users (patients)" summary: Frequent users
description: Lists the top n (1-50) frequent users (patients).
parameters: parameters:
- name: periodStart - name: periodStart
in: query in: query
@ -18,7 +19,7 @@ get:
in: query in: query
description: |- description: |-
If present, restrict report to patients registered to any of the GP AGBs listed here. 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. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.
schema: schema:
type: array type: array
items: items:
@ -27,7 +28,7 @@ get:
in: query in: query
description: |- 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. 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. The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat.
example: 01015678,01018765,01014321 example: 01015678,01018765,01014321
schema: schema:
type: array type: array

@ -2,7 +2,7 @@ get:
tags: tags:
- Population statistics - Population statistics
operationId: populationStatistics operationId: populationStatistics
summary: Get a population count summary: Population group-by
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:

@ -2,7 +2,7 @@ get:
tags: tags:
- Population statistics - Population statistics
operationId: populationStatisticsDeprivedNeighborhood operationId: populationStatisticsDeprivedNeighborhood
summary: Patients in a deprived neighborhood summary: Deprived neighborhood
description: A simple report with a count of all patients living in a deprived neighborhood or regular one based on the well-known postcode table. description: A simple report with a count of all patients living in a deprived neighborhood or regular one based on the well-known postcode table.
parameters: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday' - $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday'

@ -2,11 +2,11 @@ get:
tags: tags:
- Population statistics - Population statistics
operationId: groupByItems operationId: groupByItems
summary: Group-by items for population count summary: Group-by items
responses: responses:
200: 200:
description: |- description: |-
Returns a list of all available group-by items for the population count end point, but only if the items are available for the selected customer. A customer is selected by a JWT-claim or the AGB header. The output of this end point should be the same as the documentation for the groupByItems-parameter of the population count end point. Returns a list of all available group-by items for the _population group-by end point_, but only if the items are available for the selected customer. A customer is selected by a JWT-claim or the AGB header. The output of this end point should be the same as the documentation for the groupByItems-parameter of the mentioned end point.
content: content:
application/json: application/json:
schema: schema:

@ -2,9 +2,9 @@ get:
operationId: carePrograms operationId: carePrograms
tags: tags:
- Quality of Care - Quality of Care
summary: List all available care programs summary: All care programs
description: |- description: |-
Includes all care programs that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default. List all available care programs. Includes all care programs that the user is allowed to enable or preview, i.e. even ones that shouldn't be shown by default.
parameters: parameters:
- $ref: '../zoo-api.yaml#/components/parameters/Authorization' - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
responses: responses:

@ -2,7 +2,8 @@ post:
tags: tags:
- Quality of Care - Quality of Care
operationId: setPatientCallUpStatus operationId: setPatientCallUpStatus
summary: Set call-up status for patients in a care program. summary: Call-up status
description: Set call-up status for patients in a care program.
parameters: parameters:
- name: BSN - name: BSN
in: header in: header

@ -2,9 +2,9 @@ get:
operationId: checkUpListSet operationId: checkUpListSet
tags: tags:
- Quality of Care - Quality of Care
summary: Load call-up status for patients in a care program summary: Call-up status
description: |- description: |-
Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program. Load call-up status for patients in a care program. Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
parameters: parameters:
- name: setKey - name: setKey
in: path in: path

@ -2,7 +2,8 @@ get:
operationId: indicatorSetParticipants operationId: indicatorSetParticipants
tags: tags:
- Quality of Care - Quality of Care
summary: Show per-practice details for each practice in a group for a specific indicator summary: Indicator, practice details
description: Show per-practice details for each practice in a group for a specific indicator
parameters: parameters:
- name: setKey - name: setKey
in: path in: path

@ -2,7 +2,8 @@ get:
operationId: indicatorSetPatients operationId: indicatorSetPatients
tags: tags:
- Quality of Care - Quality of Care
summary: Show per-patient details for a specific indicator summary: Indicator, patient detail
description: Show per-patient details for a specific indicator.
parameters: parameters:
- name: setKey - name: setKey
in: path in: path

@ -2,7 +2,8 @@ get:
operationId: indicatorSet operationId: indicatorSet
tags: tags:
- Quality of Care - Quality of Care
summary: Load an indicator-based report summary: Indicator report
description: Load an indicator-based report.
parameters: parameters:
- name: setKey - name: setKey
in: path in: path
@ -22,7 +23,7 @@ get:
responses: responses:
'200': '200':
description: |- description: |-
all data required to render an indicatorset is returned. All data required to render an indicator set is returned.
Examples: Examples:
* <a href="examples/qoc_indicatorset.1.json">Example complete response</a> * <a href="examples/qoc_indicatorset.1.json">Example complete response</a>

@ -2,7 +2,8 @@ get:
operationId: indicatorReportGroups operationId: indicatorReportGroups
tags: tags:
- Quality of Care - Quality of Care
summary: Show all groups available for indicator reports. A group is a group of GP practices that do (part) of chronic care together. summary: Indicator, care groups
details: Show all care groups available for indicator reports. A group is a group of GP practices that do (part) of chronic care together.
parameters: parameters:
- name: refDate - name: refDate
in: query in: query

@ -2,7 +2,8 @@ get:
operationId: participatingGroups operationId: participatingGroups
tags: tags:
- Quality of Care - Quality of Care
summary: Show each participating GP practice as well as the status of their data for a given indicator report and a given group. summary: Data quality
description: Show each participating GP practice as well as the status of their data for a given indicator report and a given group.
parameters: parameters:
- name: setKey - name: setKey
in: query in: query

@ -90,16 +90,6 @@ components:
Authorization: Authorization:
name: Authorization name: Authorization
in: header in: header
description: |-
The string `"Bearer "` followed by a single-use signed JWT token with the following mandatory claims:
* `kid` **key id**: A string identifying a trusted signer; agreed upon between user and Zorg op Orde beforehand.</li>
* `iat` **Issued at**: Time when this JWT was created and signed. Must be no more than 1 hour ago.
* `jti` **JWT ID**: A unique string used to prevent replay: Any given ID can not be used more than once.
* `agb` **GP AGB**: AGB code (Medical entity identifier); the lookup will be done on the medical dossier data of this practice or entity.
* `exp` _OPTIONAL_ **Expires at**: If included, the request must not be received after this time.
* `nbf` _OPTIONAL_ **Not before**: If included, the request must not be received before this time.
The JWT must be signed, preferably with `HS256`.
required: true required: true
schema: schema:
type: string type: string

Loading…
Cancel
Save