[review] slight rewording

EH/population-statistics-authorisation
Reinier Zwitserloot 2 years ago
parent fbd06353d2
commit abe1d31fe4
No known key found for this signature in database
GPG Key ID: DADEDCAA42950296

@ -5,7 +5,7 @@ post:
summary: Set call-up status for patients in a care program. summary: Set call-up status for patients in a care program.
requestBody: requestBody:
description: |- description: |-
The request is designed to set the status of several patients, specified by patId (mensId) or BSN, at once. The end point is idem potent 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. 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: content:
'application/x-www-form-urlencoded': 'application/x-www-form-urlencoded':
schema: schema:
@ -17,21 +17,23 @@ post:
$ref: '../schemas/callUpStatus-enum.yaml' $ref: '../schemas/callUpStatus-enum.yaml'
employee: employee:
type: string type: string
description: Any string is accepted, but it is recommended to use a employee code derived from this API. 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: bsns:
type: array type: array
items: items:
$ref: '../schemas/pat-BSN.yaml' $ref: '../schemas/pat-BSN.yaml'
maxItems: 1000 maxItems: 1000
example: 612345671,123456782,123456789 example: 612345671,123456782,123456789
description: BSN's consisting only of zero's or only of nines or the empty BSN are ignored, i.c. BSN's matching regex `^0*|9*$` are ignored. BSN's are NOT checked to be valid (elfproef). BSN which are not exactly 9 numbers long are supplemented by leading zeros until they are exactly nine symbols long. The same is done on the BSN imported from the GIS's. A list of BSN's or a list of patId's must be provided and not both at the same time, but one of them must be present. 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: patIds:
type: array type: array
items: items:
$ref: '../schemas/pat-patId.yaml' $ref: '../schemas/pat-patId.yaml'
maxItems: 1000 maxItems: 1000
example: 10012,32122,1212 example: 10012,32122,1212
description: A list of BSN's or a list of patId's must be provided and not both at the same time, but one of them must be present. description: |-
patient GPIS ids. One of `bsns` or `patIds` must be provided (but not both).
required: required:
- careprogram - careprogram
- callUpStatus - callUpStatus
@ -40,7 +42,8 @@ post:
responses: responses:
'200': '200':
description: |- description: |-
BSN's or patId's which are actually updated. BSN's or patId's which were not known in the HIS are ignored. 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. 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: content:
'application/json': 'application/json':
schema: schema:

Loading…
Cancel
Save