zoo-api/paths/qoc_checkupPolicy.yaml

get:
  tags:
    - Quality of Care
  operationId: getCallupPolicy
  summary: Call-up policy
  description: Gets all call-up policies of a patient for all indicators in which the patient participates, or for a specific indicator. Parameters are optional and simply filter the response; in other words, without parameters all policies are returned.
  parameters:
    - name: policyType
      in: query
      schema:
        $ref: ../schemas/CallupPolicyType-enum-short.yaml
    - name: patUnid
      in: query
      schema:
        $ref: ../schemas/pat-patUnid.yaml
        description: Show only policies for patients that match this unid. Not allowed if asking for `UserIndicator`.
    - name: bsn
      in: query
      schema: 
        $ref: ../schemas/pat-BSN.yaml
        description: Show only policies for patients that match this bsn. Not allowed if asking for `UserIndicator`.
    - name: indicatorKey
      in: query
      description: The version suffix of the indicator is ignored. Only for type `UserIndicator` and `PatientIndicator`.
      schema:
        type: string
        example: ZOO-dm2-hb-1
    - name: refDate
      in: query
      description: Return only policies that haven't expired at this date. Defaults to 'next quarter').
      schema:
        type: string
        $ref: ../schemas/date.yaml
  responses:
    '200':
      description: All policies that match the supplied filter conditions.
      content:
        'application/json':
          schema:
            type: array
            items: 
              type: object
              properties:
                policyType: 
                  $ref: ../schemas/CallupPolicyType-enum-short.yaml
                patUnid:
                  $ref: ../schemas/pat-patUnid.yaml
                indicatorKey:
                  type: string
                  example: ZOO-dm2-hb
                userId:
                  type: integer
                  example: 123456
                expires:
                  $ref: ../schemas/date.yaml
                  example: "2026-04-01"
                frequency:
                  $ref: ../schemas/CallupPolicyFrequency.yaml
                  example: never
                reason:
                  type: string
                  example: Zit op een boorplatform.
                employee:
                  $ref: ../schemas/employee-string.yaml
                timestamp:
                  $ref: ../schemas/dateTime.yaml
    '401':
      $ref: '../zoo-api.yaml#/components/responses/NoAuth'
    '403':
      $ref: '../zoo-api.yaml#/components/responses/NoAccess'
post: 
  tags:
    - Quality of Care
  operationId: postCallupPolicy
  summary: Call-up policy
  description: |-
        Set a call-up policy. Policies last until a specific expiry (or forever). See the descriptions of policy types to get an idea of what policies do and what they represent.
  requestBody:
    content: 
      'application/json':
        schema: 
          type: object
          properties:
            policyType:
              $ref: ../schemas/CallupPolicyType-enum-full.yaml
            patUnid:
              $ref: ../schemas/pat-patUnid.yaml
              example: 123456
            bsn:
              $ref: ../schemas/pat-BSN.yaml
            indicatorKey:
              description: |-
                                The key of the indicator as listed in the indicator set. The version of the indicator is ignored (if the string ends in a dash and a number, those are stripped). Only relevant for `IndicatorUser` and `UserIndicator`.
              example: ZOO-dm2-hb-3
              type: string
            reason:
              type: string
              description: An optional human written reason for why the policy is being applied.
              example: Zit op een boorplatform.
            expires:
              description: |-
                                If provided, this policy does not apply on and after this date. Mandatory for certain types of policy.
              $ref: ../schemas/date.yaml
            frequency:
              $ref: ../schemas/CallupPolicyFrequency.yaml
            employee:
              $ref: ../schemas/employee-string.yaml
          required:
            - policyType
            - employee
  responses:
    '204':
      description: If the policy has been processed without any errors.
    '401':
      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
    '403':
      $ref: '../zoo-api.yaml#/components/responses/NoAccess'
delete:
  tags:
    - Quality of Care
  operationId: deleteCallupPolicy
  summary: Call-up policy
  description: Unset a call-up policy.
  parameters:
    - name: policyType
      in: query
      schema:
        $ref: ../schemas/CallupPolicyType-enum-short.yaml
    - name: patUnid
      in: query
      schema:
        $ref: ../schemas/pat-patUnid.yaml
        example: 123456
    - name: bsn
      in: query
      schema:
        $ref: ../schemas/pat-BSN.yaml
    - name: indicatorKey
      in: query
      description: The version suffix of the indicator is ignored (if any). Only relevant for `IndicatorUser` and `UserIndicator`.
      schema:
        type: string
        example: ZOO-dm2-hb-1
    - name: reason
      in: query
      description: Some random string describing the reason. May be omitted.
      schema:
        type: string
    - name: employee
      description: Employee who withdraws the policy for the patient and indicator combination.
      in: query
      schema:
        $ref: ../schemas/employee-string.yaml