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 Race Extension

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

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 race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • White.

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 race allows one or more race codes of which:
    • Must Support at least one code from OMB Race Categories
    • May include additional race codes from CDC Race Codes
    • Must include a text description of race
  • A race search parameter has been defined for this extension. However, there are no race 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 race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • White.

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension US Core Race Extension
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..6 Extension American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race 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.

... extension:detailed 0..* Extension Extended race codes
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
... extension:text S 1..1 Extension Race 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-race"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension US Core Race Extension
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.
... 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..6 Extension American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... 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 Race Categories (required): The 5 race 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.

... extension:detailed 0..* Extension Extended race 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 Race (required)
... extension:text S 1..1 Extension Race 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-race"

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 race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

  • American Indian or Alaska Native
  • Asian
  • Black or African American
  • Native Hawaiian or Other Pacific Islander
  • White.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension US Core Race Extension
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
... extension:ombCategory S 0..6 Extension American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1 uri "ombCategory"
.... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race 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.

... extension:detailed 0..* Extension Extended race codes
.... url 1..1 uri "detailed"
.... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
... extension:text S 1..1 Extension Race 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-race"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension C 0..1 Extension US Core Race Extension
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.
... 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..6 Extension American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... 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 Race Categories (required): The 5 race 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.

... extension:detailed 0..* Extension Extended race 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 Race (required)
... extension:text S 1..1 Extension Race 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-race"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
us-core-23errorExtensionIf "ASKU" or "UNK" are present, then no other OMB race categories can be present.
: extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1