National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

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

Resource Profile: National Directory API PractitionerRole

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-PractitionerRole Version: 1.0.0-ballot
Active as of 2024-06-17 Computable Name: NdhNdApiPractitionerRole

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

Usage:

Formal Views of Profile Content

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

This structure is derived from NdhPractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole NdhPractitionerRole
... meta S 0..1 Meta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:rating S 0..* Rating NDH Rating
.... extension:newpatients S 0..* NewPatients NDH New Patients
.... extension:network S 0..1 NetworkReference NDH Network Reference
..... value[x] 1..1 Reference(National Directory API Network Profile) Value of extension
.... extension:digitalcertificate S 0..* Digitalcertificate NDH Digitalcertificate
.... extension:qualification S 0..* Qualification NDH Qualification
.... extension:verification-status S 1..1 VerificationStatus NDH Verification Status
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:identifier-status S 1..1 IdentifierStatus NDH Identifier Status
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... assigner S 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this practitioner role record is in active use
... period S 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization 0..1 Reference(National Directory API Organization Profile) Organization where the role is available
... location 0..* Reference(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(National Directory API HealthcareService Profile) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* ContactPointAvailableTime NDH Contactpoint Availabletime
..... extension:via-intermediary S 0..1 ViaIntermediary NDH Via Intermediary
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
... availableTime S 0..* BackboneElement Times the Service Site is available
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... endpoint 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* NdhPractitionerRole 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
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... rating S 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
.... newpatients SC 0..* (Complex) NDH 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 S 0..1 (Complex) NDH Network Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
..... value[x] S 1..1 Reference(National Directory API Network Profile) Value of extension
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... digitalcertificate S 0..* (Complex) NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
.... qualification S 0..* (Complex) NDH Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
.... verification-status S 1..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 SΣ 0..* Identifier Business Identifiers that are specific to a role/location
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... identifier-status S 1..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner role record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(National Directory API 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(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService SC 0..* Reference(National Directory API 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 S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) NDH 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 SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
... availableTime S 0..* BackboneElement Times the Service Site is available
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... endpoint SC 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.code:NDHPractitionerRoleCoderequiredPractitionerRoleVS (a valid code from Practitioner Role Codes Code System)
http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS
from this IG
PractitionerRole.specialtyextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* NdhPractitionerRole 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 SΣ 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 Σ 1..1 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... rating S 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
.... newpatients SC 0..* (Complex) NDH 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 S 0..1 (Complex) NDH Network Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
..... value[x] S 1..1 Reference(National Directory API Network Profile) Value of extension
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... digitalcertificate S 0..* (Complex) NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
.... qualification S 0..* (Complex) NDH Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
.... verification-status S 1..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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... identifier-status S 1..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner role record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(National Directory API 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(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService SC 0..* Reference(National Directory API 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 S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) NDH 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 SΣ 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 S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 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 S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint SC 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.code:NDHPractitionerRoleCoderequiredPractitionerRoleVS (a valid code from Practitioner Role Codes Code System)
http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS
from this IG
PractitionerRole.specialtyextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Differential View

This structure is derived from NdhPractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole NdhPractitionerRole
... meta S 0..1 Meta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:rating S 0..* Rating NDH Rating
.... extension:newpatients S 0..* NewPatients NDH New Patients
.... extension:network S 0..1 NetworkReference NDH Network Reference
..... value[x] 1..1 Reference(National Directory API Network Profile) Value of extension
.... extension:digitalcertificate S 0..* Digitalcertificate NDH Digitalcertificate
.... extension:qualification S 0..* Qualification NDH Qualification
.... extension:verification-status S 1..1 VerificationStatus NDH Verification Status
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:identifier-status S 1..1 IdentifierStatus NDH Identifier Status
.... use S 0..1 code usual | official | temp | secondary | old (If known)
.... type S 0..1 CodeableConcept Description of identifier
.... system S 0..1 uri The namespace for the identifier value
.... value S 0..1 string The value that is unique
.... assigner S 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this practitioner role record is in active use
... period S 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization 0..1 Reference(National Directory API Organization Profile) Organization where the role is available
... location 0..* Reference(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService 0..* Reference(National Directory API HealthcareService Profile) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* ContactPointAvailableTime NDH Contactpoint Availabletime
..... extension:via-intermediary S 0..1 ViaIntermediary NDH Via Intermediary
.... rank S 0..1 positiveInt Specify preferred order of use (1 = highest)
... availableTime S 0..* BackboneElement Times the Service Site is available
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... endpoint 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* NdhPractitionerRole 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
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... rating S 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
.... newpatients SC 0..* (Complex) NDH 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 S 0..1 (Complex) NDH Network Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
..... value[x] S 1..1 Reference(National Directory API Network Profile) Value of extension
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... digitalcertificate S 0..* (Complex) NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
.... qualification S 0..* (Complex) NDH Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
.... verification-status S 1..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 SΣ 0..* Identifier Business Identifiers that are specific to a role/location
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... identifier-status S 1..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner role record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(National Directory API 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(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService SC 0..* Reference(National Directory API 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 S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) NDH 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 SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
... availableTime S 0..* BackboneElement Times the Service Site is available
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... endpoint SC 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.code:NDHPractitionerRoleCoderequiredPractitionerRoleVS (a valid code from Practitioner Role Codes Code System)
http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS
from this IG
PractitionerRole.specialtyextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* NdhPractitionerRole 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 SΣ 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 Σ 1..1 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... rating S 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
.... newpatients SC 0..* (Complex) NDH 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 S 0..1 (Complex) NDH Network Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
..... value[x] S 1..1 Reference(National Directory API Network Profile) Value of extension
.... usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
.... digitalcertificate S 0..* (Complex) NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
.... qualification S 0..* (Complex) NDH Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
.... verification-status S 1..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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... identifier-status S 1..1 code NDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner role record is in active use
Required Pattern: true
... period SΣ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣC 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
... organization SΣC 0..1 Reference(National Directory API 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(National Directory API Location Profile) The location(s) at which this practitioner provides care
... healthcareService SC 0..* Reference(National Directory API 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 S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S 0..1 Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) NDH 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 SΣ 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 S 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 S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay S 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable S 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 S 1..1 string Reason presented to the user explaining why time not available
.... during S 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint SC 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30
PractitionerRole.code:NDHPractitionerRoleCoderequiredPractitionerRoleVS (a valid code from Practitioner Role Codes Code System)
http://hl7.org/fhir/us/ndh/ValueSet/PractitionerRoleVS
from this IG
PractitionerRole.specialtyextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron