Globally terminate one or more facilities
POST/facilities/terminate
Terminates each facility without the caller naming a group, network or location: every active group, network and location relationship across all of the facility's locations ends and the facility's tenant-level record is terminated with the given date and reason (and, when supplied, terminationInformedDate: the date the termination notice was provided, stored beside the termination date on the same records and restored by a rollback). Practitioner relationships are never changed. Supply certifyLocationId to terminate only that location (the group affiliation ends too when it was the facility's last location in it, and the tenant-level record stays active). Relationships that already carry a termination (any termination date, past, today or future) are left exactly as they were and reported as skipped: a future-dated termination is a regular termination, and a wrong date is corrected by rolling the request back and terminating again. Open credentialing workflows are cancelled immediately, whatever the effective date; the response says how many. The cancellation is the Credentialing API's own operation and is simply called: if it passes the termination stands, if it fails (for example for a tabled workflow) the termination is reversed and the error carries the cancel failure's message (502 for a single facility, because a dependency failed; several facilities report it per facility as a failed item). Rolling a request back restores the records only; it does not reopen workflows. A single facility is processed synchronously and an already-terminated facility is rejected with 409; several facilities succeed or fail independently and the response reports each. Use the returned requestId with POST /facilities/terminations/{requestId}/rollback to undo exactly what this request changed. A webhook (facility.global_termination.completed) is sent once per terminated facility.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 500
- 502
Termination processed; per-facility results in items
Validation failed (missing reason naming the field, bad date, no consent, too many ids)
Unauthorized - Authentication required
Forbidden - Insufficient permissions
Facility not found, or the feature is not enabled
The single facility is already terminated and has no active relationship left to end, or a facility of the request already has a termination in progress (nothing was created; retry once the earlier request has finished)
Internal server error
A single facility's open credentialing workflow could not be cancelled (a dependency failed), so the termination was reversed; the detail carries the cancel failure's message