Introduction #
The Staff model represents a staff member in a Canvas instance.
To get a Staff object by it’s identifier, use the get method:
from canvas_sdk.v1.data.staff import Staff
staff = Staff.objects.get(id="4150cd20de8a470aa570a852859ac87e")
Staff objects are commonly used in related models, for example the Task model. To see all of a staff member’s assigned or created tasks, the following code can be used:
from canvas_sdk.v1.data.staff import Staff
staff = Staff.objects.get(id="4150cd20de8a470aa570a852859ac87e")
staff.assignee_tasks.all()
# <QuerySet [<Task: Task object (3)>]>
staff.creator_tasks.all()
# <QuerySet [<Task: Task object (7)>]>
To show a Staff member’s contact points (email, phone, etc.), the telecom attribute can be used. For example:
from canvas_sdk.v1.data.staff import Staff
staff = Staff.objects.get(id="4150cd20de8a470aa570a852859ac87e")
[(t.system, t.value,) for t in staff.telecom.all()]
# [('phone', '8005551416'), ('email', 'support@canvasmedical.com')]
To show a Staff full name, credentialed name, the topmost clinical role or top role abbreviation use the properties full_name, credentialed_name, top_clinical_role or top_role_abbreviation.
from canvas_sdk.v1.data.staff import Staff
staff = Staff.objects.get(id="4150cd20de8a470aa570a852859ac87e")
staff.full_name
# Larry Weed
staff.credentialed_name
# Larry Weed MD
staff.top_clinical_role.name
# Physician
staff.top_role_abbreviation
# MD
To get Staff licenses.
from canvas_sdk.v1.data.staff import Staff
staff = Staff.objects.get(id="4150cd20de8a470aa570a852859ac87e")
staff.licenses.all()
# <QuerySet [<StaffLicense: CA License for Larry Weed>]>
Attributes #
Staff #
| Field Name | Type |
|---|
| id | UUID |
| dbid | Integer |
| created | DateTime |
| modified | DateTime |
| prefix | String |
| suffix | String |
| first_name | String |
| middle_name | String |
| last_name | String |
| maiden_name | String |
| nickname | String |
| previous_names | JSON |
| birth_date | Date |
| sex_at_birth | PersonSex |
| sexual_orientation_term | String |
| sexual_orientation_code | String |
| gender_identity_term | String |
| gender_identity_code | String |
| preferred_pronouns | String |
| biological_race_codes | Array[String] |
| biological_race_terms | Array[String] |
| cultural_ethnicity_codes | Array[String] |
| cultural_ethnicity_terms | Array[String] |
| last_known_timezone | TimeZone |
| active | Boolean |
| primary_practice_location | PracticeLocation |
| npi_number | String |
| nadean_number | String |
| group_npi_number | String |
| bill_through_organization | Boolean |
| tax_id | String |
| tax_id_type | TaxIDType |
| spi_number | String |
| personal_meeting_room_link | URL |
| state | JSON |
| user | CanvasUser |
| supervising_team | Staff[] |
| notes | Note[] |
| creator_tasks | Task[] |
| assignee_tasks | Task[] |
| comments | TaskComment[] |
| care_team_memberships | CareTeamMembership[] |
| teams | Team[] |
| telecom | StaffContactPoint[] |
StaffContactPoint #
StaffAddress #
| Field Name | Type |
|---|
| id | UUID |
| dbid | Integer |
| line1 | String |
| line2 | String |
| city | String |
| district | String |
| state_code | String |
| postal_code | String |
| use | AddressUse |
| type | AddressType |
| longitude | Float |
| latitude | Float |
| start | Date |
| end | Date |
| country | String |
| state | String |
| staff | Staff |
StaffLicense #
| Field Name | Type |
|---|
| id | UUID |
| dbid | Integer |
| staff | Staff |
| issuing_authority_long_name | String |
| issuing_authority_url | URL |
| license_or_certification_identifier | String |
| issuance_date | Date |
| expiration_date | Date |
| license_type | LicenseType |
| primary | Boolean |
| state | String |
StaffPhoto #
| Field Name | Type |
|---|
| dbid | Integer |
| created | DateTime |
| modified | DateTime |
| staff | Staff |
| url | String |
| title | String |
StaffRole #
| Field Name | Type |
|---|
| dbid | Integer |
| staff | Staff |
| internal_code | String |
| public_abbreviation | String |
| domain | RoleDomain |
| name | String |
| domain_privilege_level | Integer |
| permissions | JSON |
| role_type | RoleType |
Enumeration types #
License Type #
| Value | Description |
|---|
| CLIA | CLIA |
| DEA | DEA |
| PTAN | PTAN |
| STATE_LICENSE | State License |
| TAXONOMY | Taxonomy |
| SPI | SPI |
| OTHER | Other |
Role Domain #
| Value | Abbreviation | Description |
|---|
| CLINICAL | CLI | Clinical |
| ADMINISTRATIVE | ADM | Administrative |
| HYBRID | HYB | Hybrid |
Role Type #
| Value | Description |
|---|
| NON_LICENSED | Non-Licensed |
| LICENSED | Licensed |
| PROVIDER | Provider |
Computed Properties #
photo_url: The URL of the staff member’s photo, if available, or a placeholder image URL.
Questions? Create an issue.