get:
  tags:
    - Quality of Care
  summary: Load call-up status for patients in a care program
  description: |-
    Returns each patient in a care program along with the progress on required or suggested measurements indicated for this care program.
  parameters:
    - name: setKey
      in: path
      description: The key as listed in the `CareProgram` schema.
      required: true
      schema:
        type: string
      example: ZEL-dm
    - name: refDate
      in: query
      description: |-
        The date in `2023-04-01` format; defaults to the first day in the next quarter, e.g. on april 5th 2023, defaults to `2023-07-01`.
      required: false
      schema:
        type: string
        format: date
        example: 2023-04-01
    - name: addr
      in: query
      required: false
      description: Request inclusion of address information
      schema:
        type: boolean
    - name: bsn
      in: query
      required: false
      description: Request inclusion of BSN information (dutch social security number)
      schema:
        type: boolean
    - name: email
      in: query
      required: false
      description: Request inclusion of email addresses
      schema:
        type: boolean
    - $ref: '../zoo-api.yaml#/components/parameters/Authorization'
  responses:
    '200':
      description: |-
        list of patients
      content:
        application/json:
          schema:
            type: object
            properties:
              gpis:
                $ref: '../schemas/IndicatorSet.yaml#/properties/gpis'
              key:
                $ref: '../schemas/IndicatorSet.yaml#/properties/key'
              name:
                $ref: '../schemas/IndicatorSet.yaml#/properties/name'
              refDate:
                $ref: '../schemas/IndicatorSet.yaml#/properties/refDate'
              calculating:
                $ref: '../schemas/IndicatorSet.yaml#/properties/calculating'
              doctors:
                description: |-
                  Lists all relevant doctors. A doctor is relevant if they are responsible
                  for at least 1 patient in the list.
                type: array
                items:
                  type: object
                  properties:
                    name:
                      description: |-
                        The name (or possibly memocode; something an employee of the practice will recognize) of the general practitioner.
                      type: string
                    agb:
                      description: If known, the AGB code of this general practitioner.
                      type: integer
                      format: int32
                      minimum: 1
                      maximum: 99999999
                  required:
                    - name
              indicators:
                type: array
                description: |-
                  One entry for each kind of measurement that (may) require call-up.
                items:
                  type: object
                  properties:
                    title:
                      description: |-
                        The title of this indicator
                      type: string
                      example: Bloeddruk
                    optional:
                      description: |-
                        If present, this indicator is optional, and the value contains dutch human readable text explaining why.
                      type: string
                      example: Volgens HKN protocol is BMI meten optioneel bij Astma patiënten; echter stelt het protocol wel een relatie tussen overgewicht en de mate van klachten.
                  required:
                    - title
              patients:
                type: array
                items:
                  type: object
                  properties:
                    patid:
                      $ref: '../schemas/PatIdentity.yaml#/patid'
                    doctor:
                      type: integer
                      format: int32
                      description: |-
                        An index (0-based) into the `doctors` entry: This is the GP responsible for this patient.
                    status:
                      type: string
                      example: open
                      enum:
                        - open
                      description: |-
                        A key indicating the appointment status for this patient:
                          
                        * `open` – An appointment still needs to be made.
                        
                        (Work in progress)
                    address1:
                      type: string
                      description: |-
                        The first line of this patient's postal address (Street name and number, generally).
                    city:
                      type: string
                      description: Patient lives in this city or township.
                    postcode:
                      type: string
                      description: Postcode of the patient.
                    bsn:
                      type: integer
                      minimum: 1
                      maximum: 999999999
                      format: int32
                      description: The BSN (dutch social security number) of the patient.
                    dob:
                      type: string
                      format: date
                      description: Date of birth of the patient.
                    email:
                      type: string
                      format: email
                      description: Email address of the patient.
                    state:
                      type: string
                      description: |-
                        A string containing 1 character for each indicator as listed in `indicators`.
                        
                        This character represents the patient's call-up state for that indicator:
                          
                        * `-` – This indicator is not relevant for this patient; no call-up needed.
                        * `R` – This is an optional indicator, but, the patient doesn't have this measurement.
                        * `0` – This is a required indicator and the patient doesn't have it.
                        * `1` – The patient has this measurement; but unless it is measured again, next quarter it'll be too long ago and no longer counts.
                        * `2`-`8` – `2` is like `1`, except the measurement lasts for 2 quarters up to 8 quarters.
                        * `+` – The measurement lasts for 9 or more quarters (for example, the measurement only needs to be done once ever and it has been done).
                        * `x` – unknown situation (should not occur).
                  required:
                    - patid
                    - doctor
                    - status
                    - dob
                    - state
            required:
              - gpis
              - key
              - name
              - refDate
              - calculating
    '401':
      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
    '403':
      $ref: '../zoo-api.yaml#/components/responses/NoAccess'
    '404':
      description: The provided `setKey` doesn't refer to a valid program.