The PractitionerRole resource represents a user's association and details with a specific clinic location within a practice group
This resource allows for the management of clinic-specific details for practitioners and administrators who operate across multiple locations.
Each ID is distinguished with a prefix according to data type:
| Prefix | Data Type | Description |
|---|---|---|
| PR- | Practitioner | A practitioner or administrator within your practice group and the linked clinic location |
| EP- | External Practitioner | A professional contact and their practice location |
Note: The prefixes are only for referencing resources in the API and do not appear in Halaxy.
Halaxy ContextThe PractitionerRole ID is the identifying link between a practitioner or administrator profile to a specific clinic location in a practice group. For example, whenever a record on Halaxy requires both a practitioner and practice location (e.g. invoice, referral, clinical note), the PractitionerRole ID is used.
Endpoints
| Endpoint | Operation | Description |
|---|---|---|
GET /main/PractitionerRole/ | List Practitioner Roles | Return a list or collection of users from a specific clinic |
GET /main/PractitionerRole/{id} | Get Practitioner Role | Return an individual user from a specific clinic |
POST /main/PractitionerRole/ | Create Practitioner Role (Professional Contact) | Link a professional contact to an external practice |
Schema
Property | Description |
|---|---|
id |
|
practitioner |
See also: Practitioner |
organization |
See also: Organization |
telecom |
system value use Note: Phone format must follow |
practitioner-role-provider-number |
See article: Manage professional contacts |