National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
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 1.0.0-ballot 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: 1.0.0-ballot | |||
| Active as of 2024-11-01 | Computable Name: NdhPractitionerRole | |||
Copyright/Legal: HL7 International |
||||
PractitionerRole typically describes details about a provider. When the provider is a practitioner, there may be a relationship to an organization. A provider renders services at a location. Practitioner participation in healthcare provider insurance networks may be direct or through their role at an organization. PractitionerRole involves either the actual or potential (hence the optionality on Practitioner) of an individual to play this role on behalf of or under the auspices of an organization. The absence of a Practitioner resource does not imply that the Organization itself is playing the role of a Practitioner, instead it implies that role has been established by the Organization and MAY apply that to a specific Practitioner.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePractitionerRoleProfile
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
|---|---|---|---|---|
  PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner-or-organization-or-healthcareservice-or-location: If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
  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 | |
   rating |
0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
| network |
0..1 | Reference(NDH Base Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| usage-restriction |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| digitalcertificate |
0..* | (Complex) | Digital Certificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | |
| qualification |
0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | |
 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 |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
 Slices for extension |
Content/Rules for all slices | |||
| 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 Base 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 |
| practitioner |
SΣC | 0..1 | Reference(NDH Base Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
| organization |
SΣC | 0..1 | Reference(NDH Base Organization Profile) | Organization where the role is available |
| Slices for code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: Care Team Member Function  (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. |
| code:NDHPractitionerRoleCode |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) |
| location |
SΣC | 0..* | Reference(NDH Base Location Profile) | The location(s) at which this practitioner provides care |
| healthcareService |
SC | 0..* | Reference(NDH Base HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |
| via-intermediary |
0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| endpoint |
SC | 0..* | Reference(NDH Base Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner-or-organization-or-healthcareservice-or-location: If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rating |
0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
| network |
0..1 | Reference(NDH Base Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| usage-restriction |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| digitalcertificate |
0..* | (Complex) | Digital Certificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | |||||
| qualification |
0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | |||||
| 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 |
SΣ | 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 | |||||
| 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 Base 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 | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 0..1 | Reference(NDH Base Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 0..1 | Reference(NDH Base Organization Profile) | Organization where the role is available | ||||
| Slices for code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. | ||||
| code:NDHPractitionerRoleCode |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) | ||||
| location |
SΣC | 0..* | Reference(NDH Base Location Profile) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..* | Reference(NDH Base HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣC | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
| via-intermediary |
0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(NDH Base Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | ||||
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCorePractitionerRoleProfile
| Path | Conformance | ValueSet | URI |
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner-or-organization-or-healthcareservice-or-location: If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present |
| 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 | |
| rating |
0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |
| newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed |
| network |
0..1 | Reference(NDH Base Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |
| usage-restriction |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| digitalcertificate |
0..* | (Complex) | Digital Certificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | |
| qualification |
0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | |
| 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 |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location |
| Slices for extension |
Content/Rules for all slices | |||
| 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 Base 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 |
| practitioner |
SΣC | 0..1 | Reference(NDH Base Practitioner Profile) | Practitioner that is able to provide the defined services for the organization |
| organization |
SΣC | 0..1 | Reference(NDH Base Organization Profile) | Organization where the role is available |
| Slices for code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. |
| code:NDHPractitionerRoleCode |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) |
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) |
| location |
SΣC | 0..* | Reference(NDH Base Location Profile) | The location(s) at which this practitioner provides care |
| healthcareService |
SC | 0..* | Reference(NDH Base HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
| telecom |
SΣC | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
| Slices for extension |
Content/Rules for all slices | |||
| contactpoint-availabletime |
0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |
| via-intermediary |
0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| endpoint |
SC | 0..* | Reference(NDH Base Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | |
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | |
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | |
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | |
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| PractitionerRole |
C | 0..* | USCorePractitionerRoleProfile(6.1.0) | Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location. practitioner-or-organization-or-healthcareservice-or-location: If NdhPractitionerRole.practitioner is absent ( NdhPractitionerRole.organization, NdhPractitionerRole.healthcareservice, NdhPractitionerRole.location) must be present | ||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rating |
0..* | (Complex) | NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating | |||||
| newpatients |
C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed | ||||
| network |
0..1 | Reference(NDH Base Network Profile) | NetworkReference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference | |||||
| usage-restriction |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| digitalcertificate |
0..* | (Complex) | Digital Certificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate | |||||
| qualification |
0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | |||||
| 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 |
SΣ | 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 | |||||
| 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 Base 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 | ||||
| period |
Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
| practitioner |
SΣC | 0..1 | Reference(NDH Base Practitioner Profile) | Practitioner that is able to provide the defined services for the organization | ||||
| organization |
SΣC | 0..1 | Reference(NDH Base Organization Profile) | Organization where the role is available | ||||
| Slices for code |
SΣ | 0..* | CodeableConcept | Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc. | ||||
| code:NDHPractitionerRoleCode |
SΣ | 0..* | CodeableConcept | NDH PractitionerRole Code Binding: PractitionerRole Code Value Set (required) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Individual and Group Specialties (extensible) | ||||
| location |
SΣC | 0..* | Reference(NDH Base Location Profile) | The location(s) at which this practitioner provides care | ||||
| healthcareService |
SC | 0..* | Reference(NDH Base HealthcareService Profile) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
| telecom |
SΣC | 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) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | |||||
| via-intermediary |
0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | |||||
| system |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| allDay |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
| availableStartTime |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
| availableEndTime |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
| notAvailable |
0..* | BackboneElement | Not available during this time due to provided reason | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| description |
1..1 | string | Reason presented to the user explaining why time not available | |||||
| during |
0..1 | Period | Service not available from this date | |||||
| availabilityExceptions |
0..1 | string | Description of availability exceptions | |||||
| endpoint |
SC | 0..* | Reference(NDH Base Endpoint Profile) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| PractitionerRole.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| PractitionerRole.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| PractitionerRole.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| PractitionerRole.code | extensible | CareTeamMemberFunction http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30 | ||||
| PractitionerRole.code:NDHPractitionerRoleCode | required | PractitionerRoleVS (a valid code from Practitioner Role Codes Code System)http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVSfrom this IG | ||||
| PractitionerRole.specialty | extensible | IndividualAndGroupSpecialtiesVShttp://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVSfrom this IG | ||||
| PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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 Serach 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.
The network cardinality sets to 0..1 is to meet the requirements of linking PractitionerRole with a specific time period. The duration a practitioner spends in a network often differs across networks, and it's unusual for these periods to coincide. When a Practitioner is incorporated into a new network, the relevant time frame adheres to that specific network's agreement or contract with the practitioner. The same principle applies when the practitioner departs from the network.
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#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-11-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
