v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Group

Terminate a group location

Terminates a group location from a group. This cascades termination to all related relationships including networks, practitioners, and specialties. User consent must be confirmed before proceeding.

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

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