US Core Implementation Guide
5.0.1 - STU5 Release US

This page is part of the US Core (v5.0.1: STU5) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: US Core Ethnicity Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Version: 5.0.1
Active as of 2019-05-21 Computable Name: USCoreEthnicityExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

Complies with 2015 Edition Common Clinical Data Set for patient race.

Context of Use

This extension may be used on the following element(s):

  • Patient
  • RelatedPerson
  • Person
  • Practitioner
  • FamilyMemberHistory

Profile specific implementation guidance

  • This Complex Extension for ethnicity allows one or more ethnicity codes of which:

    • Must Support one code from OMB Ethnicity Categories
    • May include additional ethnicity codes from CDC Ethnicity Codes
    • Must include text description of ethnicity

  • An ethnicity search parameter has been defined for this extension. However, there are no ethnicity search requirements for the client or server.

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core ethnicity Extension
... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..*ExtensionExtended ethnicity codes
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
... extension:text S1..1Extensionethnicity Text
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core ethnicity Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..*ExtensionExtended ethnicity codes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
... extension:text S1..1Extensionethnicity Text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core ethnicity Extension
... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..*ExtensionExtended ethnicity codes
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
... extension:text S1..1Extensionethnicity Text
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core ethnicity Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:ombCategory S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..*ExtensionExtended ethnicity codes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed ethnicity (required)
... extension:text S1..1Extensionethnicity Text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:ombCategory.value[x]requiredOmbEthnicityCategories
Extension.extension:detailed.value[x]requiredDetailedEthnicity