National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 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 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
Standards status: Trial-use Computable Name: NdhNdApiPractitionerRole

PractitionerRole 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole C 0..* NdhPractitionerRole Roles/organizations the practitioner is associated with
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:rating S 0..* (Complex) NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:newpatients SC 0..* (Complex) NDH New Patients
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
.... extension:network S 0..1 (Complex) NDH Network Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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
ele-1: All FHIR elements must have a @value or children
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:digitalcertificate S 0..* (Complex) NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:qualification S 0..* (Complex) NDH Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier Business Identifiers that are specific to a role/location
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... 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.


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... active SΣ 1..1 boolean Whether this practitioner role record is in active use
ele-1: All FHIR elements must have a @value or children
Required Pattern: true
... period SΣ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
ele-1: All FHIR elements must have a @value or children
... practitioner SΣC 0..1 Reference(National Directory API Practitioner Profile) Practitioner that is able to provide the defined services for the organization
ele-1: All FHIR elements must have a @value or children
... organization SΣC 0..1 Reference(National Directory API Organization Profile) Organization where the role is available
ele-1: All FHIR elements must have a @value or children
... Slices for code SΣ 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by value:$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.


ele-1: All FHIR elements must have a @value or children
.... code:NDHPractitionerRoleCode SΣ 0..* CodeableConcept NDH PractitionerRole Code
Binding: PractitionerRole Code Value Set (required)
ele-1: All FHIR elements must have a @value or children
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: Individual and Group Specialties (extensible)
ele-1: All FHIR elements must have a @value or children
... location SΣC 0..* Reference(National Directory API Location Profile) The location(s) at which this practitioner provides care
ele-1: All FHIR elements must have a @value or children
... 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)
ele-1: All FHIR elements must have a @value or children
... telecom SΣC 0..* ContactPoint Contact details that are specific to the role/location/service
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
... availableTime S 0..* BackboneElement Times the Service Site is available
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... daysOfWeek S 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


ele-1: All FHIR elements must have a @value or children
.... allDay S 0..1 boolean Always available? e.g. 24 hour service
ele-1: All FHIR elements must have a @value or children
.... availableStartTime S 0..1 time Opening time of day (ignored if allDay = true)
ele-1: All FHIR elements must have a @value or children
.... availableEndTime S 0..1 time Closing time of day (ignored if allDay = true)
ele-1: All FHIR elements must have a @value or children
... notAvailable S 0..* BackboneElement Not available during this time due to provided reason
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... description S 1..1 string Reason presented to the user explaining why time not available
ele-1: All FHIR elements must have a @value or children
.... during S 0..1 Period Service not available from this date
ele-1: All FHIR elements must have a @value or children
... endpoint SC 0..* Reference(National Directory API Endpoint Profile) Technical endpoints providing access to services operated for the practitioner with this role
ele-1: All FHIR elements must have a @value or children

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

 

Other representations of profile: CSV, Excel, Schematron