From 6e48e2cac44205e8b015c668667e110ff4ca73ba Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Tue, 21 May 2024 04:47:57 +0200 Subject: [PATCH] [review] expanded on description of the gp filters for frequent user api. --- paths/population_frequentUser_count.yaml | 8 ++++++-- paths/population_frequentUser_patient.yaml | 10 +++++++--- paths/population_frequentUser_patients.yaml | 8 ++++++-- 3 files changed, 19 insertions(+), 7 deletions(-) diff --git a/paths/population_frequentUser_count.yaml b/paths/population_frequentUser_count.yaml index 97dbfd1..6136597 100644 --- a/paths/population_frequentUser_count.yaml +++ b/paths/population_frequentUser_count.yaml @@ -16,7 +16,9 @@ get: $ref: ../schemas/date.yaml - name: doctorAgbCodes in: query - description: Any valid AGB-code. + 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 @@ -24,7 +26,9 @@ get: - name: doctorCodes type: integer in: query - description: Code of the doctor as known in the HIS. + 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: diff --git a/paths/population_frequentUser_patient.yaml b/paths/population_frequentUser_patient.yaml index 192f972..1b2d7c3 100644 --- a/paths/population_frequentUser_patient.yaml +++ b/paths/population_frequentUser_patient.yaml @@ -16,15 +16,19 @@ get: $ref: ../schemas/date.yaml - name: doctorAgbCodes in: query - description: Any valid AGB-code. + 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: Code of the doctor as known in the HIS. - example: 01015678,01018765,01014321 + 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: diff --git a/paths/population_frequentUser_patients.yaml b/paths/population_frequentUser_patients.yaml index fbf637b..1806363 100644 --- a/paths/population_frequentUser_patients.yaml +++ b/paths/population_frequentUser_patients.yaml @@ -16,14 +16,18 @@ get: $ref: ../schemas/date.yaml - name: doctorAgbCodes in: query - description: Any valid AGB-code. + 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. schema: type: array items: - name: doctorCodes type: integer in: query - description: Code of the doctor as known in the HIS. + 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. example: 01015678,01018765,01014321 schema: type: array