v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Practitioner

Associate practitioner with a network

Associates a practitioner with a network following the roster ingestion pattern. The network must belong to a group (groupId provided in request body). If the practitioner is not associated with the group, the group association will also happen simultaneously. Creates or updates a TenantGroupPractitionerNetwork relationship.

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 required

ID of the network to associate with

networkEffectiveDatestring

Effective date for the network association

groupEffectiveDatestring

Effective date for the TenantGroupPractitioner relationship

Example request

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

Response

Successfully associated practitioner with network

tenantGroupPractitionerIdstring

ID of the tenant group practitioner

tenantGroupPractitionerNetworkIdstring

ID of the tenant group practitioner network association

networkIdstring

ID of the network that was associated

statusstring

Indicates the result of the association

Example response

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