National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

## Resource Profile: NDH Practitioner Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner | Version: 2.0.0-current
Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhPractitioner

Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

Usages:

- Refer to this Profile: NDH Group, NDH PractitionerRole and NDH Verification
- Examples for this Profile: Practitioner/HansSolo, Practitioner/JoeSmith, Practitioner/PractitionerOneWithNetwork1AndNetwork2 and Practitioner/PractitionerTwoWithNetwork1LeftAfterSixMonths
- CapabilityStatements using this Profile: NDH Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
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
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name | S Σ | 1..* | HumanName | The name(s) associated with the practitioner
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
telecom | S Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..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.
address | S Σ | 0..* | Address | Address(es) of the practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Practitioner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Practitioner | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Practitioner | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits | `value.matches('^[0-9]{10}$')`
us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) | `(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`

This structure is derived from USCorePractitionerProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:individual-genderIdentity |  | 0..0 | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individual-pronouns |  | 0..0 | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:individual-recordedSexOrGender |  | 0..0 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
identifier |  | 1..* | Identifier | An identifier for the person as this agent
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active |  | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name |  |  |  |
text | S | 0..1 | string | Text representation of the full name
telecom |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
address |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
identifier |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
communication |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:communication-proficiency |  | 0..1 | CodeableConcept | NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Interagency Language Roundtable Speaking Skill Scale (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name | S Σ | 1..* | HumanName | The name(s) associated with the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..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
address | S Σ | 0..* | Address | Address(es) of the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date on which the practitioner was born
photo |  | 0..* | Attachment | Image of the person
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier |  | 0..* | Identifier | An identifier for this qualification for the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period |  | 0..1 | Period | Period during which the qualification is valid
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
communication |  | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:communication-proficiency |  | 0..1 | CodeableConcept | NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Interagency Language Roundtable Speaking Skill Scale (extensible)
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Practitioner.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Practitioner.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Practitioner.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Practitioner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.identifier.​type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG
Practitioner.communication | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Practitioner | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Practitioner | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits | `value.matches('^[0-9]{10}$')`
us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) | `(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/core/StructureDefinition/us-core-race|6.1.0
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity|6.1.0
- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender|5.2.0
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/StructureDefinition/geolocation|4.0.1
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
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
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name | S Σ | 1..* | HumanName | The name(s) associated with the practitioner
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
telecom | S Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..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.
address | S Σ | 0..* | Address | Address(es) of the practitioner
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Practitioner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Practitioner | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Practitioner | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits | `value.matches('^[0-9]{10}$')`
us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) | `(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`

Differential View

This structure is derived from USCorePractitionerProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:individual-genderIdentity |  | 0..0 | (Complex) | The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
extension:individual-pronouns |  | 0..0 | (Complex) | The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
extension:individual-recordedSexOrGender |  | 0..0 | (Complex) | A recorded sex or gender property for the individual URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
identifier |  | 1..* | Identifier | An identifier for the person as this agent
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active |  | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name |  |  |  |
text | S | 0..1 | string | Text representation of the full name
telecom |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
address |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
state |  | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
identifier |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
communication |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:communication-proficiency |  | 0..1 | CodeableConcept | NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Interagency Language Roundtable Speaking Skill Scale (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Practitioner |  | 0..* | USCorePractitionerProfile(6.1.0) | A person with a formal responsibility in the provisioning of healthcare or related services
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:us-core-race |  | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:us-core-ethnicity |  | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:endpoint |  | 0..* | Reference(NDH Endpoint Profile) | Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension:accessibility |  | 0..* | CodeableConcept | Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
extension:rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
extension:aligned-with-cms-data-network |  | 0..1 | boolean | Aligned with CMS Data Network URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
extension:verification-status |  | 0..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
identifier:NPI | S Σ C | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
use |  | 0..1 | code | usual | official | temp | secondary | old (If known)
type |  | 0..1 | CodeableConcept | Description of identifier
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value |  | 0..1 | string | The value that is unique
period |  | 0..1 | Period | Time period when id is/was valid for use
assigner |  | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
active | Σ | 1..1 | boolean | Whether this practitioner's record is in active use Required Pattern: true
name | S Σ | 1..* | HumanName | The name(s) associated with the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime |  | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system | S Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 0..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
address | S Σ | 0..* | Address | Address(es) of the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:geolocation | S | 0..1 | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | S Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date on which the practitioner was born
photo |  | 0..* | Attachment | Image of the person
qualification | S | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:practitioner-qualification |  | 0..1 | (Complex) | NDH Practitioner Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier |  | 0..* | Identifier | An identifier for this qualification for the practitioner
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period |  | 0..1 | Period | Period during which the qualification is valid
issuer | S | 0..1 | Reference(NDH Organization Profile) | Organization that regulates and issues the qualification
communication |  | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:communication-proficiency |  | 0..1 | CodeableConcept | NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Interagency Language Roundtable Speaking Skill Scale (extensible)
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Practitioner.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
Practitioner.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
Practitioner.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.
Practitioner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.identifier.​type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std.
Practitioner.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
Practitioner.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Practitioner.address.​type | Base | required | AddressType | 📍4.0.1 | FHIR Std.
Practitioner.address.​state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1
Practitioner.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
Practitioner.qualification.​code | Base | extensible | Individual Specialties, Degrees, Licenses, and Certificates Value Set | 📦2.0.0-current | This IG
Practitioner.communication | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Practitioner | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Practitioner | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
us-core-16 | error | Practitioner.identifier:NPI | NPI must be 10 digits | `value.matches('^[0-9]{10}$')`
us-core-17 | error | Practitioner.identifier:NPI | NPI check digit must be valid (Luhn algorithm check) | `(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)`

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 4 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/core/StructureDefinition/us-core-race|6.1.0
- http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity|6.1.0
- http://hl7.org/fhir/StructureDefinition/individual-genderIdentity|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-pronouns|5.2.0
- http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender|5.2.0
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-aligned-with-cms-data-network
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/StructureDefinition/geolocation|4.0.1
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

SearchParameter Name | Type | Example
--- | --- | ---
qualification-issuer | reference | `GET [base]/Practitioner?qualification-issuer.name=Florida License Board`
qualification-code | token | `GET [base]/Practitioner?qualification-code=MD`
endpoint | reference | `GET [base]/Practitioner?endpoint.identifier={system}|{value}`
verification-status | token | `GET [base]/Practitioner?verification-status=complete`

#### Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

- Search Parameter Registry
- Practitioner Search Parameter from Registry

SearchParameter Name | Type | Example
--- | --- | ---
active | token | `GET [base]/Practitioner?active=true`
name | string | `GET [base]/Practitioner?name=Joe Smith`
gender | token | `GET [base]/Practitioner?gender=male`
identifier | token | `GET [base]/Practitioner?identifier=12345678`

#### _include Search Parameter

_include | Example
--- | ---
Practitioner:endpoint | `GET [base]/Practitioner?_include= Practitioner:endpoint`
Practitioner:qualification-issuer | `GET [base]/Practitioner?_include=Practitioner:qualification-issuer`

#### _revinclude Search Parameter

_revinclude
PractitionerRole:practitioner