diff --git a/paths/patient_base.yaml b/paths/patient_base.yaml index c5d532d..e34a3a5 100644 --- a/paths/patient_base.yaml +++ b/paths/patient_base.yaml @@ -2,7 +2,8 @@ get: operationId: patientBase tags: - 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: - $ref: '../zoo-api.yaml#/components/parameters/AgbGP' - name: bsn diff --git a/paths/patient_dossier.yaml b/paths/patient_dossier.yaml index 32291a5..2c36daf 100644 --- a/paths/patient_dossier.yaml +++ b/paths/patient_dossier.yaml @@ -2,8 +2,10 @@ get: operationId: patientDossier tags: - Patient - summary: Get detailed medical dossier info for the stated patient + summary: Detailed medical dossier 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, which will be logged and reviewed for the _Principle of Least Privilege_ policy. diff --git a/paths/patient_fundusByGroup.yaml b/paths/patient_fundusByGroup.yaml index 5f248e7..7ea2764 100644 --- a/paths/patient_fundusByGroup.yaml +++ b/paths/patient_fundusByGroup.yaml @@ -2,8 +2,10 @@ get: operationId: patientFundusByGroup tags: - Patient - summary: Get per-patient funduscopy status for one care group + summary: Funduscopy, care group 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 the medical dossier of each patient as well as the care group's policies. diff --git a/paths/patient_fundusByPractice.yaml b/paths/patient_fundusByPractice.yaml index 405e5fc..3df7887 100644 --- a/paths/patient_fundusByPractice.yaml +++ b/paths/patient_fundusByPractice.yaml @@ -2,8 +2,10 @@ get: operationId: patientFundusByPractice tags: - Patient - summary: Get per-patient funduscopy status for one GP practice + summary: Funduscopy, practice 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. For each patient, information about their funduscopy status as well as basic personal information is provided. diff --git a/paths/population_frequentUser_count.yaml b/paths/population_frequentUser_count.yaml index a2b21cf..74814a1 100644 --- a/paths/population_frequentUser_count.yaml +++ b/paths/population_frequentUser_count.yaml @@ -2,7 +2,8 @@ get: tags: - Frequent users operationId: populationFrequentUserCount - summary: "Patient population projected on the number of visits" + summary: Visits report + description: Patient population projected on the number of visits. parameters: - name: periodStart in: query diff --git a/paths/population_frequentUser_patient.yaml b/paths/population_frequentUser_patient.yaml index 07d88c7..98ab903 100644 --- a/paths/population_frequentUser_patient.yaml +++ b/paths/population_frequentUser_patient.yaml @@ -2,7 +2,8 @@ get: tags: - Frequent users 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: - name: periodStart in: query @@ -18,7 +19,7 @@ get: 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. + 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 schema: type: array @@ -28,7 +29,7 @@ get: 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. + The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat. schema: type: array items: diff --git a/paths/population_frequentUser_patients.yaml b/paths/population_frequentUser_patients.yaml index a4067b2..248befc 100644 --- a/paths/population_frequentUser_patients.yaml +++ b/paths/population_frequentUser_patients.yaml @@ -2,7 +2,8 @@ get: tags: - Frequent users 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: - name: periodStart in: query @@ -18,7 +19,7 @@ get: 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. + The restriction is applied to the GP responsible for the patient now, not on the GP responsible at the time of the feat. schema: type: array items: @@ -27,7 +28,7 @@ get: 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. + 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 schema: type: array diff --git a/paths/population_statistics.yaml b/paths/population_statistics.yaml index 872b4e4..088f457 100644 --- a/paths/population_statistics.yaml +++ b/paths/population_statistics.yaml @@ -2,7 +2,7 @@ get: tags: - Population statistics operationId: populationStatistics - summary: Get a population count + summary: Population group-by description: |- Groups the patient population by any combination of age, preferred doctor, etc. and calculates the count of each category. parameters: diff --git a/paths/population_statistics_deprived.yaml b/paths/population_statistics_deprived.yaml index 6ef80de..bef7d68 100644 --- a/paths/population_statistics_deprived.yaml +++ b/paths/population_statistics_deprived.yaml @@ -2,7 +2,7 @@ get: tags: - Population statistics 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. parameters: - $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday' diff --git a/paths/population_statistics_groupByItems.yaml b/paths/population_statistics_groupByItems.yaml index 3830709..6da3b85 100644 --- a/paths/population_statistics_groupByItems.yaml +++ b/paths/population_statistics_groupByItems.yaml @@ -2,11 +2,11 @@ get: tags: - Population statistics operationId: groupByItems - summary: Group-by items for population count + summary: Group-by items responses: 200: 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: application/json: schema: diff --git a/paths/qoc_careprogram.yaml b/paths/qoc_careprogram.yaml index a6f757a..ee04a01 100644 --- a/paths/qoc_careprogram.yaml +++ b/paths/qoc_careprogram.yaml @@ -2,9 +2,9 @@ get: operationId: carePrograms tags: - Quality of Care - summary: List all available care programs + summary: All care programs 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: - $ref: '../zoo-api.yaml#/components/parameters/Authorization' responses: diff --git a/paths/qoc_checkupList_set_status.yaml b/paths/qoc_checkupList_set_status.yaml index 9dd6059..91078e7 100644 --- a/paths/qoc_checkupList_set_status.yaml +++ b/paths/qoc_checkupList_set_status.yaml @@ -2,7 +2,8 @@ post: tags: - Quality of Care 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: - name: BSN in: header diff --git a/paths/qoc_checkupList_{setKey}.yaml b/paths/qoc_checkupList_{setKey}.yaml index d36f45f..218201f 100644 --- a/paths/qoc_checkupList_{setKey}.yaml +++ b/paths/qoc_checkupList_{setKey}.yaml @@ -2,9 +2,9 @@ get: operationId: checkUpListSet tags: - Quality of Care - summary: Load call-up status for patients in a care program + summary: Call-up status 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: - name: setKey in: path diff --git a/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml b/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml index 56cf300..e93e9f4 100644 --- a/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml +++ b/paths/qoc_indicator_{setKey}_{indicatorKey}_participants.yaml @@ -2,7 +2,8 @@ get: operationId: indicatorSetParticipants tags: - 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: - name: setKey in: path diff --git a/paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml b/paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml index 66cdddb..2405918 100644 --- a/paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml +++ b/paths/qoc_indicator_{setKey}_{indicatorKey}_patients.yaml @@ -2,7 +2,8 @@ get: operationId: indicatorSetPatients tags: - 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: - name: setKey in: path diff --git a/paths/qoc_indicatorset_{setKey}.yaml b/paths/qoc_indicatorset_{setKey}.yaml index a15f6a9..cdd718f 100644 --- a/paths/qoc_indicatorset_{setKey}.yaml +++ b/paths/qoc_indicatorset_{setKey}.yaml @@ -2,7 +2,8 @@ get: operationId: indicatorSet tags: - Quality of Care - summary: Load an indicator-based report + summary: Indicator report + description: Load an indicator-based report. parameters: - name: setKey in: path @@ -22,7 +23,7 @@ get: responses: '200': description: |- - all data required to render an indicatorset is returned. + All data required to render an indicator set is returned. Examples: * Example complete response diff --git a/paths/qoc_list-groups.yaml b/paths/qoc_list-groups.yaml index ff89c7a..498635d 100644 --- a/paths/qoc_list-groups.yaml +++ b/paths/qoc_list-groups.yaml @@ -2,7 +2,8 @@ get: operationId: indicatorReportGroups tags: - 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: - name: refDate in: query diff --git a/paths/qoc_participating-practices.yaml b/paths/qoc_participating-practices.yaml index 05c281d..69c7a92 100644 --- a/paths/qoc_participating-practices.yaml +++ b/paths/qoc_participating-practices.yaml @@ -2,7 +2,8 @@ get: operationId: participatingGroups tags: - 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: - name: setKey in: query diff --git a/zoo-api.yaml b/zoo-api.yaml index 975abd8..f87d603 100644 --- a/zoo-api.yaml +++ b/zoo-api.yaml @@ -90,16 +90,6 @@ components: Authorization: name: Authorization 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. - * `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 schema: type: string