get:
  tags:
    - Population statistics
  operationId: populationStatisticsDeprivedNeighborhood
  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'
    - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
  responses:
    200:
      description: |-
        Returns the counts of all patients divided into 3 categories:
        * Known to live in a deprived neighborhood
        * known to live in a regular neighborhood
        * Status of neighborhood unknown (for example, because living address of patient is not known or deprived status of that location is not known).
        
      content:
        application/json:
          schema:
            type: object
            required:
              - deprived
              - regular
              - unknown
            properties:
              deprived:
                description: Number of patients living in a deprived neighborhood
                type: integer
                format: int32
                minimum: 0
                example: 42
              regular:
                description: Number of patients living in a regular neighborhood
                type: integer
                format: int32
                minimum: 0
                example: 256
              unknown:
                description: Number of patients either living in an unknown location or a known location with unknown depraved status
                type: integer
                format: int32
                minimum: 0
                example: 0
    400:
      $ref: '../zoo-api.yaml#/components/responses/ReqFailure'
    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'