Pan-Canadian Care Service Directory CI Build

DFT Ballot - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. . . For a full list of available versions, see the Directory of published versions

PractitionerRole

Description

A PractitionerRole is used to show what Healthcare Service, a Practitioner provides at a particular Location for an Organization.

References to this resource

Resource Content

PractitionerRole			There are no (further) constraints on this element Data type
active	S		There are no (further) constraints on this element Element id PractitionerRole.active Comments Identified as a query requirement through mCSD CapabilityStatement.
practitioner	S	Reference(Practitioner)	There are no (further) constraints on this element Element id PractitionerRole.practitioner Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Practitioner)
organization	S	Reference(Organization)	There are no (further) constraints on this element Element id PractitionerRole.organization Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Organization)
code	S	Binding	There are no (further) constraints on this element Element id PractitionerRole.code Comments Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Binding A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic. HealthcareProviderRoleType (preferred)
specialty	S	Binding	There are no (further) constraints on this element Element id PractitionerRole.specialty Comments Identified as a query requirement through mCSD CapabilityStatement. Binding Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. PractitionerSpecialty (preferred)
location	S	Reference(Location)	There are no (further) constraints on this element Element id PractitionerRole.location Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Location)
healthcareService	S	Reference(HealthcareService)	There are no (further) constraints on this element Element id PractitionerRole.healthcareService Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(HealthcareService)
telecom	S		There are no (further) constraints on this element Element id PractitionerRole.telecom Comments Identified as a requirement to support the ability to distinguish practitioner contact information that is distinct by location (or service). This is a mustSupport element in the CA:eReC profile.
system	S		There are no (further) constraints on this element Element id PractitionerRole.telecom.system

