HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.0 (Standard for Trial Use)

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

NationalProviderIdentifier

 

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:

  • The element Identifier.type.coding is sliced based on the value of value:code

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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier IdentifierNational Provider Identifier
... type 1..1
.... coding 1..*(Slice Definition)Slice: Unordered, Open by value:code
..... coding:Fixed_PRN Σ1..1CodingCode defined by a terminology system
...... system 1..1Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1Fixed Value: PRN
... system Fixed Value: http://hl7.org/fhir/sid/us-npi

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierNational Provider Identifier
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_PRN Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... value ΣI0..1stringThe value that is unique
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Summary

Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Identifier.type.coding is sliced based on the value of value:code

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier IdentifierNational Provider Identifier
... type 1..1
.... coding 1..*(Slice Definition)Slice: Unordered, Open by value:code
..... coding:Fixed_PRN Σ1..1CodingCode defined by a terminology system
...... system 1..1Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1Fixed Value: PRN
... system Fixed Value: http://hl7.org/fhir/sid/us-npi

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierNational Provider Identifier
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_PRN Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... value ΣI0..1stringThe value that is unique
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleIdentifier Type Codes

 

Constraints

IdPathDetailsRequirements
ele-1IdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Identifier.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Identifier.type.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Identifier.type.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Identifier.type.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())