US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot
US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot
US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-quality-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-practitioner | Version: 1.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USQualityCorePractitioner | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.40 | |||||
Profile of Practitioner for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.
The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.
USCDI+ Quality Elements:
| Profile element | Description | USCDI+ Quality Data Element(s) |
|---|---|---|
address |
Address(es) of the practitioner | Care Team Members: Care Team Member Location |
address.city |
Name of city, town etc. | Care Team Members: Care Team Member Location |
address.country |
Country (e.g. can be ISO 3166 2 or 3 letter code) | Care Team Members: Care Team Member Location |
address.line |
Street name, number, direction & P.O. Box etc. | Care Team Members: Care Team Member Location |
address.postalCode |
US Zip Codes | Care Team Members: Care Team Member Location |
address.state |
Sub-unit of country (abbreviations ok) | Care Team Members: Care Team Member Location |
identifier |
An identifier for the person as this agent | Care Team Members: Care Team Member Identifier |
identifier.system |
The namespace for the identifier value | Care Team Members: Care Team Member Identifier |
identifier.value |
The value that is unique | Care Team Members: Care Team Member Identifier |
identifier:NPI |
An identifier for the person as this agent | Care Team Members: Care Team Member Identifier |
identifier:NPI.system |
The namespace for the identifier value | Care Team Members: Care Team Member Identifier |
identifier:NPI.value |
The value that is unique | Care Team Members: Care Team Member Identifier |
identifier:ein |
There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. | Care Team Members: Care Team Member Identifier |
identifier:ein.value |
The value that is unique | Care Team Members: Care Team Member Identifier |
name |
The name(s) associated with the practitioner | Care Team Members: Care Team Member Name |
name.family |
Family name (often called 'Surname') | Care Team Members: Care Team Member Name |
telecom |
A contact detail for the practitioner (that apply to all roles) | Care Team Members: Care Team Member Telecom |
telecom.system |
phone | fax | email | pager | url | sms | other | Care Team Members: Care Team Member Telecom |
telecom.value |
The actual contact point details | Care Team Members: Care Team Member Telecom |
Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core Practitioner Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.
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:   |
|---|---|---|---|---|
  Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier |
SΣ | 1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Slice: Unordered, Open by value:$this |
   identifier:All Slices |
Content/Rules for all slices | |||
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
 identifier:NPI |
SΣC | 0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
 value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
| identifier:NCSBNID |
ΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-27 Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/NCSBNID |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:ein |
SΣ | 0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
 system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| value |
Σ | 0..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
| name |
SΣ | 1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
 family |
SΣ | 1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') |
| telecom |
SΣ | 0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) |
| system |
SΣC | 0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 0..1 | string | (USCDI+ Quality) The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
 address |
SΣ | 0..* | Address | (USCDI+ Quality) Address(es) of the practitioner |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..4 | string | (USCDI+ Quality) 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 Example US Core: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | (USCDI+ Quality) Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN |
| state |
SΣ | 0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK |
| postalCode |
SΣ | 0..1 | string | (USCDI+ Quality) US Zip Codes Example General: 9132 Example US Core: 74047 |
| country |
SΣ | 0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.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 | 📦2.0.0 | THO v7.2 |
| 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)
|
| us-core-27 | error | Practitioner.identifier:NCSBNID | The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters |
value.matches('^[0-8]{8}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |
| identifier |
1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent | |
| system |
1..1 | uri | (USCDI+ Quality) The namespace for the identifier value | |
| value |
1..1 | string | (USCDI+ Quality) The value that is unique | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:NPI |
0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent | |
| system |
1..1 | uri | (USCDI+ Quality) The namespace for the identifier value | |
| value |
1..1 | string | (USCDI+ Quality) The value that is unique | |
| identifier:ein |
0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| value |
0..1 | string | (USCDI+ Quality) The value that is unique | |
| name |
1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner | |
| family |
1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') | |
| telecom |
0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) | |
| system |
0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other | |
| value |
0..1 | string | (USCDI+ Quality) The actual contact point details | |
| address |
0..* | Address | (USCDI+ Quality) Address(es) of the practitioner | |
| line |
0..4 | string | (USCDI+ Quality) Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | (USCDI+ Quality) Name of city, town etc. | |
| state |
0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) | |
| postalCode |
0..1 | string | (USCDI+ Quality) US Zip Codes | |
| country |
0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Slice: Unordered, Open by value:$this | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI |
SΣC | 0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | ||||
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NCSBNID |
ΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-27 Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/NCSBNID | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:ein |
SΣ | 0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | ||||
| value |
Σ | 0..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') | ||||
| given |
Σ | 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 | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 0..1 | string | (USCDI+ Quality) The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address |
SΣ | 0..* | Address | (USCDI+ Quality) Address(es) of the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
SΣ | 0..4 | string | (USCDI+ Quality) 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 Example US Core: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | (USCDI+ Quality) Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK | ||||
| postalCode |
SΣ | 0..1 | string | (USCDI+ Quality) US Zip Codes Example General: 9132 Example US Core: 74047 | ||||
| country |
SΣ | 0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| 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. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
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.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.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 | 📦2.0.0 | THO v7.2 |
| 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 |
| 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)
|
| us-core-27 | error | Practitioner.identifier:NCSBNID | The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters |
value.matches('^[0-8]{8}$')
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Slice: Unordered, Open by value:$this |
| identifier:All Slices |
Content/Rules for all slices | |||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
| identifier:NPI |
SΣC | 0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
| identifier:NCSBNID |
ΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-27 Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/NCSBNID |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:ein |
SΣ | 0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| type |
0..1 | CodeableConcept | Description of identifier | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
| period |
0..1 | Period | Time period when id is/was valid for use | |
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| value |
Σ | 0..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 |
| name |
SΣ | 1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner |
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family |
SΣ | 1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') |
| telecom |
SΣ | 0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) |
| system |
SΣC | 0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value |
SΣ | 0..1 | string | (USCDI+ Quality) The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address |
SΣ | 0..* | Address | (USCDI+ Quality) Address(es) of the practitioner |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line |
SΣ | 0..4 | string | (USCDI+ Quality) 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 Example US Core: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | (USCDI+ Quality) Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN |
| state |
SΣ | 0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK |
| postalCode |
SΣ | 0..1 | string | (USCDI+ Quality) US Zip Codes Example General: 9132 Example US Core: 74047 |
| country |
SΣ | 0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Practitioner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.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 | 📦2.0.0 | THO v7.2 |
| 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)
|
| us-core-27 | error | Practitioner.identifier:NCSBNID | The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters |
value.matches('^[0-8]{8}$')
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |
| identifier |
1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent | |
| system |
1..1 | uri | (USCDI+ Quality) The namespace for the identifier value | |
| value |
1..1 | string | (USCDI+ Quality) The value that is unique | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:NPI |
0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent | |
| system |
1..1 | uri | (USCDI+ Quality) The namespace for the identifier value | |
| value |
1..1 | string | (USCDI+ Quality) The value that is unique | |
| identifier:ein |
0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | |
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| value |
0..1 | string | (USCDI+ Quality) The value that is unique | |
| name |
1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner | |
| family |
1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') | |
| telecom |
0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) | |
| system |
0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other | |
| value |
0..1 | string | (USCDI+ Quality) The actual contact point details | |
| address |
0..* | Address | (USCDI+ Quality) Address(es) of the practitioner | |
| line |
0..4 | string | (USCDI+ Quality) Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | (USCDI+ Quality) Name of city, town etc. | |
| state |
0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) | |
| postalCode |
0..1 | string | (USCDI+ Quality) US Zip Codes | |
| country |
0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner |
0..* | USCorePractitionerProfile(9.0.0) | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Slice: Unordered, Open by value:$this | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI |
SΣC | 0..* | Identifier | (USCDI+ Quality) An identifier for the person as this agent Constraints: us-core-16, us-core-17 Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | (USCDI+ Quality) The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | ||||
| value |
SΣ | 1..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NCSBNID |
ΣC | 0..* | Identifier | An identifier for the person as this agent Constraints: us-core-27 Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/NCSBNID | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:ein |
SΣ | 0..1 | Identifier | (USCDI+ Quality) There is not a general Tax Identifier Numer (TIN) OID. There is an SSN, a PTIN, and an ITIN, but no TIN generally. So the only slice specified here is EIN, if consumers determine a need for an SSN, submit a comment to that effect. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | ||||
| value |
Σ | 0..1 | string | (USCDI+ Quality) The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name |
SΣ | 1..* | HumanName | (USCDI+ Quality) The name(s) associated with the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text |
Σ | 0..1 | string | Text representation of the full name | ||||
| family |
SΣ | 1..1 | string | (USCDI+ Quality) Family name (often called 'Surname') | ||||
| given |
Σ | 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 | ||||
| prefix |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom |
SΣ | 0..* | ContactPoint | (USCDI+ Quality) A contact detail for the practitioner (that apply to all roles) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
SΣC | 0..1 | code | (USCDI+ Quality) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value |
SΣ | 0..1 | string | (USCDI+ Quality) The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address |
SΣ | 0..* | Address | (USCDI+ Quality) Address(es) of the practitioner | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line |
SΣ | 0..4 | string | (USCDI+ Quality) 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 Example US Core: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | (USCDI+ Quality) Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | ||||
| district |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state |
SΣ | 0..1 | string | (USCDI+ Quality) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK | ||||
| postalCode |
SΣ | 0..1 | string | (USCDI+ Quality) US Zip Codes Example General: 9132 Example US Core: 74047 | ||||
| country |
SΣ | 0..1 | string | (USCDI+ Quality) Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo |
0..* | Attachment | Image of the person | |||||
| qualification |
0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| 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. | |||||
| period |
0..1 | Period | Period during which the qualification is valid | |||||
| issuer |
0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication |
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.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NPI.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:NCSBNID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Practitioner.identifier:ein.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 | 📦2.0.0 | THO v7.2 |
| 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 |
| 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)
|
| us-core-27 | error | Practitioner.identifier:NCSBNID | The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters |
value.matches('^[0-8]{8}$')
|
Other representations of profile: CSV, Excel, Schematron
Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.
| Profile element | FHIR | US Core | US Quality Core |
|---|---|---|---|
identifier |
Mandatory Must Support | USCDI+ Quality | |
identifier.system |
Mandatory Must Support | USCDI+ Quality | |
identifier.value |
Mandatory Must Support | USCDI+ Quality | |
identifier:NPI |
Must Support | USCDI+ Quality | |
identifier:NPI.system |
Mandatory Must Support | USCDI+ Quality | |
identifier:NPI.value |
Mandatory Must Support | USCDI+ Quality | |
identifier:NCSBNID.system |
Mandatory Must Support | ||
identifier:NCSBNID.value |
Mandatory Must Support | ||
identifier:ein |
USCDI+ Quality | ||
identifier:ein.use |
Mandatory | ||
identifier:ein.system |
Mandatory Must Support | ||
identifier:ein.value |
Mandatory Must Support USCDI+ Quality | ||
name |
Mandatory Must Support | USCDI+ Quality | |
name.family |
Mandatory Must Support | USCDI+ Quality | |
telecom |
Must Support | USCDI+ Quality | |
telecom.system |
Must Support | USCDI+ Quality | |
telecom.value |
Must Support | USCDI+ Quality | |
address |
Must Support | USCDI+ Quality | |
address.line |
Must Support | USCDI+ Quality | |
address.city |
Must Support | USCDI+ Quality | |
address.state |
Must Support | USCDI+ Quality | |
address.postalCode |
Must Support | USCDI+ Quality | |
address.country |
Must Support | USCDI+ Quality | |
qualification.code |
Mandatory |
Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.
IG © 2026 HL7 International / Clinical Quality Information.
Package hl7.fhir.us.quality-core#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-08-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change