description: |-
  A report about a care program based on showing a number of ratios, such as: "How many people in your practice have diabetes?", or: "For all diabetes patients in your care with a recent blood pressure measurement, how do these blood pressure measurements split into problematic / concern / okay categories?"
type: object
required:
  - key
  - name
  - refDate
  - calculating
properties:
  gpis:
    $ref: 'GPIS.yaml'
  key:
    description: Unique identifier, not to be shown to the user, for referring to this indicator set in other API calls
    type: string
    example: ZOO-dm
  name:
    description: Human readable dutch text; should fit in one line.
    type: string
    example: Diabetes Mellitus type 2 – per InEen 2023 accreditatie
  careprogram:
    $ref: '../schemas/CareProgram-enum.yaml'
  refDate:
    description: Reference date for which the indicators are calculated on the population (peildatum).
    $ref: ./date.yaml
  calculating:
    description: |-
      Calculating an indicator set report takes some time; this API responds with a `calculating` value of less than 1.0 and
      no `chapters` section (thus, no data). Call this endpoint a few times to get status updates. Once calculation is complete,
      `1.0` will be returned and `chapters` will be provided.
    format: number
    minimum: 0.0
    maximum: 1.0
  bars:
    description: Describes the bars in the indicators used in the indicatorGroups.
    schema:
    type: array
    items:
      type: object
      properties:
        calculated:
          type: object
          properties:
            from:
              description: Timestamp of the oldest indicator calculation in the set.
              $ref: ../schemas/dateTime.yaml
            to:
              description: Timestamp of the newest indicator calculation in the set.
              $ref: ../schemas/dateTime.yaml
        population:
          type: object
          properties:
            entity:
              type: string
              enum:
                - gp
                - tag
            tag:
              description: The name of a care group or other population, but never a practice.
              type: string
            unid:
              description: For internal use by Zoo.
              type: integer
            snapshotId:
              description: For internal use by Zoo.
              type: integer
        refDate:
          description: |-
            Reference date for which the indicators are calculated on the population.
          $ref: '../schemas/dateTime.yaml'
        title:
          description: Title for use in the GUI as a legend for bar.
          type: string
  chapters:
    description: |-
        Each chapter has a title and contains 1 or more indicators.
    type: array
    items:
      type: object
      required:
        - title
        - indicatorGroups
      properties:
        title:
          description: In dutch, plain text formatted; should fit on one line.
          type: string
          example: Populatie
        htmlDescription:
          description: In dutch, HTML formatted; if present, contains details on how this value is measured (in more readable, less technical terms than `htmlDetail`.
          type: string
          example: Patiënten met ≥ 1 voorschrift(en) long acting beta-2 agonists (LABA) of long acting muscarine antagonists (LAMA) in de afgelopen 12 maanden
        htmlDetail:
          description: In dutch, HTML formatted; if present, contains specific details on how this value is measured (for example, contains information about which NHG bepaling codes are used).
          type: string
          example: LAMA (<code>R03BB</code> (04, 05, 06 of 07)) of LABA (<code>R03AC</code> (12, 13, 18 of 19))
        indicatorGroups:
          description: |-
            A chapter contains 1 or more indicator groups. An indicator group is an array of indicators which should
            always be shown together; they are each other's context. These arrays are never empty, but often contain
            just one indicator. It is extremely rare for such a set to contain more than 2.
          type: array
          items:
            type: array
            items:
              $ref: 'Indicator.yaml'
  cache:
    description: If true, the indicator set was retrieved from the API cache. The set is only retrieved from the cache if there is no recent calculation available in the database and if the set won't change anymore. This is the case for all indicator sets which were calculated with a reference date in the past and for which a certain period no new GPIS-data is provided. The cached indicator set reflects the indicator definitions of the reference date. Cached indicators are not updated with new definitions.
    type: boolean