Interoperable Digital Identity and Patient Matching
3.0.0-current - STU 3 United States of America flag

Interoperable Digital Identity and Patient Matching, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 3.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-identity-matching-ig/ and changes regularly. See the Directory of published versions

Resource Profile: A Practitioner resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI)

Official URL: http://hl7.org/fhir/us/identity-matching/StructureDefinition/PractitionerLei Version: 3.0.0-current
Standards status: Trial-use Maturity Level: 2 Computable Name: PractitionerLei
Other Identifiers: OID:2.16.840.1.113883.4.642.40.81.42.8

A Practitioner resource that includes an Identifier with a value that is a Legal Entity Identifier (LEI), and may carry the verified LEI (vLEI). This profile is used to represent a practitioner who has a legal entity identifier, which is typically used for individuals who are associated with legal entities in financial transactions. The profile includes an extension for the verified LEI (vLEI) to indicate that the LEI has been verified and is valid.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile 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 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, type:$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:NPI 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:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Practitioner.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI An identifier for the person as this agent
Practitioner.name 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 This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.telecom 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 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 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 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 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 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 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 This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Practitioner.address.country 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.Slices for identifier 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this, type:$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:lei This element must be supported. 1..* LEI An identifier for the person as this agent

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile 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 BindingsPurpose
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 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, type:$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:NPI 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:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Practitioner.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name 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 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 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 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 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 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 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 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 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 This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Practitioner.address.country 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 BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📦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
us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Practitioner.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile 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 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, type:$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:NPI 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:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Practitioner.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI An identifier for the person as this agent
Practitioner.name 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 This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
Practitioner.telecom 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 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 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 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 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 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 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 This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Practitioner.address.country 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)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile A person with a formal responsibility in the provisioning of healthcare or related services
Practitioner.Slices for identifier 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this, type:$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:lei This element must be supported. 1..* LEI An identifier for the person as this agent

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner 0..* USCorePractitionerProfile 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 BindingsPurpose
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 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, type:$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:NPI 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:
{
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
Practitioner.Slices for identifier.identifier:lei This element must be supported. This element is included in summaries. 1..* LEI An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name 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 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 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 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 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 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 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 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 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 This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Practitioner.address.country 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 BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📦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
us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Practitioner.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron