This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/odh/StructureDefinition/obf-NationalProviderIdentifier
NPI: a unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.
This profile builds on Identifier.
This profile was published on Sat Jan 04 00:00:00 UTC 2020 as a active by HL7 International Public Health Work Group.
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
Mapping Source
This structure represents the following mapping definition:
obf.NationalProviderIdentifier maps to Identifier: IdentifierString maps to value Purpose maps to use Type maps to type CodeSystem maps to system EffectiveTimePeriod maps to period
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | Identifier | National Provider Identifier | ||
type | 1..1 | |||
coding | 1..* | (Slice Definition) | Slice: Unordered, Open by value:code | |
coding:Fixed_PRN | Σ | 1..1 | Coding | Code defined by a terminology system |
system | 1..1 | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||
code | 1..1 | Fixed Value: PRN | ||
system | Fixed Value: http://hl7.org/fhir/sid/us-npi | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 0..* | Identifier | National Provider Identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
coding | ΣI | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:code |
coding:Fixed_PRN | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN |
display | ΣI | 0..1 | string | Representation defined by the system |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Plain text representation of the concept |
system | ΣI | 0..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
value | ΣI | 0..1 | string | The value that is unique |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
Mapping Source
This structure represents the following mapping definition:
obf.NationalProviderIdentifier maps to Identifier: IdentifierString maps to value Purpose maps to use Type maps to type CodeSystem maps to system EffectiveTimePeriod maps to period
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | Identifier | National Provider Identifier | ||
type | 1..1 | |||
coding | 1..* | (Slice Definition) | Slice: Unordered, Open by value:code | |
coding:Fixed_PRN | Σ | 1..1 | Coding | Code defined by a terminology system |
system | 1..1 | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||
code | 1..1 | Fixed Value: PRN | ||
system | Fixed Value: http://hl7.org/fhir/sid/us-npi | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | I | 0..* | Identifier | National Provider Identifier |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | ΣI | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
coding | ΣI | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:code |
coding:Fixed_PRN | Σ | 1..1 | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
version | ΣI | 0..1 | string | Version of the system - if relevant |
code | ΣI | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN |
display | ΣI | 0..1 | string | Representation defined by the system |
userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
text | ΣI | 0..1 | string | Plain text representation of the concept |
system | ΣI | 0..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
value | ΣI | 0..1 | string | The value that is unique |
period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Conformance | ValueSet |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Identifier Type Codes |
Id | Path | Details | Requirements |
ele-1 | Identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Identifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Identifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Identifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |