v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Practitioner

Associate a practitioner with a specialty

Associates a practitioner with the specified specialty and returns the association details. Practitioner-level specialty is always attempted first; group, location, and network levels are best-effort. On success (200), the response includes all successfully created specialties per level and a 'notCreated' list for any level that could not be created (e.g. missing dependencies), so clients can fix and retry. 4xx is returned only when practitioner-level creation fails.

post/practitioners/{practitionerId}/specialties

Path parameters

practitionerIdstring required

ID of the practitioner to associate with the specialty

Headers

tenant-idstring required

The tenant identifier

Request body

tenantSpecialtyIdstring

ID of the specialty; required if practitionerRole is not provided

tenantGroupPractitionerIdstring

ID of the tenant group practitioner

tenantGroupPractitionerLocationIdstring

ID of the tenant group practitioner location

networkIdstring

ID of the tenant group network

groupSpecialtyEffectiveDatestring

Group specialty date

locationSpecialtyEffectiveDatestring

Location specialty date

networkSpecialtyEffectiveDatestring

Network specialty date

practitionerRolestring

Practitioner role; required if tenantSpecialtyId is not provided

practitionerRoleEffectiveDatestring

Practitioner role date

specialtyOrPractitionerRolePresentboolean
dataPresentWhenSpecialtyPresentboolean

Response

Practitioner specialty created. Response includes created specialties per level and, when applicable, 'notCreated' listing levels that could not be created (e.g. missing group/location/network associations) with reason and message.