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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: National Directory API Practitioner Profile

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

Usage:

• Refer to this Resource Profile: National Directory API CareTeam Profile and National Directory API PractitionerRole
• Examples for this Resource Profile: Practitioner/PractitionerOneWithNetwork1AndNetwork2 and Practitioner/PractitionerTwoWithNetwork1LeftAfterSixMonths

Formal Views of Profile Content

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

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

This structure is derived from NdhPractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner			NdhPractitioner
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:us-core-race	S	0..1	USCoreRaceExtension(6.1.0)	US Core Race Extension
extension:us-core-ethnicity	S	0..1	USCoreEthnicityExtension(6.1.0)	US Core ethnicity Extension
extension:individual-genderIdentity	S	0..*	PGenderIdentity	The individual's gender identity
extension:individual-pronouns	S	0..*	PPronouns	The pronouns to use when communicating about an individual.
extension:individual-recordedSexOrGender	S	0..*	RecordedSexOrGender	A recorded sex or gender property for the individual
extension:endpoint	S	0..*	EndpointReference	NDH Endpoint Reference
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
extension:accessibility	S	0..*	Accessibility	NDH Accessibility
extension:digitalcertificate	S	0..*	Digitalcertificate	NDH Digitalcertificate
extension:rating	S	0..*	Rating	NDH Rating
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier		1..*	Identifier	An identifier for the person as this agent
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this practitioner's record is in active use
name
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
period	S	0..1	Period	Time period when name was/is in use
telecom
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
type	S	0..1	code	postal | physical | both
text	S	0..1	string	Text representation of the address
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the practitioner was born
photo	S	0..*	Attachment	Image of the person
qualification
Slices for extension				Content/Rules for all slices
extension:practitioner-qualification	S	0..1	PractitionerQualification	NDH Practitioner Qualification
identifier	S	0..*	Identifier	An identifier for this qualification for the practitioner
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification
period	S	0..1	Period	Period during which the qualification is valid
communication	S	0..*	CodeableConcept	A language the practitioner can use in patient communication
Slices for extension				Content/Rules for all slices
extension:communication-proficiency	S	0..1	CommunicationProficiency	NDH Communication Proficiency
coding	S	0..*	Coding	Code defined by a terminology system
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NdhPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
meta	SΣ	0..1	Meta	Metadata about the resource
lastUpdated	Σ	1..1	instant	When the resource version last changed
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
individual-genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individual-pronouns	S	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
individual-recordedSexOrGender	S	0..*	(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	S	0..*	(Complex)	NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
digitalcertificate	S	0..*	(Complex)	NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
rating	S	0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
identifier:NPI	SΣC	0..*	Identifier	An 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
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
active	SΣ	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	?!SΣ	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	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	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)
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
address	SΣ	0..*	Address	Address(es) of the practitioner
Slices for extension				Content/Rules for all slices
geolocation	S	0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	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
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
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)
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the practitioner was born
photo	S	0..*	Attachment	Image of the person
qualification	S	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Slices for extension				Content/Rules for all slices
practitioner-qualification	S	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	S	0..*	Identifier	An identifier for this qualification for the practitioner
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period	S	0..1	Period	Period during which the qualification is valid
issuer	S	0..1	Reference(NDH Base Organization Profile)	Organization that regulates and issues the qualification
communication	S	0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension				Content/Rules for all slices
communication-proficiency	S	0..1	CodeableConcept	NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Language Proficiency Value Set (extensible)
coding	SΣ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Practitioner.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Practitioner.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Practitioner.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Practitioner.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.qualification.code	extensible	IndividualSpecialtyAndDegreeLicenseCertificateVS http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS from this IG
Practitioner.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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)

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NdhPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
individual-genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individual-pronouns	S	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
individual-recordedSexOrGender	S	0..*	(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	S	0..*	(Complex)	NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
digitalcertificate	S	0..*	(Complex)	NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
rating	S	0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
identifier:NPI	SΣC	0..*	Identifier	An 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
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	SΣ	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	?!SΣ	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	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	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
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
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
geolocation	S	0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	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: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
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	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the practitioner was born
photo	S	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
practitioner-qualification	S	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	S	0..*	Identifier	An identifier for this qualification for the practitioner
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period	S	0..1	Period	Period during which the qualification is valid
issuer	S	0..1	Reference(NDH Base Organization Profile)	Organization that regulates and issues the qualification
communication	S	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
communication-proficiency	S	0..1	CodeableConcept	NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Language Proficiency Value Set (extensible)
coding	SΣ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Practitioner.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Practitioner.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Practitioner.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Practitioner.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Practitioner.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.qualification.code	extensible	IndividualSpecialtyAndDegreeLicenseCertificateVS http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS from this IG
Practitioner.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 NdhPractitioner

Summary

Mandatory: 5 elements(5 nested mandatory elements)
Must-Support: 46 elements

Structures

This structure refers to these other structures:

• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)
• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)

Differential View

This structure is derived from NdhPractitioner

