You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
71 lines
3.0 KiB
YAML
71 lines
3.0 KiB
YAML
post:
|
|
tags:
|
|
- Quality of Care
|
|
operationId: setPatientCallUpStatus
|
|
summary: Set call-up status for patients in a care program.
|
|
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:
|
|
$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 HIS 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' |