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.

ℹ️
Context
The 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	`string` The practitioner's clinic ID - their identifier for a specific clinic location e.g. `PR-1650721` `EP-9903531`
practitioner	`Reference(Practitioner)` The practitioner's group ID - their identifier within the practice group `"reference": "/main/Practitioner/PR-1234567"` `"type": "Practitioner"` See also: Practitioner
organization	`Reference(Organization)` The clinic location identifier `"reference": "/main/Organization/SP-12345678"` `"type": "Organization"` See also: Organization
telecom	`array of objects` The practitioner's contact number/s or email address/es at the specified location system Type of contact detail `sms` \| `phone` \| `fax` \| `email` value The actual phone number or email address e.g. `+61412345678` `leeblake@email.com` use Purpose of the contact detail `home` \| `work` \| `mobile` Note: Phone format must follow `+{country code}{phone number without spaces}`
practitioner-role-provider-number	`HALAXY API EXTENSION` The practitioner's provider number at the clinic location (professional contacts only) `"url": "https://terminology.halaxy.com/StructureDefinition/practitioner-role-provider-number"` `"valueString": "123456W"` See article: Manage professional contacts