The Practitioner resource represents a practitioner or administrator identifier within a practice group
This resource enables the management of user profiles, providing the foundation for securely organizing practice-related information. On Halaxy, user profiles are located in Personal > Profile.
Each ID is distinguished with a prefix according to data type:
| Prefix | Data Type | Description |
|---|---|---|
| PR- | Practitioner | A practitioner or administrator within your Halaxy practice group |
| EP- | External Practitioner | An external practitioner in your Professional Contacts list |
Note: The prefixes are only for referencing resources in the API and do not appear in Halaxy.
Endpoints
| Endpoint | Operation | Description |
|---|---|---|
GET /main/Practitioner | List Practitioners | Return a list or collection of profile identifiers within a practice group |
GET /main/Practitioner/{id} | Get Practitioner | Return an individual profile within a practice group |
POST /main/Practitioner | Create Practitioner (Professional Contact) | Create a new professional contact profile (i.e. external practitioner) |
Schema
Property | Description |
|---|---|
id |
Example: |
identifier |
|
name |
use
The type of name given Given name (may include middle name) family Surname prefix Title before the patient's name - e.g. Mr, Mrs, Ms, Dr |
telecom |
system
Type of contact detail value
The actual phone number or email address use
Purpose of the contact detail |
active |
Changes to |
qualification |
|