Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility

Terminate a facility location (full or network-only)

Supports two modes controlled by which dates are provided in the request body: (1) Full termination — provide facilityTerminationDate to terminate the facility–location relationship and cascade to all network/plan participation records in one atomic batch. (2) Network-only termination — omit facilityTerminationDate and provide networkTerminationDate. Only network/plan participation records (TenantGroupLocationNetwork, TenantGroupLocationFacilityNetwork) are terminated; the facility–location record itself remains active. Optionally scope to a single network by providing networkId. At least one date field is required. Does not terminate TenantGroupFacilityNetwork (whole-facility network enrollment).

post/facilities/{certifyFacilityId}/locations/{certifyLocationId}/terminate

Path parameters

certifyFacilityIdstring required

Certify facility ID

certifyLocationIdstring required

Certify location ID

Headers

tenant-idstring

Request body

facilityTerminationDatestring

Effective termination date for the facility–location relationship (ISO-8601). When omitted, only network participation is terminated (network-only mode).

networkTerminationDatestring

Effective termination date for network and plan participation for this location (ISO-8601). Required when facilityTerminationDate is omitted.

terminationReasonstring

Reason for termination. Optional in all termination modes — both full-facility and network-only callers may omit this field.

terminationInformedDatestring

Date the termination notice was provided (ISO-8601)

commentsstring

Optional comments persisted on terminated records

consentConfirmedboolean required

User must acknowledge impact before termination

networkIdstring

When provided in network-only mode (facilityTerminationDate is null), scopes termination to this specific network ID only. When omitted in network-only mode, all networks for the location are terminated.

Example request

{
  "facilityTerminationDate": "2026-04-01",
  "networkTerminationDate": "2026-04-01",
  "terminationReason": "Contract Expired",
  "consentConfirmed": true
}

Response

Facility location terminated

certifyFacilityIdstring

Certify facility ID

certifyLocationIdstring

Certify location ID

facilityTerminationDatestring

Facility–location termination date applied

networkTerminationDatestring

Network/plan termination date applied

terminatedLocationFacilityNetworksinteger

Attempted TenantGroupLocationFacilityNetwork UPDATE operations (pre-batch; not verified per-op against DAL response)

terminatedLocationNetworksinteger

Attempted TenantGroupLocationNetwork UPDATE operations (pre-batch; not verified per-op against DAL response)

terminatedLocationNetworkPlansinteger

Attempted TenantGroupLocationNetworkPlan UPDATE operations (pre-batch; not verified per-op against DAL response)

terminatedLocationPractitionerNetworksinteger

Attempted TenantGroupLocationPractitionerNetwork UPDATE operations (pre-batch; not verified per-op against DAL response)

terminatedPractitionerNetworksinteger

Attempted TenantGroupPractitionerNetwork UPDATE operations (pre-batch; not verified per-op against DAL response)

terminatedGroupFacilityLocationsinteger

TenantGroupFacilityLocation rows in scope for this location (pre-batch count)

tenantFacilityLocationUpdatedboolean

Whether TenantFacilityLocation was updated