US Core Ethnicity Extension - US Core Implementation Guide v8.0.0

US Core Implementation Guide
8.0.0 - STU 8 United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Extension: US Core Ethnicity Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity				Version: 8.0.0
Standards status: Trial-use				Computable Name: USCoreEthnicityExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.25
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:

Use this Extension: US Core Patient Profile
Examples for this Extension: Patient/child-example, Patient/deceased-example, Patient/example and Patient/infant-example

Changes since version 7.0.0:

No changes

Formal Views of Extension Content

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

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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"
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.

ombCategory: Coding: The 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
detailed: Coding: The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.
text: string: Plain text representation of the ethnicity concept(s).

Differential View

This structure is derived from Extension

Name	Flags	Card.	Type	Description & Constraints
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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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"
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.

ombCategory: Coding: The 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
detailed: Coding: The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.
text: string: Plain text representation of the ethnicity concept(s).

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet	URI
Extension.extension:ombCategory.value[x]	required	OmbEthnicityCategories `http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category` from this IG
Extension.extension:detailed.value[x]	required	DetailedEthnicity `http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity` from this IG

IG © 2025+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#8.0.0 based on FHIR 4.0.1. Generated 2025-03-13
Links: Table of Contents | QA Report | Version History | | Propose a change