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
| 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
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this |
![]() ![]() ![]() |
SΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
SΣ | 1..* | LEI | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| 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 |
| 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)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this | |
![]() ![]() ![]() |
S | 1..* | LEI | An identifier for the person as this agent |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this | ||||
![]() ![]() ![]() |
SΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
SΣ | 1..* | LEI | An identifier for the person as this agent | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
![]() ![]() |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Period | Period during which the qualification is valid | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
Documentation for this format | ||||||||
| 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. |
| 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)
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this |
![]() ![]() ![]() |
SΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
SΣ | 1..* | LEI | An identifier for the person as this agent |
![]() ![]() |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
![]() ![]() |
1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this | |
![]() ![]() ![]() |
S | 1..* | LEI | An identifier for the person as this agent |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this, type:$this | ||||
![]() ![]() ![]() |
SΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
SΣ | 1..* | LEI | An identifier for the person as this agent | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
![]() ![]() |
SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Period | Period during which the qualification is valid | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
Documentation for this format | ||||||||
| 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. |
| 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)
|
Other representations of profile: CSV, Excel, Schematron