You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52 lines
2.0 KiB
YAML
52 lines
2.0 KiB
YAML
get:
|
|
tags:
|
|
- Population statistics
|
|
operationId: "populationStatisticsDeprivedNeighborhood"
|
|
summary: "Patients in a 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:
|
|
- name: referenceDate
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: "string"
|
|
pattern: "\\d\\d\\d\\d-\\d\\d-\\d\\d"
|
|
format: "date"
|
|
description: ISO formatted date
|
|
example: 2015-12-15
|
|
- $ref: '../zoo-api.yaml#/components/parameters/Authorization'
|
|
responses:
|
|
200:
|
|
description: "The response body is a JSON-array with exactly three objects. Patients who are no longer registered are excluded from the response, so only patients with an active registration are included. Passer-by and NONI-patients are excluded."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
oneOf:
|
|
- type: object
|
|
properties:
|
|
deprivedNeighborhood:
|
|
type: number
|
|
example: 42
|
|
- type: object
|
|
properties:
|
|
regularNeighborhood:
|
|
type: number
|
|
example: 256
|
|
- type: object
|
|
description: "When an irregular postcode is used for a patient it can't be used for determining the neighborhood. These patients are added to unknown."
|
|
properties:
|
|
unknown:
|
|
type: number
|
|
example: 3
|
|
400:
|
|
description: "Common HTTP semantics, see the response body."
|
|
401:
|
|
$ref: '../zoo-api.yaml#/components/responses/JwtFailure'
|
|
403:
|
|
description: "Indicated practice is known but has not authorized ZOO to share this information with signer."
|
|
404:
|
|
$ref: '../zoo-api.yaml#/components/responses/PatNotFound'
|
|
|