HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

- Local Development build (v0.9.0). See the Directory of published versions

NationalProviderIdentifier

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-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 Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 2 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:

shr.core.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 Σshr-core-NationalProviderIdentifier
... type 1..1
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1Coding
..... system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code Fixed Value: NPI

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Σ0..*shr-core-NationalProviderIdentifier
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
.... coding Σ1..1Coding
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... system Σ0..1uriThe namespace for the identifier
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value Σ0..1stringThe value that is unique
Example General': 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 2 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:

shr.core.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 Σshr-core-NationalProviderIdentifier
... type 1..1
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1Coding
..... system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... code Fixed Value: NPI

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Σ0..*shr-core-NationalProviderIdentifier
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
.... coding Σ1..1Coding
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... system Σ0..1uriThe namespace for the identifier
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value Σ0..1stringThe value that is unique
Example General': 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

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

 

 

Constraints

IdPathDetailsRequirements