Name	Flags	Card.	Type	Description & Constraints
Practitioner			NdhPractitioner
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:us-core-race	S	0..1	USCoreRaceExtension(6.1.0)	US Core Race Extension
extension:us-core-ethnicity	S	0..1	USCoreEthnicityExtension(6.1.0)	US Core ethnicity Extension
extension:individual-genderIdentity	S	0..*	PGenderIdentity	The individual's gender identity
extension:individual-pronouns	S	0..*	PPronouns	The pronouns to use when communicating about an individual.
extension:individual-recordedSexOrGender	S	0..*	RecordedSexOrGender	A recorded sex or gender property for the individual
extension:endpoint	S	0..*	EndpointReference	NDH Endpoint Reference
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
extension:accessibility	S	0..*	Accessibility	NDH Accessibility
extension:digitalcertificate	S	0..*	Digitalcertificate	NDH Digitalcertificate
extension:rating	S	0..*	Rating	NDH Rating
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
identifier		1..*	Identifier	An identifier for the person as this agent
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this practitioner's record is in active use
name
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
period	S	0..1	Period	Time period when name was/is in use
telecom
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system		1..1	code	phone | fax | email | pager | url | sms | other
value		1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
type	S	0..1	code	postal | physical | both
text	S	0..1	string	Text representation of the address
gender	S	0..1	code	male | female | other | unknown
birthDate	S	0..1	date	The date on which the practitioner was born
photo	S	0..*	Attachment	Image of the person
qualification
Slices for extension				Content/Rules for all slices
extension:practitioner-qualification	S	0..1	PractitionerQualification	NDH Practitioner Qualification
identifier	S	0..*	Identifier	An identifier for this qualification for the practitioner
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification
period	S	0..1	Period	Period during which the qualification is valid
communication	S	0..*	CodeableConcept	A language the practitioner can use in patient communication
Slices for extension				Content/Rules for all slices
extension:communication-proficiency	S	0..1	CommunicationProficiency	NDH Communication Proficiency
coding	S	0..*	Coding	Code defined by a terminology system
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NdhPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
meta	SΣ	0..1	Meta	Metadata about the resource
lastUpdated	Σ	1..1	instant	When the resource version last changed
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
individual-genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individual-pronouns	S	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
individual-recordedSexOrGender	S	0..*	(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	S	0..*	(Complex)	NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
digitalcertificate	S	0..*	(Complex)	NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
rating	S	0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
identifier:NPI	SΣC	0..*	Identifier	An 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
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
active	SΣ	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	?!SΣ	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	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	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)
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
address	SΣ	0..*	Address	Address(es) of the practitioner
Slices for extension				Content/Rules for all slices
geolocation	S	0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	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
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
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)
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the practitioner was born
photo	S	0..*	Attachment	Image of the person
qualification	S	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Slices for extension				Content/Rules for all slices
practitioner-qualification	S	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	S	0..*	Identifier	An identifier for this qualification for the practitioner
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period	S	0..1	Period	Period during which the qualification is valid
issuer	S	0..1	Reference(NDH Base Organization Profile)	Organization that regulates and issues the qualification
communication	S	0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for extension				Content/Rules for all slices
communication-proficiency	S	0..1	CodeableConcept	NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Language Proficiency Value Set (extensible)
coding	SΣ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Practitioner.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Practitioner.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Practitioner.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Practitioner.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.qualification.code	extensible	IndividualSpecialtyAndDegreeLicenseCertificateVS http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS from this IG
Practitioner.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	NdhPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
us-core-race	S	0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
us-core-ethnicity	S	0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
individual-genderIdentity	S	0..*	(Complex)	The individual's gender identity URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
individual-pronouns	S	0..*	(Complex)	The pronouns to use when communicating about an individual. URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
individual-recordedSexOrGender	S	0..*	(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	S	0..*	(Complex)	NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
value[x]		1..1	Reference(National Directory API Endpoint Profile)	Value of extension
accessibility	S	0..*	CodeableConcept	NDH Accessibility URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility Binding: Accessibility Value Set (extensible)
digitalcertificate	S	0..*	(Complex)	NDH Digitalcertificate URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
rating	S	0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
identifier:NPI	SΣC	0..*	Identifier	An 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
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	SΣ	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	?!SΣ	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	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	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
contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
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
geolocation	S	0..1	(Complex)	The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation
use	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	SΣ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	SΣ	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: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
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	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date on which the practitioner was born
photo	S	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
practitioner-qualification	S	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	S	0..*	Identifier	An identifier for this qualification for the practitioner
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
code	S	1..1	CodeableConcept	Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible)
period	S	0..1	Period	Period during which the qualification is valid
issuer	S	0..1	Reference(NDH Base Organization Profile)	Organization that regulates and issues the qualification
communication	S	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
communication-proficiency	S	0..1	CodeableConcept	NDH Communication Proficiency URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-communication-proficiency Binding: Language Proficiency Value Set (extensible)
coding	SΣ	0..*	Coding	Code defined by a terminology system
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Practitioner.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Practitioner.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Practitioner.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Practitioner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Practitioner.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Practitioner.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Practitioner.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Practitioner.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Practitioner.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Practitioner.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Practitioner.qualification.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Practitioner.qualification.code	extensible	IndividualSpecialtyAndDegreeLicenseCertificateVS http://hl7.org/fhir/us/ndh/ValueSet/IndividualSpecialtyAndDegreeLicenseCertificateVS from this IG
Practitioner.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 NdhPractitioner

Summary

Mandatory: 5 elements(5 nested mandatory elements)
Must-Support: 46 elements

Structures

This structure refers to these other structures:

• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)
• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)