Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Group

Terminate group specialties from network participation

Terminates one or more specialties from a group for network participation. Applies effective-dated termination at group–network association; optionally at group-location and group-level. Previous state is preserved for audit.

post/groups/{id}/specialties/terminate

Path parameters

idstring required

Group ID

Headers

tenant-idstring

Request body

specialtyIdsstring[] required

Required. List of Specialty IDs (standard/certify specialty identifiers) to terminate for this group. Each must be a specialty currently associated with the group. Obtain from: GET /specialties, or GET /groups/{id}/relationships/all (specialties with specialtyId).

networkIdsstring[]

Optional. Network IDs (standard/certify network identifiers) to restrict termination to. If null or empty, terminates from all networks the group participates in. Obtain from: GET /networks or GET /groups/{id}/relationships/all (networks).

terminationInformedDatestring

Termination informed date (ISO-8601 YYYY-MM-DD).

terminationEffectiveDatestring required

Termination effective date (ISO-8601 YYYY-MM-DD). When the specialty termination takes effect.

terminationReasonstring

Termination reason (e.g. code or free text).

acknowledgementConfirmedboolean required

User acknowledgement that terminating specialty from the group will terminate it from its locations, participating networks and plans.

terminateAtGroupLocationSpecialtiesboolean

If true, also terminate the specialty at group-location level (TenantGroupLocationSpecialty).

terminateAtGroupLevelboolean

If true, also terminate the specialty at group level (TenantGroupSpecialty).

Example request

{
  "specialtyIds": [
    "207Q00000X",
    "208D00000X"
  ],
  "networkIds": [
    "net_001",
    "net_002"
  ],
  "terminationInformedDate": "2024-01-15",
  "terminationEffectiveDate": "2024-02-01",
  "terminationReason": "SPECIALTY_DISCONTINUED"
}

Response

Group specialties successfully terminated

groupIdstring

Group ID (standard/certify group identifier)

groupSpecialtiesTerminatedinteger

Number of group-level specialties terminated

groupNetworkSpecialtiesTerminatedinteger

Number of group-network specialties terminated

groupLocationSpecialtiesTerminatedinteger

Number of group-location specialties terminated

terminationEffectiveDatestring

Termination effective date applied

terminatedSpecialtyIdsstring[]

Specialty IDs (standard) that were terminated

Example response

{
  "groupId": "grp_123",
  "terminationEffectiveDate": "2024-02-01",
  "terminatedSpecialtyIds": [
    "207Q00000X",
    "208D00000X"
  ]
}