diff --git a/paths/population_statistics_deprived_{neighborhood}.yaml b/paths/population_statistics_deprived_{neighborhood}.yaml index 4f1a332..a38ed0f 100644 --- a/paths/population_statistics_deprived_{neighborhood}.yaml +++ b/paths/population_statistics_deprived_{neighborhood}.yaml @@ -15,11 +15,14 @@ get: - regular - unknown example: deprived - description: The neighborhood is derived from the postcode. If the postcode is not valid, e.g. not in the regular language defined by `[0-9]{4}\s*[a-zA-Z][a-zA-Z]`, then the neighborhood is 'unknown', otherwise the neighborhood is 'deprived' or 'regular'. The difference between the latter is based on national tables. + description: |- + The neighborhood is derived from the postcode. + If the postcode is not valid, e.g. not in the regular language defined by `[0-9]{4}\s*[a-zA-Z][a-zA-Z]`, then the neighborhood is 'unknown', otherwise the neighborhood is 'deprived' or 'regular'. The difference between the latter is based on national tables. + NB: Asking for all patients in the `regular` group may result in access denied errors; these lists are generally large and not usually a worthwhile list to provide to medical professionals. - name: pii in: query example: true - description: If false, limits the response to only id's. + description: If false, limits the response to only patient ids. schema: type: boolean default: false