latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Terminate a group location from specific networks

Terminates the association between a group location and one or more networks, ending the location's membership in those networks. Only the location–network associations are affected; this operation does not cascade to practitioner associations, specialty associations, or any other related records for this location. Use this endpoint for targeted network termination of a location while preserving its other relationships; to terminate the location from the group entirely, use PUT /groups/locations/{locationId}/terminate instead.

put/groups/locations/{locationId}/networks/terminate

Path parameters

locationIdstring required

Group Location ID (tenantGroupLocationId)

Headers

tenant-idstring

Request body

networkIdsstring[] required

List of network IDs to terminate the location from

terminationDatestring

Termination date (ISO-8601 format, e.g., 2024-01-15)

terminationInformedDatestring

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

terminationReasonstring

Termination reason

dataobject

Additional termination data

continuityOfCareboolean

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

Example request

{
  "terminationInformedDate": "2024-01-15"
}

Response

Successfully terminated group location from networks

tenantGroupLocationIdstring required

The tenant group location ID

terminatedCountinteger required

The number of networks terminated from

networkIdsstring[] required

List of network IDs that were terminated