Da Vinci Clinical Data Exchange (CDex)
2.1.0 - STU 2.1

Publication Build: This will be filled in by the publication tooling

## Resource Profile: CDex PractitionerRole Profile

Official URL: http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-practitionerrole | Version: 2.1.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CDexPractitionerRole
Other Identifiers: OID:2.16.840.1.113883.4.642.40.21.42.3
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

This Profile is defined as a contained resource within the CDex Task Attachment Request Profile. It is referenced by `Task.owner` to communicate the provider ID as a unique organization/location identifier (e.g., Type 2 NPI), or unique provider identifier (e.g., Type 1 NPI), or both. It constrains the following elements to be must support (min=0).:

- A default resource ID of "practitionerrole"
- A `practitioner.identifier`
- An `organization.identifier`

At least a practitioner identifier or organization identifier SHALL be present.

Usage:

- Use this Resource Profile: CDex Task Attachment Request Profile
- Refer to this Resource Profile: CDex Task Attachment Request Profile

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S Σ | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitioner | S Σ | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
identifier | S Σ C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI) ele-1: All FHIR elements must have a @value or children
organization | S Σ | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children
identifier | S Σ C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
practitioner | S | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization
identifier | S C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI)
organization | S | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available
identifier | S C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI)
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S Σ | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..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 Σ | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI)
display | Σ | 0..1 | string | Text alternative for the resource
organization | S Σ | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI)
display | Σ | 0..1 | string | Text alternative for the resource
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(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
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.practitioner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
PractitionerRole.organization.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
PractitionerRole.code | example | PractitionerRole `http://hl7.org/fhir/ValueSet/practitioner-role` from the FHIR Standard
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

This structure is derived from PractitionerRole

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0)
- HRex Organization Profile (http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S Σ | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitioner | S Σ | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
identifier | S Σ C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI) ele-1: All FHIR elements must have a @value or children
organization | S Σ | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children
identifier | S Σ C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

Differential View

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
practitioner | S | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization
identifier | S C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI)
organization | S | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available
identifier | S C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI)
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with cdex-3: At least a practitioner.identifier or organization.identifier SHALL be present.
id | S Σ | 1..1 | id | Logical id of this artifact Fixed Value: practitionerrole
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..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 Σ | 0..1 | Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0)) | Practitioner that is able to provide the defined services for the organization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ C | 1..1 | Identifier | Practitioner ID (e.g., Type 1 NPI)
display | Σ | 0..1 | string | Text alternative for the resource
organization | S Σ | 0..1 | Reference(HRex Organization Profile(1.1.0)) | Organization where the roles are available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ C | 1..1 | Identifier | Organization ID (e.g., Type 2 NPI)
display | Σ | 0..1 | string | Text alternative for the resource
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(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
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.practitioner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
PractitionerRole.organization.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
PractitionerRole.code | example | PractitionerRole `http://hl7.org/fhir/ValueSet/practitioner-role` from the FHIR Standard
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
cdex-3 | error | PractitionerRole | At least a practitioner.identifier or organization.identifier SHALL be present. : practitioner.identifier.exists() or organization.identifier.exists() |

This structure is derived from PractitionerRole

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0)
- HRex Organization Profile (http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron