PractitionerRole (CA-Core)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at package/structuredefinition-profile-practitionerrole-ca-core.json
This profile imposes the CA Baseline (v1.1.5) PractitionerRole Profile.
Profile
PractitionerRole | I | PractitionerRole | There are no (further) constraints on this element Element IdPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdPractitionerRole.identifier Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
|
active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.active Whether this practitioner role record is in active use DefinitionWhether this practitioner role record is in active use. Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. This resource is generally assumed to be active if no value is provided for the active element
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.period The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
practitioner | Σ I | 0..1 | Reference(package/structuredefinition-profile-practitioner-ca-core.json | Practitioner) | Element IdPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization DefinitionPractitioner that is able to provide the defined services for the organization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(package/structuredefinition-profile-practitioner-ca-core.json | Practitioner) Constraints
|
organization | Σ I | 0..1 | Reference(package/structuredefinition-profile-organization-ca-core.json | Organization) | Element IdPractitionerRole.organization Organization where the roles are available DefinitionThe organization where the Practitioner performs the roles associated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(package/structuredefinition-profile-organization-ca-core.json | Organization) Constraints
|
code | Σ | 0..* | CodeableConcept | Element IdPractitionerRole.code Roles which this practitioner may perform DefinitionRoles which this practitioner is authorized to perform for the organization. Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization. PractitionerRole (example)Constraints
|
specialty | Σ | 0..* | CodeableConceptBinding | Element IdPractitionerRole.specialty Specific specialty of the practitioner DefinitionSpecific specialty of the practitioner. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred)Constraints
|
location | Σ I | 0..* | Reference(Location) | There are no (further) constraints on this element Element IdPractitionerRole.location The location(s) at which this practitioner provides care DefinitionThe location(s) at which this practitioner provides care. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
healthcareService | I | 0..* | Reference(HealthcareService) | There are no (further) constraints on this element Element IdPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
telecom | Σ I | 0..* | ContactPoint | Element IdPractitionerRole.telecom Contact details that are specific to the role/location/service DefinitionContact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. This element is included to elicit feedback on whether it is more reasonable to apply expectations to Practitioner.telecom or PractitionerRole.telecom for the purposes of exchanging the meaningful phone number and email information for the provider Unordered, Open, by system(Value) Constraints
|
PhoneNumber | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPractitionerRole.telecom:PhoneNumber Contact details that are specific to the role/location/service DefinitionContact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
|
system | Σ I | 0..1 | codeBindingFixed Value | Element IdPractitionerRole.telecom:PhoneNumber.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
phone
|
value | Σ | 0..1 | string | Element IdPractitionerRole.telecom:PhoneNumber.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom:PhoneNumber.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitionerRole.telecom:PhoneNumber.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.telecom:PhoneNumber.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdPractitionerRole.telecom:Email Contact details that are specific to the role/location/service DefinitionContact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
| |
system | Σ I | 0..1 | codeBindingFixed Value | Element IdPractitionerRole.telecom:Email.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point. ContactPointSystem (required)Constraints
|
value | Σ | 0..1 | string | Element IdPractitionerRole.telecom:Email.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.telecom:Email.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point. ContactPointUse (required)Constraints
|
rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdPractitionerRole.telecom:Email.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.telecom:Email.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.availableTime Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources.
| |
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week. DaysOfWeek (required)Constraints
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element IdPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason.
| |
description | 1..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element IdPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element IdPractitionerRole.availabilityExceptions Description of availability exceptions DefinitionA description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
endpoint | I | 0..* | Reference(Endpoint) | There are no (further) constraints on this element Element IdPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
Obligations
Obligations are a new (and evolving) mechanism in FHIR to provide a consistent and machine processable way for profiles to define their expectations for system behaviors.
This profile utilizes the Obligation Extension to convey these expectations.
Note: Simplifier is working on rendering of Obligations. In the meantime the Obligations applied on the profile (see JSON & XML structure) have been rendered as a table below for easier viewing.
Obligation Code | Actor | Elements |
---|---|---|
can-send | Server Actor (CA Core) | practitioner, code, specialty, telecom, telecom:Phone, telecom:Email |
no-error | Client Actor (CA Core) | practitioner, code, specialty, telecom, telecom:Phone, telecom:Email |
Terminology
This version of the guide is based on the early content development of the pan-Canadian Health Data Content Framework (pCHDCF). The pCHDCF is still collaboratively defining recommended terminology and as such there are no terminology constraints are introduced into this version of the profile.
Mappings to pCHDCF
Draft Data Content Standard Element (As of 2023-11-09) | Draft Data Content Standard Element Definition (As of 2023-11-09) | FHIR Profile Element | Additional Notes |
---|---|---|---|
Provider National Unique Identifier | A registration number, or suitable alternative, that uniquely identifies a provider who may register in more than one province or territory. | Practitioner.identifier:nupi | |
Provider Type | A code used to categorize the type of person providing care, including registered service provider (e.g., physician, registered nurses) and non-registered providers (e.g., family caregiver, peer support worker, volunteer). | PractitionerRole.code | This mapping may change as more is known about the use and terminology chosen for this pCHDCF attribute |
Provider Expertise | Represents the expertise of the provider. | PractitionerRole.specialty | This mapping may change as more is known about the use and terminology chosen for this pCHDCF attribute |
Provider Role | Represents the role of the provider in relation to their participation in a specific health care event. | N/A | Likely to be conveyed under performer.function within care delivery resources (e.g., Procedure.performer.function) |
Provider Phone Number | The phone number of the provider. | PractitionerRole.telecom:PhoneNumber.value | PracitionerRole.telecom.system may be used to convey that the contact method is for telephone or an email which is indicated in the pCHDCF artefacts |
Provider Email | The email address of the care provider. | PractitionerRole.telecom:Email.value | PracitionerRole.telecom.system may be used to convey that the contact method is for telephone or an email which is indicated in the pCHDCF artefacts |