get:
  tags:
    - Population statistics
  operationId: populationStatisticsDeprivedNeighborhoodPatients
  summary: Deprived neighborhood, patients
  description: The list of patients belonging to one of the categories, see `neighborhood` below.
  parameters:
    - $ref: '../zoo-api.yaml#/components/parameters/RefDateDefaultToday'
    - name: neighborhood
      in: path
      schema:
        type: string
        enum: 
          - deprived
          - 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.
    - name: pii
      in: query
      example: true
      description: If false, limits the response to only id's.
      schema:
        type: boolean
        default: false
  responses:
    200:
      description: Returns the list of all patients from of the supplied category.
      content: 
        application/json:
          schema: 
            type: array
            items: 
              type: object
              required:
                - category
                - doctor
                - patid
                - patUnid
                - feats
              properties:
                bsn:
                  $ref: '../schemas/PatIdentity.yaml#/bsn'
                name:
                  $ref: '../schemas/PatIdentity.yaml#/name'
                gender:
                  $ref: '../schemas/PatIdentity.yaml#/gender'
                dob:
                  $ref: '../schemas/PatIdentity.yaml#/dob'
                category:
                  $ref: '../schemas/PatIdentity.yaml#/category'
                doctor:
                  $ref: '../schemas/PatIdentity.yaml#/doctor'
                address:
                  $ref: '../schemas/PatIdentity.yaml#/address'
                contact:
                  $ref: '../schemas/PatIdentity.yaml#/contact'
                insurance:
                  $ref: '../schemas/PatIdentity.yaml#/insurance'
                patid:
                  $ref: '../schemas/PatIdentity.yaml#/patid'
                patUnid:
                  $ref: '../schemas/PatIdentity.yaml#/patUnid'
                startDate:
                  $ref: '../schemas/date.yaml'
    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'