PractitionerRole	I			There are no (further) constraints on this element Element id PractitionerRole Short description Roles/organizations the practitioner is associated with Definition A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. Data type Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: ServiceSiteProvider
id	Σ	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id PractitionerRole.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..0	uri	There are no (further) constraints on this element Element id PractitionerRole.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id PractitionerRole.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id PractitionerRole.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..0	Extension	There are no (further) constraints on this element Element id PractitionerRole.modifierExtension Short description Extension Definition An Extension Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id PractitionerRole.identifier Short description Business Identifiers that are specific to a role/location Definition Business Identifiers that are specific to a role/location. Requirements Often, specific identities are assigned for the agent. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: .id servd: ./Identifiers
active	S Σ	0..1	boolean	Element id PractitionerRole.active Short description Whether this practitioner role record is in active use Definition Whether this practitioner role record is in active use. Requirements 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. Comments Identified as a query requirement through mCSD CapabilityStatement. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.status v2: STF-7 rim: .statusCode
period	Σ	0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.period Short description The period during which the practitioner is authorized to perform in these role(s) Definition The period during which the person is authorized to act as a practitioner in these role(s) for the organization. Requirements Even after the agencies is revoked, the fact that it existed must still be recorded. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.done[x] v2: PRD-8/9 / PRA-5.4 rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
practitioner	S Σ	0..1	Reference(Practitioner)	Element id PractitionerRole.practitioner Short description The Practitioner that performs this role. Definition The Practitioner that performs this role. Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Practitioner) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .player
organization	S Σ	0..1	Reference(Organization)	Element id PractitionerRole.organization Short description The Organization where the roles are available. Definition The Organization where the roles are available. Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .scoper
code	S Σ	1..*	CodeableConceptBinding	Element id PractitionerRole.code Short description The roles the Practitioner performs. Definition The roles the Practitioner performs. Requirements Need to know what authority the practitioner has - what can they do? Comments Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Data type CodeableConcept Binding A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic. HealthcareProviderRoleType (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 rim: .code servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
specialty	S Σ	0..*	CodeableConceptBinding	Element id PractitionerRole.specialty Short description Specific specialty of the practitioner Definition Specific specialty of the practitioner. Comments Identified as a query requirement through mCSD CapabilityStatement. Data type CodeableConcept Binding Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient. PractitionerSpecialty (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: PRA-5 rim: .player.HealthCareProvider[@classCode = 'PROV'].code servd: ./Specialty
location	S Σ	0..*	Reference(Location)	Element id PractitionerRole.location Short description The Location where the Practitioner provides care. Definition The Location where the Practitioner provides care. Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC'] servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
healthcareService	S	0..*	Reference(HealthcareService)	Element id PractitionerRole.healthcareService Short description The HealthcareServices provided by this Practitioner at an Organization and/or Location. Definition The HealthcareServices provided by this Practitioner at an Organization and/or Location. Comments Identified as a query requirement through mCSD CapabilityStatement. Data type Reference(HealthcareService) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: EDU-2 / AFF-3 rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
telecom	S Σ	0..*	ContactPoint	Element id PractitionerRole.telecom Short description Contact details that are specific to the role/location/service Definition Contact details that are specific to the role/location/service. Requirements 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. Comments Identified as a requirement to support the ability to distinguish practitioner contact information that is distinct by location (or service). This is a mustSupport element in the CA:eReC profile. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .telecom
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.telecom.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.telecom.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system	S Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.telecom.system Short description phone \| fax \| email \| pager \| url \| sms \| other Definition Telecommunications form for contact point - what communications system is required to make use of the contact. Data type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.3 rim: ./scheme servd: ./ContactPointType
value	Σ	0..1	string	There are no (further) constraints on this element Element id PractitionerRole.telecom.value Short description The actual contact point details Definition The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.1 (or XTN.12) rim: ./url servd: ./Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.telecom.use Short description home \| work \| temp \| old \| mobile - purpose of this contact point Definition Identifies the purpose for the contact point. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: XTN.2 - but often indicated by field rim: unique(./use) servd: ./ContactPointPurpose
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element id PractitionerRole.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies 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. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: n/a rim: n/a
period	Σ	0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
availableTime		0..*	BackboneElement	There are no (further) constraints on this element Element id PractitionerRole.availableTime Short description Times the Service Site is available Definition A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. Comments More detailed availability information may be provided in associated Schedule/Slot resources. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.availableTime.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.availableTime.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.availableTime.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element id PractitionerRole.availableTime.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Data type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element id PractitionerRole.availableTime.allDay Short description Always available? e.g. 24 hour service Definition Is this always available? (hence times are irrelevant) e.g. 24 hour service. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableStartTime		0..1	time	There are no (further) constraints on this element Element id PractitionerRole.availableTime.availableStartTime Short description Opening time of day (ignored if allDay = true) Definition The opening time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availableEndTime		0..1	time	There are no (further) constraints on this element Element id PractitionerRole.availableTime.availableEndTime Short description Closing time of day (ignored if allDay = true) Definition The closing time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
notAvailable		0..*	BackboneElement	There are no (further) constraints on this element Element id PractitionerRole.notAvailable Short description Not available during this time due to provided reason Definition The practitioner is not available or performing this role during this period of time due to the provided reason. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
id		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
description		1..1	string	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.description Short description Reason presented to the user explaining why time not available Definition The reason that can be presented to the user as to why this time is not available. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
during		0..1	Period	There are no (further) constraints on this element Element id PractitionerRole.notAvailable.during Short description Service not available from this date Definition Service is not available (seasonally or for a public holiday) from this date. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element id PractitionerRole.availabilityExceptions Short description Description of availability exceptions Definition A 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .effectiveTime
endpoint		0..*	Reference(Endpoint)	There are no (further) constraints on this element Element id PractitionerRole.endpoint Short description Technical endpoints providing access to services operated for the practitioner with this role Definition Technical endpoints providing access to services operated for the practitioner with this role. Requirements 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. Data type Reference(Endpoint) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-CSD-PractitionerRole" />
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:able-to-populate" />
        </extension>
        <extension url="code">
            <valueCode value="SHOULD:populate" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.active" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.practitioner" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.organization" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.code" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.specialty" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.location" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.healthcareService" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.telecom" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.telecom.system" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
        </extension>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:no-error" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.active" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.practitioner" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.organization" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.code" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.specialty" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.location" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.healthcareService" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.telecom" />
        </extension>
        <extension url="elementId">
            <valueString value="PractitionerRole.telecom.system" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" />
        </extension>
    </extension>
    <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-PractitionerRole" />
    <name value="PractitionerRole" />
    <status value="draft" />
    <description value="A PractitionerRole is used to show what Healthcare Service, a Practitioner provides at a particular Location for an Organization." />
    <copyright value="Copyright &#169; 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="PractitionerRole" />
    <baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PractitionerRole" />
    <derivation value="constraint" />
    <differential>
        <element id="PractitionerRole.active">
            <path value="PractitionerRole.active" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.practitioner">
            <path value="PractitionerRole.practitioner" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Practitioner" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.organization">
            <path value="PractitionerRole.organization" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.code">
            <path value="PractitionerRole.code" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated." />
            <mustSupport value="true" />
            <binding>
                <strength value="preferred" />
                <description value="A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic." />
                <valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype" />
            </binding>
        </element>
        <element id="PractitionerRole.specialty">
            <path value="PractitionerRole.specialty" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <mustSupport value="true" />
            <binding>
                <strength value="preferred" />
                <description value="Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient." />
                <valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty" />
            </binding>
        </element>
        <element id="PractitionerRole.location">
            <path value="PractitionerRole.location" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.healthcareService">
            <path value="PractitionerRole.healthcareService" />
            <comment value="Identified as a query requirement through mCSD CapabilityStatement." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.telecom">
            <path value="PractitionerRole.telecom" />
            <comment value="Identified as a requirement to support the ability to distinguish practitioner contact information that is distinct by location (or service). This is a mustSupport element in the CA:eReC profile." />
            <mustSupport value="true" />
        </element>
        <element id="PractitionerRole.telecom.system">
            <path value="PractitionerRole.telecom.system" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/obligation",
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:able-to-populate"
                },
                {
                    "url": "code",
                    "valueCode": "SHOULD:populate"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.active"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.practitioner"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.organization"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.code"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.specialty"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.location"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.healthcareService"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.telecom"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.telecom.system"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
                }
            ]
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/obligation",
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:no-error"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.active"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.practitioner"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.organization"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.code"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.specialty"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.location"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.healthcareService"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.telecom"
                },
                {
                    "url": "elementId",
                    "valueString": "PractitionerRole.telecom.system"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client"
                }
            ]
        }
    ],
    "id": "CA-CSD-PractitionerRole",
    "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-PractitionerRole",
    "name": "PractitionerRole",
    "description": "A PractitionerRole is used to show what Healthcare Service, a Practitioner provides at a particular Location for an Organization.",
    "status": "draft",
    "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "PractitionerRole",
    "baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PractitionerRole",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "PractitionerRole.active",
                "path": "PractitionerRole.active",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.practitioner",
                "path": "PractitionerRole.practitioner",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Practitioner"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.organization",
                "path": "PractitionerRole.organization",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.code",
                "path": "PractitionerRole.code",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated.",
                "binding": {
                    "strength": "preferred",
                    "description": "A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic.",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype"
                },
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.specialty",
                "path": "PractitionerRole.specialty",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "binding": {
                    "strength": "preferred",
                    "description": "Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty"
                },
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.location",
                "path": "PractitionerRole.location",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.healthcareService",
                "path": "PractitionerRole.healthcareService",
                "comment": "Identified as a query requirement through mCSD CapabilityStatement.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-HealthcareService"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.telecom",
                "path": "PractitionerRole.telecom",
                "comment": "Identified as a requirement to support the ability to distinguish practitioner contact information that is distinct by location (or service). This is a mustSupport element in the CA:eReC profile.",
                "mustSupport": true
            },
            {
                "id": "PractitionerRole.telecom.system",
                "path": "PractitionerRole.telecom.system",
                "mustSupport": true
            }
        ]
    }
}

Terminology bindings

Constraints

Obligations

Obligations	Actor	Element
SHALL:able-to-populate; SHOULD:populate	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server	PractitionerRole.active; PractitionerRole.practitioner; PractitionerRole.organization; PractitionerRole.code; PractitionerRole.specialty; PractitionerRole.location; PractitionerRole.healthcareService; PractitionerRole.telecom; PractitionerRole.telecom.system
SHALL:no-error	http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client	PractitionerRole.active; PractitionerRole.practitioner; PractitionerRole.organization; PractitionerRole.code; PractitionerRole.specialty; PractitionerRole.location; PractitionerRole.healthcareService; PractitionerRole.telecom; PractitionerRole.telecom.system