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

HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.1 (Standard for Trial Use) - Local Development build (v1.1.0). See the Directory of published versions

TaxIdentificationNumber

 

The official URL for this profile is:

http://hl7.org/fhir/us/odh/StructureDefinition/obf-TaxIdentificationNumber

Tax identification number for the practitioner.

This profile builds on Identifier.

This profile was published on Wed Sep 04 00:00:00 EDT 2019 as a active by HL7 International Public Health Work Group.

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:

obf.TaxIdentificationNumber 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 obf-TaxIdentificationNumber
... type 1..1
.... coding 1..*(Slice Definition)Slice: Unordered, Open by value:code
..... coding:Fixed_TAX Σ1..1CodingCode defined by a terminology system
...... system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code Fixed Value: TAX

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*obf-TaxIdentificationNumber
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_TAX Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... 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: TAX
...... 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 value
... value Σ0..1stringThe value that is unique
... 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:

obf.TaxIdentificationNumber 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 obf-TaxIdentificationNumber
... type 1..1
.... coding 1..*(Slice Definition)Slice: Unordered, Open by value:code
..... coding:Fixed_TAX Σ1..1CodingCode defined by a terminology system
...... system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code Fixed Value: TAX

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*obf-TaxIdentificationNumber
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
..... coding:Fixed_TAX Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... 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: TAX
...... 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 value
... value Σ0..1stringThe value that is unique
... 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

 

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())