National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole | Version: 2.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhPractitionerRole | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.49 | |||||
This profile enables NDH to express how practitioners function within organizations, locations, services, and networks so users can understand role-specific participation and route patients to the right provider context for care and coverage; it adds extensions for ratings, new-patient intake, network references, and verification, and uses ValueSet bindings for practitioner-role and specialty coding to support consistent downstream matching and routing.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location |
  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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| extension:newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics |
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
 extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
  assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |
| practitioner |
C | 0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
| organization |
C | 0..1 | Reference(NDH Organization Profile) | Organization where the role is available |
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: CareTeamMemberFunction (20240605)  (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |
| location |
C | 0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care |
| healthcareService |
C | 0..* | Reference(NDH HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
C | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| 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. | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| 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 | |
| endpoint |
C | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.19 |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
This structure is derived from USCorePractitionerRoleProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: practitioner-or-organization-or-healthcareservice-or-location |
 meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| extension:newpatients |
0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients | |
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |
| practitioner |
0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | |
| organization |
0..1 | Reference(NDH Organization Profile) | Organization where the role is available | |
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |
| location |
0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care | |
| healthcareService |
0..* | Reference(NDH HealthcareService Profile) | 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 | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| endpoint |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location | ||||
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| extension:newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics | ||||
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| 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 | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
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 |
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 |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |||||
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
| practitioner |
C | 0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
C | 0..1 | Reference(NDH Organization Profile) | Organization where the role is available | ||||
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |||||
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |||||
| location |
C | 0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
C | 0..* | Reference(NDH HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
C | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
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 |
C | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| PractitionerRole.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.19 |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location |
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| extension:newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics |
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |
| practitioner |
C | 0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
| organization |
C | 0..1 | Reference(NDH Organization Profile) | Organization where the role is available |
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |
| location |
C | 0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care |
| healthcareService |
C | 0..* | Reference(NDH HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
C | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| 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. | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| 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 | |
| endpoint |
C | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.19 |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
Differential View
This structure is derived from USCorePractitionerRoleProfile
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: practitioner-or-organization-or-healthcareservice-or-location |
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| extension:newpatients |
0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients | |
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |
| assigner |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |
| practitioner |
0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | |
| organization |
0..1 | Reference(NDH Organization Profile) | Organization where the role is available | |
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |
| location |
0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care | |
| healthcareService |
0..* | Reference(NDH HealthcareService Profile) | 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 | |
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |
| endpoint |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13, practitioner-or-organization-or-healthcareservice-or-location | ||||
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:rating |
0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| extension:newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics | ||||
| extension:network |
0..* | Reference(NDH Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| extension:verification-status |
0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business Identifiers that are specific to a role/location | |||||
| 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 | |||||
| extension:identifier-status |
0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
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 |
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 |
0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text) | |||||
| active |
1..1 | boolean | Whether this practitioner role record is in active use Required Pattern: true (extensions allowed) | |||||
| period |
0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | |||||
| practitioner |
C | 0..1 | Reference(NDH Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
C | 0..1 | Reference(NDH Organization Profile) | Organization where the role is available | ||||
| Slices for code |
0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by value:$this Binding: CareTeamMemberFunction (20240605) (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| code:NDHPractitionerRoleCode |
0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | |||||
| specialty |
0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual Qualifications Value Set (extensible) | |||||
| location |
C | 0..* | Reference(NDH Location Profile) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
C | 0..* | Reference(NDH HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
C | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
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 |
C | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| PractitionerRole.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| PractitionerRole.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| PractitionerRole.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| PractitionerRole.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| PractitionerRole.code | Base | extensible |
Care Team Member Function
|
📍20240605 | VSAC v0.19 |
| PractitionerRole.code:NDHPractitionerRoleCode | Base | required | PractitionerRole Code Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.specialty | Base | extensible | Individual Qualifications Value Set | 📦2.0.0-current | This IG |
| PractitionerRole.telecom.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| PractitionerRole.telecom.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| PractitionerRole.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| practitioner-or-organization-or-healthcareservice-or-location | error | PractitionerRole | If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
practitioner.exists() or (organization.exists() or healthcareService.exists() or location.exists())
|
This structure is derived from USCorePractitionerRoleProfile
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
| SearchParameter Name | Type | Example |
|---|---|---|
| location | reference | GET [base]/PractitionerRole?location.address-state=FL |
| network | reference | GET [base]/PractitionerRole?network.type=ntwk$network.name=Florida Blue |
| new-patient | token | GET [base]/PractitionerRole?new-patient=newpt |
| new-patient-from-network | reference | GET [base]/PractitionerRole?new-patient-from-network=newpt |
| organization | reference | GET [base]/PractitionerRole?organization.name=Florida Blue |
| verification-status | token | GET [base]/PractitionerRole?verification-status=complete |
Since there is no direct individual url for each Search Parameter defined by FHIR Search Parameter Registry, we have provided the following links for you to access more information about them.
| SearchParameter Name | Type | Example |
|---|---|---|
| active | token | GET [base]/PractitionerRole?active=true |
| endpoint | reference | GET [base]/PractitionerRole?endpoint.status=active |
| identifier | token | GET [base]/PractitionerRole?identifier=1234567 |
| practitioner | reference | GET [base]/PractitionerRole?practitoner.name=Joe Smith |
| role | token | GET [base]/PractitionerRole?role=att |
| service | reference | GET [base]/PractitionerRole?service.address-state=FL |
| specialty | token | GET [base]/PractitionerRole?specialty=103TF0000X |
| _include | Example |
|---|---|
| PractitionerRole:endpoint | GET [base]/PractitionerRole?_include=PractitionerRole:endpoint |
| PractitionerRole:location | GET [base]/PractitionerRole?_include=PractitionerRole:location |
| PractitionerRole:network | GET [base]/PractitionerRole?_include=PractitionerRole:network |
| PractitionerRole:new-patient-from-network | GET [base]/PractitionerRole?_include= PractitionerRole:new-patient-from-network |
| PractitionerRole:organization | GET [base]/PractitionerRole?_include=PractitionerRole:organization |
| PractitionerRole:practitioner | GET [base]/PractitionerRole?_include=PractitionerRole:practitioner |
| PractitionerRole:service | GET [base]/PractitionerRole?_include=PractitionerRole:service |
None
The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.
Assuming that the Practitioner "owns" the practitionerRole, the practitioner must attest to the information related to their participation in a specific network. If there is no existing network declaration associated with that practitionerRole, the practitioner should update the practitionerRole accordingly. However, if a network declaration already exists for that role, the practitioner should create a new practitionerRole and include the network information in this role. This process is also applicable to other individuals who have ownership responsibilities for the practitionerRole.
Given that both 'availableTime' and 'notAvailable' time are optional elements, they can be excluded for intricate or often changing schedules. These fundamental elements are designed for use where providers have fairly stable schedules (such as clinic schedules that need to be communicated clearly as part of the directory resources), as opposed to an on-call practitioner's schedule.
The address for a practitionerRole should be located on the Location reference. There is no address on the practitionerRole base resource since the location reference of practitionerRole has an address that should be used by the practitioner as part of their role. Each practitionerRole can support multiple locations. If two practitioners work at the same facility and each of them has their own non-service delivery locations, in addition to the common service delivery location. The guidance descripted in the diagram below:
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change