post:
  tags:
    - Quality of Care
  operationId: setPatientCallUpStatus
  summary: Call-up status
  description: Set call-up status for patients in a care program.
  parameters:
    - name: BSN
      in: header
      deprecated: true
      description: If the `bsns` key in de request body form is omitted, it can be replaced by this HTTP header. Supply a comma separated list of BSN's. The further processing is the same as the `bsns` key in the request body, including the limit on the size of the list.
      example: 612345671,123456782,123456789
      schema:
        type: array
        items: 
          $ref: '../schemas/pat-BSN.yaml'
  requestBody:
    description: |-
      The request is designed to set the status of several patients, specified by patId (mensId) or BSN, at once. The endpoint is idempotent for the combination of careprogram, callUpStatus and BSN or patId. That means that the call-up status for a patient in a certain care program is just set once, until a new status is set. As a consequence only the employee who set first a certain status is stored, until somebody else (or the same employee) overwrites the status.
    content: 
      'application/x-www-form-urlencoded':
        schema:
          type: object
          properties: 
            careprogram:
              description: |-
                The kind of chronic care that this care program caters to. Can be omitted in cases where this care program doesn't cover a generally accepted protocollized chronic care condition (Often, new research).
              $ref: '../schemas/CareProgram-enum.yaml'
            callUpStatus:
              $ref: '../schemas/callUpStatus-enum.yaml'
            employee:
              type: string
              description: The employee that is setting the call-up status. Any string is accepted, but it is recommended to use a employee code derived from this API.
            bsns:
              type: array
              items:
                $ref: '../schemas/pat-BSN.yaml'
                maxItems: 1000
              example: 612345671,123456782,123456789
              description: |-
                BSNs consisting only of zeros or only of nines or the empty BSN are ignored, i.e. BSNs matching regex `^0*|9*$` are ignored. BSNs are NOT checked to be valid ('elfproef'). BSNs may be zero-padded but don't have to be. One of `bsns` or `patIds` must be provided (but not both).
            patIds:
              type: array
              items:
                $ref: '../schemas/pat-patId.yaml'
                maxItems: 1000
              example: 10012,32122,1212
              description: |-
                patient GPIS ids. One of `bsns` or `patIds` must be provided (but not both).
          required:
            - careprogram
            - callUpStatus
            - employee
          minItems: 4
  responses:
    '200':
      description: |-
        BSNs or patIds whose status has actually updated. BSNs or patIds which were not known in the GPIS are ignored and not returned here.
        The caller should determine the difference between the two sets to get the ignored patients. If a BSN matched more than one patient, all these patients were updated.
      content: 
        'application/json':
          schema:
            type: object
            properties:
              bsns:
                type: array
                items:
                  type: integer
                example:
                  - 612345671
                  - 123456782
              patIds:
                type: array
                items:
                  type: integer
                example:
                  - 10012
                  - 32122
            minItems: 1
            maxItems: 1
    '401':
      $ref: '../zoo-api.yaml/#/components/responses/NoAuth'
    '403':
      $ref: '../zoo-api.yaml#/components/responses/NoAccess'