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:
    - name: policyType
      in: query
      schema:
        $ref: ../schemas/CallupPolicyType-enum.yaml 
    - name: patUnid
      in: query
      schema: 
        $ref: ../schemas/pat-patUnid.yaml
    - name: bsn
      in: query
      schema: 
        $ref: ../schemas/pat-BSN.yaml
    - name: indicatorKey
      in: query
      description: The version suffix of the indicator is ignored.
      schema: 
        type: string
        example: ZOO-dm2-hb-1
  responses:
    '200':
      description: A set of policies for the supplied patient or for the combination of a patient and an indicator. For the latter the set contains 0 or 1 policies.
      content:
        'application/json':
          schema:
            type: array
            items: 
              type: object
              properties:
                policyType: 
                  $ref: ../schemas/CallupPolicyType-enum.yaml
                patUnid:
                  $ref: ../schemas/pat-patUnid.yaml
                indicatorKey:
                  type: string
                  example: ZOO-dm2-hb
                userId:
                  type: integer
                doNotCallupUntil:
                  $ref: ../schemas/date.yaml
                frequency:
                  $ref: ../schemas/CallupPolicyFrequency.yaml
                reason:
                  type: string
                employee:
                  type: string
                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 for a combination of a patient and/ or an indicator. A call-up policy for filters the patient from the call-up list with a certain frequency or until a specific end date has passed. The calculation of the (call-up) indicator is not affected by this setting. It is solely meant as a tool for the general practitioner. A patient is specified using a `patUnid` or a bsn. Both are checked in the GPIS import database for existance.
  requestBody: 
    content: 
      'application/json':
        schema: 
          type: object
          properties:
            policyType:
              $ref: ../schemas/CallupPolicyType-enum.yaml
            patUnid:
              $ref: ../schemas/pat-patUnid.yaml
            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. That means that any suffix in the form: dash followed by a integer is ignored. The policy is therefore set for a indicator, and not for a specific version of the indicator. E.g. for ZOO-dm2-hb and not for ZOO-dm2-hb<em>-3</em>.
              example: ZOO-dm2-hb-3
              type: string
            userId:
              type: integer
            doNotCallupUntil:
              description: |-
                                The first date the patient will be taken (again) in account in a call-up list. This date is always compared to a reference date, which is not necessary today.
              $ref: ../schemas/date.yaml
            frequency:
              $ref: ../schemas/CallupPolicyFrequency.yaml
            reason:
              description: The reason for which the patient is temporary excluded from the call-up plan.
              type: string
            employee:
              $ref: ../schemas/employee-string.yaml
          required:
            - policyType
            - indicatorKey
            - employee
          oneOf:
            - required:
              - patUnid
              not:
                required:
                - bsn
            - required: 
              - bsn
              not: 
                required: 
                - patUnid
  responses:
    '200':
      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 for a combination of a patient and an indicator. This withdraws all previous set policies.
  parameters: 
    - name: policyType
      in: query
      schema:
        $ref: ../schemas/CallupPolicyType-enum.yaml
    - name: patUnid
      in: query
      schema:
        $ref: ../schemas/pat-patUnid.yaml
    - 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).
      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