get:
  operationId: patientFundusByPractice
  tags:
    - Patient
  summary: Funduscopy, practice
  description: |-
    Get per-patient funduscopy status for one GP practice.

    Returns patients that have an indication for requiring funduscopy, taking into account the medical dossier of each patient as well as the relevant care group's policies.
    
    For each patient, information about their funduscopy status as well as basic personal information is provided.
  parameters:
    - $ref: '../zoo-api.yaml#/components/parameters/AgbGP'
    - name: purpose
      in: query
      required: true
      description: |-
        A key describing the purpose of requesting funduscopy status of many patients.
        
        Affects what data is supplied (for example, whether personally identifying information is provided), and whether certain
        filters are applied.
        
        * `fundus-broker` – An entity that takes care of arranging appointments between patients and funduscopy professionals.
        * `gp` – Medical personnel reviewing their funduscopy-relevant patient population.
        * `reporting` – Reporting on the status of the funduscopy-relevant patient population as a whole.
        
        The `reporting` purpose limits PII, the `fundus-broker` purpose applies filtering as per the preferences of the care group's policies.
      schema:
        type: string
        enum: ['fundus-broker', 'gp', 'reporting']
    - name: director
      in: query
      required: false
      description: |-
        If present, filter the returned population on the registered director for funduscopy.
        
        * `gp` – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The GP'.
        * `specialist` – Returns only those patients whose most recent registration of responsible-for-funduscopy is 'The specialist'.
        * `unknown` – Returns only those patients whose most recent registration of responsible-for-funduscopy is not present, registered as 'Unknown', or has an invalid registration.
        
        If not present, no filtering is applied.
      schema:
        type: string
        enum: ['gp', 'specialist', 'unknown', '']
    - name: ifNewerThan
      in: query
      required: false
      description: |-
        Useful to check if new data is available relative to an earlier request: Provide the same date as provided in a previous response's `refDate` value.
        If no new data is available since then, a `206 - No Content` HTTP response is returned. Date without time part in ISO8601 format.
      schema:
        type: string
        format: date
        example: "1970-01-13"
    - $ref: '../zoo-api.yaml#/components/parameters/Pretty'
    - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
  responses:
    '206':
      description: |-
        No new data is available: The EPD has not provided new information since `ifNewerThan`, or Zorg op Orde has not had a chance to rerun the fundus calculations on newly provided EPD data.
    '503':
      description: The data cannot be provided, because EPD data has not been provided to Zorg op Orde, or ZOO has not had a chance to run the fundus calculations on this data.
      content:
        application/json:
          schema:
            type: object
            required:
              - practice
            properties:
              practice:
                type: object
                required:
                  - agb
                  - name
                  - gpis
                  - refDate
                properties:
                  agb:
                    description: |-
                      The AGB code of the GP practice whose patients are provided in this object.
                    $ref: ../schemas/agb.yaml
                  name:
                    description: |-
                      A human readable name describing the GP practice (The entity whose AGB code is sent as `agb`).
                    type: string
                  gpis:
                    $ref: ../schemas/GPIS.yaml
                  refDate:
                    $ref: "../schemas/fundus-status.yaml#/properties/refDate"
    '200':
      description: All patients where funduscopy status is relevant is returned.
      content:
        application/json:
          schema:
            type: object
            required:
              - practice
              - refDate
            properties:
              dict:
                $ref: '../schemas/TermsDictionary.yaml'
              practice:
                $ref: "../schemas/fundus-status.yaml"
    '400':
      description: The request is invalid; for example, it doesn't contain the required `agb` parameter.
    '401':
      $ref: '../zoo-api.yaml#/components/responses/JwtFailure'
    '403':
      description: Indicated group is known but has not authorized ZOO to share this information with signer.