Remove scheduled clinician from shift
POST/api/v2/public/scheduled-shifts/remove-clinician
Remove a Scheduled Clinician from a Shift
This operation removes a scheduled clinician from a shift under specific conditions and notifies relevant parties accordingly.
Shift Status Updates
- If the shift has at least 1 hour remaining, it is returned to the "Open" status.
- Otherwise, the shift is set to UnfulfilledRequested and will no longer be offered to clinicians.
Notifications
- The removed clinician is notified about their removal from the shift.
- If the removal reason is
Remove hire refused to work
:- The clinician's status will be updated to "frozen".
- If the shift has started or was in progress:
- The clinician will be removed from any other scheduled shifts if there were previous removals for No Call No Show (NCNS).
Returning the Shift to the Marketplace
- If the shift is reopened and sent back to the marketplace:
- Other clinicians who previously requested the shift will be notified so they can reapply.
- Clinician candidates eligible to fill the shift will receive an SOS notification.
Request
- application/json
Body
required
shiftId stringrequired
The unique identifier of the shift the clinician is assigned to.
clinicianId stringrequired
The unique identifier of the clinician (userId) to be unscheduled from the shift.
removalReason stringrequired
Possible values: [Remove hire emergency
, Remove hire refused to work
]
The reason for removing the clinician from the shift.
comments stringrequired
Comments explaining the removal (max length: 900).
Responses
- 201
- 400
- 401
- 403
Empty Response
Bad request
- application/json
- Schema
- Example (from schema)
- Request Validation
Schema
message string[]
Error description
error string
The type of error
statusCode integer
Status code of the error
{
"message": [
"Property must be a string"
],
"error": "Bad Request",
"statusCode": 400
}
Request Validation Error
{
"message": [
"removalReason must be one of the following values: Remove hire emergency, Remove hire refused to work",
"removalReason must be a string",
"comments must be shorter than or equal to 900 characters"
],
"error": "Bad Request",
"statusCode": 400
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
message string
Error description
statusCode integer
Status code of the error
{
"message": "Unauthorized",
"statusCode": 401
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
message string
Error description
error string
The type of error
statusCode integer
Status code of the error
{
"message": "Forbidden Resource",
"error": "Forbidden",
"statusCode": 403
}
Loading...