latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Practitioner

Associate practitioner with one or more networks

Associates the practitioner with one or more networks within a group in a single atomic batch. If the practitioner is not yet associated with the specified group, the group association is also created as part of the same request. Use this when onboarding a practitioner to a set of networks within a group; for updating existing network association attributes in bulk, use PUT /practitioners/{id}/networks instead. {id} is the certifyPractitionerId, the request body must include a groupId, and the specified networks must belong to that group.

post/practitioners/{id}/networks

Path parameters

idstring required

ID of the practitioner (certify practitioner ID)

Headers

tenant-idstring

Request body

groupIdstring required

ID of the group that the network belongs to

networkIdstring

ID of the network (legacy single-network). Required when networks is empty or absent.

networkEffectiveDatestring

Effective date for the network association (legacy single-network). Ignored when networks is non-empty.

groupEffectiveDatestring

Effective date for the TenantGroupPractitioner relationship

networkInputValidboolean

Example request

{
  "groupId": "group-123",
  "networkId": "network-456",
  "groupEffectiveDate": "2024-01-15",
  "networks": [
    {
      "networkId": "network-456",
      "networkEffectiveDate": "2024-01-15"
    }
  ]
}

Response

Successfully associated practitioner with network. For single-network requests, the legacy top-level tenantGroupPractitionerNetworkId, networkId, and status fields are populated; for multi-network requests, the response instead carries a networkAssociations array, each entry with networkId, tenantGroupPractitionerNetworkId, and status.

tenantGroupPractitionerIdstring

ID of the tenant group practitioner

tenantGroupPractitionerNetworkIdstring

ID of the tenant group practitioner network association (single-network response only)

networkIdstring

ID of the network that was associated (single-network response only)

statusstring

Indicates the result of the association (single-network response only)

Example response

{
  "tenantGroupPractitionerId": "tgp-456",
  "tenantGroupPractitionerNetworkId": "tgpn-789",
  "networkId": "net-123",
  "status": "created",
  "networkAssociations": [
    {
      "networkId": "net-123",
      "tenantGroupPractitionerNetworkId": "tgpn-789",
      "status": "created"
    }
  ]
}