0.1.0 - ci-build

PatientScheduling - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SMART PractitionerRole

Official URL: http://example.org/StructureDefinition/smart-practitioner-role Version: 0.1.0
Draft as of 2025-12-23 Computable Name: SMARTPractitionerRole

This profile sets minimum expectations for the PractitionerRole resource to enable SMART Schedule Links use cases

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... 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
... 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(SMART Practitioner) Practitioner that is able to provide the defined services for the organization
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... organization SΣ 0..1 Reference(Organization) Organization where the roles are available
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ndh SΣ 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:other SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... coding SΣ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
... location SΣ 0..* Reference(Location) The location(s) at which this practitioner provides care
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... availableTime S 0..* BackboneElement Times the Service Site is available
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... 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
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍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()

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... 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
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... organization S 0..1 Reference(Organization) Organization where the roles are available
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... code S 0..* CodeableConcept Roles which this practitioner may perform
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system S 0..1 uri Identity of the terminology system
...... code S 0..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ndh S 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
..... coding:other S 0..* Coding Code defined by a terminology system
... specialty S 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... coding S 0..* Coding Code defined by a terminology system
..... system S 0..1 uri Identity of the terminology system
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... location S 0..* Reference(Location) The location(s) at which this practitioner provides care
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... telecom S 0..* ContactPoint Contact details that are specific to the role/location/service
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
... availableTime S 0..* BackboneElement Times the Service Site is available
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... id Σ 0..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
... 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(SMART Practitioner) Practitioner that is able to provide the defined services for the organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... organization SΣ 0..1 Reference(Organization) Organization where the roles are available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ndh SΣ 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:other SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... location SΣ 0..* Reference(Location) The location(s) at which this practitioner provides care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(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
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... availableTime S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 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 S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... 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
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.practitioner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.organization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown
PractitionerRole.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.healthcareService.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍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()

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 43 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.code.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... 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
... 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(SMART Practitioner) Practitioner that is able to provide the defined services for the organization
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... organization SΣ 0..1 Reference(Organization) Organization where the roles are available
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:ndh SΣ 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
..... coding:other SΣ 0..* Coding Code defined by a terminology system
...... system SΣ 0..1 uri Identity of the terminology system
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... coding SΣ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
... location SΣ 0..* Reference(Location) The location(s) at which this practitioner provides care
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... display SΣ 0..1 string Text alternative for the resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... availableTime S 0..* BackboneElement Times the Service Site is available
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... 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
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍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()

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... 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
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... organization S 0..1 Reference(Organization) Organization where the roles are available
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... code S 0..* CodeableConcept Roles which this practitioner may perform
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system S 0..1 uri Identity of the terminology system
...... code S 0..1 code Symbol in syntax defined by the system
...... display S 0..1 string Representation defined by the system
..... coding:ndh S 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
..... coding:other S 0..* Coding Code defined by a terminology system
... specialty S 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... coding S 0..* Coding Code defined by a terminology system
..... system S 0..1 uri Identity of the terminology system
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... location S 0..* Reference(Location) The location(s) at which this practitioner provides care
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... display S 0..1 string Text alternative for the resource
... telecom S 0..* ContactPoint Contact details that are specific to the role/location/service
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string The actual contact point details
... availableTime S 0..* BackboneElement Times the Service Site is available
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... id Σ 0..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
... 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(SMART Practitioner) Practitioner that is able to provide the defined services for the organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... organization SΣ 0..1 Reference(Organization) Organization where the roles are available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:ndh SΣ 1..* Coding Code defined by a terminology system
Binding: http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:other SΣ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 0..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 0..1 code Symbol in syntax defined by the system
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... location SΣ 0..* Reference(Location) The location(s) at which this practitioner provides care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... healthcareService S 0..* Reference(SMART Healthcare Service) The list of healthcare services that this worker provides for this role's Organization/Location(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
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
... telecom SΣ 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... availableTime S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 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 S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
..... 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
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.practitioner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.organization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.code.​coding:ndh Base required http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS Not State Unknown
PractitionerRole.specialty Base extensible http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS Not State Unknown
PractitionerRole.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.healthcareService.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍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()

This structure is derived from PractitionerRole

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 43 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.code.coding

 

Other representations of profile: CSV, Excel, Schematron