US Core Implementation Guide
7.0.0 - STU7 United States of America flag

This page is part of the US Core (v7.0.0: STU7) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions. Page versions: STU6.1 STU6 STU5 STU4 STU3 STU2 STU1

Extension: US Core Ethnicity Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Version: 7.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreEthnicityExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.22

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

  • Element ID Patient
  • Element ID RelatedPerson
  • Element ID Person
  • Element ID Practitioner
  • Element ID 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 a 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

Complex Extension: 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.

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension US Core ethnicity Extension
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..* Extension Extended ethnicity codes
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
... extension:text S 1..1 Extension ethnicity Text
.... url 1..1 uri "text"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension US Core ethnicity Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..* Extension Extended ethnicity codes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
... extension:text S 1..1 Extension ethnicity Text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "text"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: 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.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension US Core ethnicity Extension
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..* Extension Extended ethnicity codes
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
... extension:text S 1..1 Extension ethnicity Text
.... url 1..1 uri "text"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "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..1 Extension US Core ethnicity Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
... extension:detailed 0..* Extension Extended ethnicity codes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
... extension:text S 1..1 Extension ethnicity Text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1 uri "text"
.... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:ombCategory.value[x]requiredOmbEthnicityCategories
http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
from this IG
Extension.extension:detailed.value[x]requiredDetailedEthnicity
http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
from this IG