National Healthcare Directory Exchange
1.0.0-ballot - ballot

National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions

## Resource Profile: National Directory PractitionerRole

Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-PractitionerRole | Version: 1.0.0-ballot
Active as of 2022-12-08 | Computable Name: NatlDirExPractitionerRole

PractionerRole describes details about a provider, which can be a practitioner or an organization. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services to patients at a location. When the provider is a practitioner, there may also be a relationship to an organization. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization.

Usage:

- Examples for this Resource Profile: PractitionerRole/AnonRole, PractitionerRole/CounselorRole1, PractitionerRole/HansSoloRole1, PractitionerRole/JoeSmithRole1, PractitionerRole/JoeSmithRole2, PractitionerRole/JoeSmithRole3

### Formal Views of Profile Content

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

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

This structure is derived from NatlDirEndpointQryPractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
identifier |  |  |  |
type | S | 0..1 | CodeableConcept | Description of identifier
value | S | 0..1 | string | The value that is unique
assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
network-reference |  | 0..1 | Reference(National Directory Endpoint Qry Exchange Network) | NetworkReference URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner role record is in active use
practitioner | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code Value Set (required)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(National Directory Endpoint Qry Exchange HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PractitionerRole.identifier.use | required | IdentifierUse
PractitionerRole.identifier.type | extensible | Identifier Type Codes
PractitionerRole.code | required | PractitionerRoleVS
PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVS

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
network-reference |  | 0..1 | Reference(National Directory Endpoint Qry Exchange Network) | NetworkReference URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code Value Set (required)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(National Directory Endpoint Qry Exchange HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 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 | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PractitionerRole.meta.security | extensible | All Security Labels
PractitionerRole.meta.tag | example | CommonTags
PractitionerRole.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.identifier.use | required | IdentifierUse
PractitionerRole.identifier.type | extensible | Identifier Type Codes
PractitionerRole.code | required | PractitionerRoleVS
PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVS
PractitionerRole.telecom.system | required | ContactPointSystem
PractitionerRole.telecom.use | required | ContactPointUse
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek

This structure is derived from NatlDirEndpointQryPractitionerRole

Summary

Must-Support: 3 elements

Differential View

This structure is derived from NatlDirEndpointQryPractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
identifier |  |  |  |
type | S | 0..1 | CodeableConcept | Description of identifier
value | S | 0..1 | string | The value that is unique
assigner | S | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
network-reference |  | 0..1 | Reference(National Directory Endpoint Qry Exchange Network) | NetworkReference URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner role record is in active use
practitioner | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code Value Set (required)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(National Directory Endpoint Qry Exchange HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PractitionerRole.identifier.use | required | IdentifierUse
PractitionerRole.identifier.type | extensible | Identifier Type Codes
PractitionerRole.code | required | PractitionerRoleVS
PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVS

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | NatlDirEndpointQryPractitionerRole | Roles/organizations the practitioner is associated with
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
network-reference |  | 0..1 | Reference(National Directory Endpoint Qry Exchange Network) | NetworkReference URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/network-reference
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | S Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ | 1..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole Code Value Set (required)
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | The location(s) at which this practitioner provides care
healthcareService | S | 0..* | Reference(National Directory Endpoint Qry Exchange HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 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 | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
PractitionerRole.meta.security | extensible | All Security Labels
PractitionerRole.meta.tag | example | CommonTags
PractitionerRole.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.identifier.use | required | IdentifierUse
PractitionerRole.identifier.type | extensible | Identifier Type Codes
PractitionerRole.code | required | PractitionerRoleVS
PractitionerRole.specialty | required | IndividualAndGroupSpecialtiesVS
PractitionerRole.telecom.system | required | ContactPointSystem
PractitionerRole.telecom.use | required | ContactPointUse
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek

This structure is derived from NatlDirEndpointQryPractitionerRole

Summary

Must-Support: 3 elements

Other representations of profile: CSV, Excel, Schematron