SMART Scheduling Links
1.0.0-ballot - STU 1 Ballot

SMART Scheduling Links, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smart-scheduling-links/ and changes regularly. See the Directory of published versions

## Resource Profile: PractitionerRole

Official URL: http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-practitionerRole | Version: 1.0.0-ballot | Highlight text changes?
Standards status: Trial-use Active as of 2026-04-01 | Maturity Level: 2 | Computable Name: SmartSchedulingPractitionerRole

The PractitionerRole resource represents the specific roles that practitioners perform at organizations where appointments are available

Usages:

- Examples for this Profile: PractitionerRole/ad23d8f2-b88e-48af-ae96-e36f5a5fbd43

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | S Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | S Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std.
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S | 1..1 | id | Logical id of this artifact
identifier | S | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S | 0..1 | boolean | Whether this practitioner role record is in active use
period | S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
start | S | 0..1 | dateTime | Starting time with inclusive boundary
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S | 0..1 | Reference(Organization) | Organization where the roles are available
code | S | 0..* | CodeableConcept | Roles which this practitioner may perform
specialty | S | 0..* | CodeableConcept | Specific specialty of the practitioner
location | S | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | S Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | S Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std.
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.
PractitionerRole.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Summary

Mandatory: 1 element
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- Practitioner (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-practitioner)
- Location (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-location)
- Healthcare Service (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-healthcare-service)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | S Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | S Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std.
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S | 1..1 | id | Logical id of this artifact
identifier | S | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S | 0..1 | boolean | Whether this practitioner role record is in active use
period | S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
start | S | 0..1 | dateTime | Starting time with inclusive boundary
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S | 0..1 | Reference(Organization) | Organization where the roles are available
code | S | 0..* | CodeableConcept | Roles which this practitioner may perform
specialty | S | 0..* | CodeableConcept | Specific specialty of the practitioner
location | S | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S | 0..* | ContactPoint | Contact details that are specific to the role/location/service
Documentation for this format

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | S Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | S Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | S Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
start | S Σ C | 0..1 | dateTime | Starting time with inclusive boundary
end | S Σ C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing
practitioner | S Σ | 0..1 | Reference(Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | S Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
PractitionerRole.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
PractitionerRole.code | Base | example | Practitioner role | 📍4.0.1 | FHIR Std.
PractitionerRole.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std.
PractitionerRole.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | PractitionerRole | 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 | error | PractitionerRole | 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 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Summary

Mandatory: 1 element
Must-Support: 13 elements

Structures

This structure refers to these other structures:

- Practitioner (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-practitioner)
- Location (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-location)
- Healthcare Service (http://hl7.org/fhir/uv/smart-scheduling-links/StructureDefinition/smart-scheduling-healthcare-service)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron