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

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

NationalProviderIdentifierProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-NationalProviderIdentifier

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 Fri Aug 17 00:00:00 AEST 2018 as a draft by HL7.

View the corresponding NationalProviderIdentifierModel logical model.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.NationalProviderIdentifier maps to Identifier:
  string maps to value
  Purpose maps to use
  Type maps to type
  CodeSystem maps to system 
  EffectiveTimePeriod maps to period
  Issuer maps to assigner
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*ODH NationalProviderIdentifier Profile
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... system Σ0..1uriThe namespace for the identifier value
... value Σ1..1stringThe value that is unique
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(ODH Organization Profile)Organization that issued id (may be just text)

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

ODH Mapping Source

This structure represents the following ODH mapping definition:

cimi.entity.NationalProviderIdentifier maps to Identifier:
  string maps to value
  Purpose maps to use
  Type maps to type
  CodeSystem maps to system 
  EffectiveTimePeriod maps to period
  Issuer maps to assigner

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*ODH NationalProviderIdentifier Profile
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... system Σ0..1uriThe namespace for the identifier value
... value Σ1..1stringThe value that is unique
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(ODH Organization Profile)Organization that issued id (may be just text)

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
Identifier.useIdentifierUserequiredIdentifierUse
Identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes

 

Constraints

IdPathDetailsRequirements
ele-1IdentifierAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())