haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: haau3 Practitioner

A practitioner involved in a care recipient's care. Conforms to US Core 6.1.0 Practitioner; NPI is the anchor for haau3 practitioner identity resolution.

Usages:

• Examples for this Profile: Practitioner/haau3-practitioner

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:NPI	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
Practitioner.Slices for identifier.identifier:NPI.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:NPI.extension		0..*	Extension	Additional content defined by implementations
Practitioner.Slices for identifier.identifier:NPI.use		0..1	code	usual | official | temp | secondary | old (If known)
Practitioner.Slices for identifier.identifier:NPI.type		0..1	CodeableConcept	Description of identifier
Practitioner.Slices for identifier.identifier:NPI.system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
Practitioner.Slices for identifier.identifier:NPI.value		0..1	string	The value that is unique
Practitioner.Slices for identifier.identifier:NPI.period		0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:NPI.assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Practitioner.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Practitioner.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.telecom.system	S This element must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Practitioner.telecom.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Practitioner.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner
Practitioner.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Practitioner.address.line	S This element must be supported. Σ This element is included in summaries.	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
Practitioner.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Practitioner.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Practitioner.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Practitioner.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦6.1.0	US Core v6.1

Constraints

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

This structure is derived from USCorePractitionerProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Practitioner.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Practitioner.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained		0..*	Resource	Contained, inline Resources
Practitioner.extension		0..*	Extension	Additional content defined by implementations
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	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.
Practitioner.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:NPI	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
Practitioner.Slices for identifier.identifier:NPI.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:NPI.extension		0..*	Extension	Additional content defined by implementations
Practitioner.Slices for identifier.identifier:NPI.use		0..1	code	usual | official | temp | secondary | old (If known)
Practitioner.Slices for identifier.identifier:NPI.type		0..1	CodeableConcept	Description of identifier
Practitioner.Slices for identifier.identifier:NPI.system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
Practitioner.Slices for identifier.identifier:NPI.value		0..1	string	The value that is unique
Practitioner.Slices for identifier.identifier:NPI.period		0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:NPI.assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner's record is in active use
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.name.id		0..1	string	Unique id for inter-element referencing
Practitioner.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Practitioner.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Practitioner.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Practitioner.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Practitioner.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.telecom.id		0..1	string	Unique id for inter-element referencing
Practitioner.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.telecom.system	S This element must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Practitioner.telecom.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Practitioner.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Practitioner.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Practitioner.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner
Practitioner.address.id		0..1	string	Unique id for inter-element referencing
Practitioner.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Practitioner.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Practitioner.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Practitioner.address.line	S This element must be supported. Σ This element is included in summaries.	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
Practitioner.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Practitioner.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Practitioner.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Practitioner.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Practitioner.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Practitioner.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Practitioner.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the practitioner was born
Practitioner.photo		0..*	Attachment	Image of the person
Practitioner.qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id		0..1	string	Unique id for inter-element referencing
Practitioner.qualification.extension		0..*	Extension	Additional content defined by implementations
Practitioner.qualification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier		0..*	Identifier	An identifier for this qualification for the practitioner
Practitioner.qualification.code		1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period		0..1	Period	Period during which the qualification is valid
Practitioner.qualification.issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Practitioner.communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Practitioner.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.identifier.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Practitioner.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦6.1.0	US Core v6.1
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	example	v2 table 0360, Version 2.7	📦0360	FHIR Std.
Practitioner.communication	Base	preferred	Common Languages	📦4.0.1	FHIR Std.

Constraints

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

This structure is derived from USCorePractitionerProfile

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:NPI	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
Practitioner.Slices for identifier.identifier:NPI.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:NPI.extension		0..*	Extension	Additional content defined by implementations
Practitioner.Slices for identifier.identifier:NPI.use		0..1	code	usual | official | temp | secondary | old (If known)
Practitioner.Slices for identifier.identifier:NPI.type		0..1	CodeableConcept	Description of identifier
Practitioner.Slices for identifier.identifier:NPI.system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
Practitioner.Slices for identifier.identifier:NPI.value		0..1	string	The value that is unique
Practitioner.Slices for identifier.identifier:NPI.period		0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:NPI.assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Practitioner.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Practitioner.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.telecom.system	S This element must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Practitioner.telecom.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Practitioner.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner
Practitioner.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Practitioner.address.line	S This element must be supported. Σ This element is included in summaries.	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
Practitioner.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Practitioner.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Practitioner.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Practitioner.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦6.1.0	US Core v6.1

Constraints

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

Differential View

This structure is derived from USCorePractitionerProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner		0..*	USCorePractitionerProfile(6.1.0)	A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Practitioner.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Practitioner.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained		0..*	Resource	Contained, inline Resources
Practitioner.extension		0..*	Extension	Additional content defined by implementations
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Practitioner.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	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.
Practitioner.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Practitioner.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.Slices for identifier.identifier:NPI	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following
Practitioner.Slices for identifier.identifier:NPI.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:NPI.extension		0..*	Extension	Additional content defined by implementations
Practitioner.Slices for identifier.identifier:NPI.use		0..1	code	usual | official | temp | secondary | old (If known)
Practitioner.Slices for identifier.identifier:NPI.type		0..1	CodeableConcept	Description of identifier
Practitioner.Slices for identifier.identifier:NPI.system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
Practitioner.Slices for identifier.identifier:NPI.value		0..1	string	The value that is unique
Practitioner.Slices for identifier.identifier:NPI.period		0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:NPI.assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner's record is in active use
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.name.id		0..1	string	Unique id for inter-element referencing
Practitioner.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Practitioner.name.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Practitioner.name.family	S This element must be supported. Σ This element is included in summaries.	1..1	string	Family name (often called 'Surname')
Practitioner.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Practitioner.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Practitioner.telecom	S This element must be supported. Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.telecom.id		0..1	string	Unique id for inter-element referencing
Practitioner.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.telecom.system	S This element must be supported. Σ This element is included in summaries. C	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Practitioner.telecom.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Practitioner.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Practitioner.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Practitioner.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner
Practitioner.address.id		0..1	string	Unique id for inter-element referencing
Practitioner.address.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Practitioner.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Practitioner.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Practitioner.address.line	S This element must be supported. Σ This element is included in summaries.	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
Practitioner.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Practitioner.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Practitioner.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Practitioner.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Practitioner.address.country	S This element must be supported. Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Practitioner.address.period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Practitioner.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the practitioner was born
Practitioner.photo		0..*	Attachment	Image of the person
Practitioner.qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id		0..1	string	Unique id for inter-element referencing
Practitioner.qualification.extension		0..*	Extension	Additional content defined by implementations
Practitioner.qualification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier		0..*	Identifier	An identifier for this qualification for the practitioner
Practitioner.qualification.code		1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period		0..1	Period	Period during which the qualification is valid
Practitioner.qualification.issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Practitioner.communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Practitioner.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.identifier.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Practitioner.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Practitioner.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Practitioner.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Practitioner.address.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Practitioner.address.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Practitioner.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦6.1.0	US Core v6.1
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	example	v2 table 0360, Version 2.7	📦0360	FHIR Std.
Practitioner.communication	Base	preferred	Common Languages	📦4.0.1	FHIR Std.

Constraints

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

This structure is derived from USCorePractitionerProfile

Summary

Other representations of profile: CSV, Excel, Schematron