US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions

Resource Profile: Practitioner Role

Official URL: http://va.gov/fhir/StructureDefinition/PractitionerRole Version: 1.10.0
Active as of 2025-11-04 Computable Name: PractitionerRole

This StructureDefinition contains the maps for VistA file NEW PERSON (200) to us-core-practitionerrole.

​See also the FHIR Shorthand.

Use Case Overview

Use Case: Practitioner Role«us-core-practitionerrole»PractitionerRolepractitionerlocationorganizationPractitionerLocationOrganization

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 C 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
Constraints: pd-1, us-core-13
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-job-title"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: PractitionerJobTitle (example): Job title
...... text SΣ 0..1 string Plain text representation of the concept
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... period Σ 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ΣC 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... 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: Healthcare Provider Taxonomy . (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
... location SΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... Slices for telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... 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.
.... telecom:va-work SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-phone3 SΣC 0..1 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.
Required Pattern: phone
..... 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.
.... telecom:va-phone4 SΣC 0..1 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.
Required Pattern: phone
..... 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.
.... telecom:va-commercial SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-fax SΣC 0..1 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.
Required Pattern: fax
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-voice-pager SΣC 0..1 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.
Required Pattern: pager
..... 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.
.... telecom:va-data-pager SΣC 0..1 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.
Required Pattern: pager
..... 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.
.... telecom:va-mail SΣC 0..1 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.
Required Pattern: email
..... 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.
... endpoint SC 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.extension:practitioner-job-title.​value[x] Base example practitioner job title 📦5.2.0 FHIR Extensions Pack v5.2
PractitionerRole.code Base extensible US Core Provider Role (NUCC) 📦5.0.1 US Core v5.0
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📦20190521 VSAC v0.18
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​use Base required ContactPointUse 📍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()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom or endpoint
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... value[x]
...... text S 0..1 string Plain text representation of the concept
... active SC 0..1 boolean Whether this practitioner role record is in active use
Constraints: pr-16-411, pr-16-412
... period
.... start S 0..1 dateTime Starting time with inclusive boundary
.... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... organization 0..1 Reference(Organization) Organization where the roles are available
... code
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... specialty
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
... location C 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... Slices for telecom 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom:va-work S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-phone3 S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
.... telecom:va-phone4 S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
.... telecom:va-commercial S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-fax S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-voice-pager S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
..... value 1..1 string The actual contact point details
.... telecom:va-data-pager S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
..... value 1..1 string The actual contact point details
.... telecom:va-mail S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
Constraints: pd-1, us-core-13
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-job-title"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: PractitionerJobTitle (example): Job title
...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
... active SΣC 0..1 boolean Whether this practitioner role record is in active use
Constraints: pr-16-411, pr-16-412
... period Σ 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ΣC 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
.... 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 Σ 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
Required Pattern: http://nucc.org/provider-taxonomy
..... 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: Healthcare Provider Taxonomy . (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 Σ 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
Required Pattern: http://nucc.org/provider-taxonomy
..... 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
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
..... 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ΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... Slices for telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom: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Σ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
.... telecom:va-work SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-phone3 SΣC 0..1 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.
Required Pattern: phone
..... 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
.... telecom:va-phone4 SΣC 0..1 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.
Required Pattern: phone
..... 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
.... telecom:va-commercial SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-fax SΣC 0..1 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.
Required Pattern: fax
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-voice-pager SΣC 0..1 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.
Required Pattern: pager
..... 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
.... telecom:va-data-pager SΣC 0..1 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.
Required Pattern: pager
..... 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
.... telecom:va-mail SΣC 0..1 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.
Required Pattern: email
..... 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 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 SC 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.extension:practitioner-job-title.​value[x] Base example practitioner job title 📦5.2.0 FHIR Extensions Pack v5.2
PractitionerRole.code Base extensible US Core Provider Role (NUCC) 📦5.0.1 US Core v5.0
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📦20190521 VSAC v0.18
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​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()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom or endpoint
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

Summary

Must-Support: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
Constraints: pd-1, us-core-13
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-job-title"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: PractitionerJobTitle (example): Job title
...... text SΣ 0..1 string Plain text representation of the concept
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... period Σ 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ΣC 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... 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: Healthcare Provider Taxonomy . (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code SΣ 0..1 code Symbol in syntax defined by the system
..... display SΣ 0..1 string Representation defined by the system
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
... location SΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... Slices for telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... 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.
.... telecom:va-work SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-phone3 SΣC 0..1 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.
Required Pattern: phone
..... 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.
.... telecom:va-phone4 SΣC 0..1 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.
Required Pattern: phone
..... 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.
.... telecom:va-commercial SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-fax SΣC 0..1 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.
Required Pattern: fax
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
.... telecom:va-voice-pager SΣC 0..1 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.
Required Pattern: pager
..... 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.
.... telecom:va-data-pager SΣC 0..1 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.
Required Pattern: pager
..... 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.
.... telecom:va-mail SΣC 0..1 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.
Required Pattern: email
..... 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.
... endpoint SC 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.extension:practitioner-job-title.​value[x] Base example practitioner job title 📦5.2.0 FHIR Extensions Pack v5.2
PractitionerRole.code Base extensible US Core Provider Role (NUCC) 📦5.0.1 US Core v5.0
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📦20190521 VSAC v0.18
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​use Base required ContactPointUse 📍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()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom or endpoint
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner or organization or healthcareService or location

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... value[x]
...... text S 0..1 string Plain text representation of the concept
... active SC 0..1 boolean Whether this practitioner role record is in active use
Constraints: pr-16-411, pr-16-412
... period
.... start S 0..1 dateTime Starting time with inclusive boundary
.... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
... organization 0..1 Reference(Organization) Organization where the roles are available
... code
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
... specialty
.... coding
..... system S 0..1 uri Identity of the terminology system
Required Pattern: http://nucc.org/provider-taxonomy
..... code S 0..1 code Symbol in syntax defined by the system
..... display S 0..1 string Representation defined by the system
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
... location C 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... Slices for telecom 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom:va-work S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-phone3 S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
.... telecom:va-phone4 S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
.... telecom:va-commercial S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-fax S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
..... value 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Required Pattern: work
.... telecom:va-voice-pager S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
..... value 1..1 string The actual contact point details
.... telecom:va-data-pager S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: pager
..... value 1..1 string The actual contact point details
.... telecom:va-mail S 0..1 ContactPoint Contact details that are specific to the role/location/service
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1 string The actual contact point details
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile(5.0.1) Roles/organizations the practitioner is associated with
This profile also complies with the profiles US Core PractitionerRole Profile (6.1.0) and US Core PractitionerRole Profile (7.0.0)
Constraints: pd-1, us-core-13
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:practitioner-job-title S 0..1 (Complex) Job Title
URL: http://hl7.org/fhir/StructureDefinition/practitioner-job-title
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/practitioner-job-title"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: PractitionerJobTitle (example): Job title
...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
... active SΣC 0..1 boolean Whether this practitioner role record is in active use
Constraints: pr-16-411, pr-16-412
... period Σ 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ΣC 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(Organization) Organization where the roles are available
... code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
.... 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 Σ 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
Required Pattern: http://nucc.org/provider-taxonomy
..... 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: Healthcare Provider Taxonomy . (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 Σ 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
Required Pattern: http://nucc.org/provider-taxonomy
..... 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
Required Pattern: concat({PROVIDER TYPE (.01)}, {CLASSIFICATION (1)}, {AREA OF SPECIALIZATION (2)})
..... 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ΣC 0..* Reference(Location) The location(s) at which this practitioner provides care
Constraints: pr-16-422
... healthcareService C 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... Slices for telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
Slice: Unordered, Open by value:$this
.... telecom: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Σ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
.... telecom:va-work SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-phone3 SΣC 0..1 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.
Required Pattern: phone
..... 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
.... telecom:va-phone4 SΣC 0..1 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.
Required Pattern: phone
..... 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
.... telecom:va-commercial SΣC 0..1 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.
Required Pattern: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-fax SΣC 0..1 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.
Required Pattern: fax
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Required Pattern: work
..... 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
.... telecom:va-voice-pager SΣC 0..1 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.
Required Pattern: pager
..... 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
.... telecom:va-data-pager SΣC 0..1 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.
Required Pattern: pager
..... 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
.... telecom:va-mail SΣC 0..1 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.
Required Pattern: email
..... 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 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 SC 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.extension:practitioner-job-title.​value[x] Base example practitioner job title 📦5.2.0 FHIR Extensions Pack v5.2
PractitionerRole.code Base extensible US Core Provider Role (NUCC) 📦5.0.1 US Core v5.0
PractitionerRole.specialty Base extensible Healthcare Provider Taxonomy . 📦20190521 VSAC v0.18
PractitionerRole.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-work.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone3.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-phone4.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-commercial.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-fax.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-voice-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-data-pager.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
PractitionerRole.telecom:va-mail.​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()
pd-1 error PractitionerRole SHALL have contact information or a reference to an Endpoint telecom or endpoint
pr-16-411 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date > now or = null then fixed value true true
pr-16-412 best practice PractitionerRole.active If (200-8932.1 > 200.05-3) is date < now then fixed value false true
pr-16-422 best practice PractitionerRole.location If {2600>44.1-.01>200} then reference /Location based on (44-) true
us-core-13 error PractitionerRole SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

Summary

Must-Support: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron