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 Practitioner Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Practitioner Version: 1.0.0-ballot
Active as of 2024-03-28 Computable Name: NdhNdApiPractitioner

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

Usage:

Formal Views of Profile Content

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

This structure is derived from NdhPractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner NdhPractitioner
... meta S0..1MetaMetadata about the resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:us-core-race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:individual-genderIdentity S0..*PGenderIdentityThe individual's gender identity
... extension:individual-pronouns S0..*PPronounsThe pronouns to use when communicating about an individual.
... extension:individual-recordedSexOrGender S0..*RecordedSexOrGenderA recorded sex or gender property for the individual
... extension:endpoint S0..*EndpointReferenceNDH Endpoint Reference
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... extension:accessibility S0..*AccessibilityNDH Accessibility
... extension:digitalcertificate S0..*DigitalcertificateNDH Digitalcertificate
... extension:rating S0..*RatingNDH Rating
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier 1..*IdentifierAn identifier for the person as this agent
.... extension 1..*ExtensionExtension
.... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... active S1..1booleanWhether this practitioner's record is in active use
... name
.... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix S0..*stringParts that come before the name
.... suffix S0..*stringParts that come after the name
.... period S0..1PeriodTime period when name was/is in use
... telecom
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... address
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... text S0..1stringText representation of the address
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification
.... extension:practitioner-qualification S0..1PractitionerQualificationNDH Practitioner Qualification
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... extension 1..*ExtensionExtension
..... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
..... use S0..1codeusual | official | temp | secondary | old (If known)
..... type S0..1CodeableConceptDescription of identifier
..... system S0..1uriThe namespace for the identifier value
..... value S0..1stringThe value that is unique
..... period S0..1PeriodTime period when id is/was valid for use
..... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
.... extension:communication-proficiency S0..1CommunicationProficiencyNDH Communication Proficiency
.... coding S0..*CodingCode defined by a terminology system
.... text S0..1stringPlain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*NdhPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... meta SΣ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... individual-genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... individual-pronouns S0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... individual-recordedSexOrGender S0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... digitalcertificate S0..*(Complex)NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... rating S0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..*IdentifierAn identifier for the person as this agent
us-core-16: NPI must be 10 digits
us-core-17: NPI check digit must be valid (Luhn algorithm check)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... active SΣ1..1booleanWhether this practitioner's record is in active use
Required Pattern: true
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... address SΣ0..*AddressAddress(es) of the practitioner
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... practitioner-qualification S0..1(Complex)NDH Practitioner Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(NDH Base Organization Profile)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

.... communication-proficiency S0..1CodeableConceptNDH Communication Proficiency
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency
Binding: Language Proficiency Value Set (extensible)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.qualification.codeextensibleIndividualSpecialtyAndDegreeLicenseCertificateVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS
from this IG
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
us-core-16errorPractitioner.identifier:NPINPI must be 10 digits
: value.matches('^[0-9]{10}$')
us-core-17errorPractitioner.identifier:NPINPI 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)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*NdhPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... individual-genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... individual-pronouns S0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... individual-recordedSexOrGender S0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... digitalcertificate S0..*(Complex)NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... rating S0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..*IdentifierAn identifier for the person as this agent
us-core-16: NPI must be 10 digits
us-core-17: NPI check digit must be valid (Luhn algorithm check)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
Required Pattern: true
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)NDH Practitioner Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(NDH Base Organization Profile)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... communication-proficiency S0..1CodeableConceptNDH Communication Proficiency
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency
Binding: Language Proficiency Value Set (extensible)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.qualification.codeextensibleIndividualSpecialtyAndDegreeLicenseCertificateVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS
from this IG
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
us-core-16errorPractitioner.identifier:NPINPI must be 10 digits
: value.matches('^[0-9]{10}$')
us-core-17errorPractitioner.identifier:NPINPI 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 NdhPractitioner

Differential View

This structure is derived from NdhPractitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner NdhPractitioner
... meta S0..1MetaMetadata about the resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:us-core-race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:individual-genderIdentity S0..*PGenderIdentityThe individual's gender identity
... extension:individual-pronouns S0..*PPronounsThe pronouns to use when communicating about an individual.
... extension:individual-recordedSexOrGender S0..*RecordedSexOrGenderA recorded sex or gender property for the individual
... extension:endpoint S0..*EndpointReferenceNDH Endpoint Reference
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... extension:accessibility S0..*AccessibilityNDH Accessibility
... extension:digitalcertificate S0..*DigitalcertificateNDH Digitalcertificate
... extension:rating S0..*RatingNDH Rating
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier 1..*IdentifierAn identifier for the person as this agent
.... extension 1..*ExtensionExtension
.... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... active S1..1booleanWhether this practitioner's record is in active use
... name
.... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
.... given S1..*stringGiven names (not always 'first'). Includes middle names
.... prefix S0..*stringParts that come before the name
.... suffix S0..*stringParts that come after the name
.... period S0..1PeriodTime period when name was/is in use
... telecom
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system 1..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... address
.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... type S0..1codepostal | physical | both
.... text S0..1stringText representation of the address
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification
.... extension:practitioner-qualification S0..1PractitionerQualificationNDH Practitioner Qualification
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... extension 1..*ExtensionExtension
..... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
..... use S0..1codeusual | official | temp | secondary | old (If known)
..... type S0..1CodeableConceptDescription of identifier
..... system S0..1uriThe namespace for the identifier value
..... value S0..1stringThe value that is unique
..... period S0..1PeriodTime period when id is/was valid for use
..... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
.... period S0..1PeriodPeriod during which the qualification is valid
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
.... extension:communication-proficiency S0..1CommunicationProficiencyNDH Communication Proficiency
.... coding S0..*CodingCode defined by a terminology system
.... text S0..1stringPlain text representation of the concept

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*NdhPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... meta SΣ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... individual-genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... individual-pronouns S0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... individual-recordedSexOrGender S0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... digitalcertificate S0..*(Complex)NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... rating S0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..*IdentifierAn identifier for the person as this agent
us-core-16: NPI must be 10 digits
us-core-17: NPI check digit must be valid (Luhn algorithm check)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... active SΣ1..1booleanWhether this practitioner's record is in active use
Required Pattern: true
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... address SΣ0..*AddressAddress(es) of the practitioner
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... practitioner-qualification S0..1(Complex)NDH Practitioner Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(NDH Base Organization Profile)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

.... communication-proficiency S0..1CodeableConceptNDH Communication Proficiency
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency
Binding: Language Proficiency Value Set (extensible)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.qualification.codeextensibleIndividualSpecialtyAndDegreeLicenseCertificateVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS
from this IG
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
us-core-16errorPractitioner.identifier:NPINPI must be 10 digits
: value.matches('^[0-9]{10}$')
us-core-17errorPractitioner.identifier:NPINPI 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)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*NdhPractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... individual-genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... individual-pronouns S0..*(Complex)The pronouns to use when communicating about an individual.
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
... individual-recordedSexOrGender S0..*(Complex)A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... accessibility S0..*CodeableConceptNDH Accessibility
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility
Binding: Accessibility Value Set (extensible)
... digitalcertificate S0..*(Complex)NDH Digitalcertificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... rating S0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..*IdentifierAn identifier for the person as this agent
us-core-16: NPI must be 10 digits
us-core-17: NPI check digit must be valid (Luhn algorithm check)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
Required Pattern: true
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)NDH Practitioner Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S0..1Reference(NDH Base Organization Profile)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... communication-proficiency S0..1CodeableConceptNDH Communication Proficiency
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency
Binding: Language Proficiency Value Set (extensible)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.qualification.codeextensibleIndividualSpecialtyAndDegreeLicenseCertificateVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS
from this IG
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
us-core-16errorPractitioner.identifier:NPINPI must be 10 digits
: value.matches('^[0-9]{10}$')
us-core-17errorPractitioner.identifier:NPINPI 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 NdhPractitioner

 

Other representations of profile: CSV, Excel, Schematron