get:
  tags:
    - Frequent users
  operationId: populationFrequentUserPatients
  summary: "Lists the top 20 frequent users (patients)"
  parameters:
    - name: periodStart
      in: query
      description: Start of the period (including) to analyze.
      schema: 
        $ref: ../schemas/date.yaml
    - name: periodEnd
      in: query
      description: End of the period (excluding) to analyze. 
      schema: 
        $ref: ../schemas/date.yaml
    - name: doctorAgbCodes
      in: query
      description: Any valid AGB-code.
      schema:
        type: array
        items:
          type: number
    - name: doctorCodes
      in: query
      description: Code of the doctor as known in the HIS.
      example: 01015678,01018765,01014321
      schema: 
        type: array
        items: 
          $ref: ../schemas/med_dossier/Practitioner.yaml
    - name: featCodes
      in: query
      description: "The feats which are identified as time consuming or otherwise taking effort of the practice, defaults to: 12011,12411,12001,12401,12010,12410."
      schema: 
        $ref: ../schemas/med_dossier/FeatCode.yaml
    - name: patients
      in: query
      schema:
        $ref: ../schemas/pat-patId.yaml
    - name: ppi
      in: query
      description: "Allow patient personal identifying information in the response. Defaults to false if omitted."
      example: true
      schema: 
        type: boolean
    - name: limit
      in: query
      description: "Some integer between 1 and 50. Limits the output to the top 1 to 50 of the frequent users (patients). Defaults to 20 if omitted or not in the specified range."
      schema: 
        type: number
  responses: 
    200: 
      description: "Responses an array with patients. Only the top 20 users is exported. The output is ranked with the most frequent user at position 0 of the array."
      content: 
        application/json:
          schema: 
            type: array
            items: 
              type: object
              properties: 
                patId:
                  type: string
                  example: 1349
                lastName:
                  type: string
                  example: van Loon - van de Ven
                  description: Omitted if parameter ppi is omitted or false.
                gender:
                  type: string
                  example: V
                  description: Omitted if parameter ppi is omitted or false.
                birthdate:
                  type: string
                  example: 1929-08-21
                  description: Omitted if parameter ppi is omitted or false.
                feats:
                  type: object
                  properties:
                    featCode0:
                      type: object
                      description: The string featCode0 is replaced by an actual code, e.g. 12001.
                      properties: 
                        description:
                          type: string
                          example: consult huisarts langer dan 20 minuten
                          description: The feat description is taken from the HIS import.
                        n:
                          type: number
                          description: The count of the feats with the given code for the patient.
                          example: 59
                    featCodeN:
                      type: object
                      properties: 
                        description:
                          type: string
                          example: Consult regulier korter dan 5 minuten
                        n:
                          type: number
                          example: 54
    401:
      $ref: '../zoo-api.yaml#/components/responses/JwtFailure'
    403:
      $ref: '../zoo-api.yaml#/components/responses/NotToBeShare'
    404:
      $ref: '../zoo-api.yaml#/components/responses/PatNotFound'