Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Terminate a group location

Terminates a group location from a group. The cascade terminates the location's practitioner associations (GroupPractitionerLocation), the location record itself (GroupLocation, TenantGroupLocation), and — by default — all of the location's still-active network associations (TenantGroupLocationNetwork), so networksAffected reflects the number of network associations terminated by this call. Set the group-location.terminate.cascade-network.enabled config flag to false to disable the network cascade (networksAffected will then always be 0, matching the legacy behavior). If the network cascade fails (lookup or termination), this call returns 500 even though the location itself has already been terminated and is not rolled back — retry the request to complete the cascade; already-terminated networks are skipped on retry. To terminate only specific network associations without terminating the location itself, call PUT /groups/locations/{locationId}/networks/terminate instead. The request body must include consentConfirmed set to true to confirm the termination; omitting it or supplying false returns 400.

put/groups/locations/{locationId}/terminate

Path parameters

locationIdstring required

Group Location ID (tenantGroupLocationId)

Headers

tenant-idstring

Request body

terminationDatestring required

Termination date (ISO-8601 format, e.g., 2024-01-15). Must be >= start/effective date. Future dates allowed.

terminationInformedDatestring

Date when termination was informed (ISO-8601 format, e.g., 2024-01-15)

terminationReasonstring

Termination reason code. Used for compliance and audit purposes.

consentConfirmedboolean required

User consent confirmation that they understand the impact of this termination on the group, networks, plans, and practitioners

networkIdsstring[]

When non-empty, terminates only these networks for the location (TenantGroupLocationNetwork). Does not terminate the whole location or other networks.

dataobject

Additional termination data

continuityOfCareboolean

Whether Continuity of Care applies for this termination. Defaults to false when omitted.

Example request

{
  "terminationDate": "2024-01-15",
  "terminationInformedDate": "2024-01-15",
  "terminationReason": "FACILITY_CLOSED"
}

Response

Successfully terminated group location

tenantGroupLocationIdstring required

The tenant group location ID

successboolean required

Whether termination was successful

terminationDatestring required

Termination date

terminationReasonstring required

Termination reason

practitionersAffectedinteger required

Number of practitioners affected by this termination

practitionersRequiringReviewstring[] required

List of practitioner IDs that are linked only via this group-location and may need review

networksAffectedinteger required

Number of networks affected

errorMessagestring

Error message if termination failed