STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: US Core Race Extension

(No assigned work group) Maturity Level: 0Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/us-core-race

Status: draft. Extension maintained by: Health Level Seven International (US Realm Steering Committee)

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.

Context of Use: Use on element: Patient

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/us-core-race
US Core Race 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
... ombCategory1..5CodingThe 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](https://www.whitehouse.gov/omb/fedreg_1997standards).
... detailed0..*CodingThe 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.
... text0..1stringPlain text representation of the race concept(s).

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/us-core-race
US Core Race 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... extension 0..0
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... extension 0..0
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... extension 0..0
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- US Core Race Extension -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-race" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="ombCategory"> 1..5 Extension  <!-- 1..5 American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="detailed"> 0..* Extension  <!-- 0..* Extended race codes -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="text"> 0..1 Extension  <!-- 0..1 Race Text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // US Core Race Extension
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White // R! 
        // from Element: extension
        "url" : "ombCategory", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Extended race codes //
        // from Element: extension
        "url" : "detailed", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Race Text //
        // from Element: extension
        "url" : "text", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-race", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/us-core-race
US Core Race 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
... ombCategory1..5CodingThe 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](https://www.whitehouse.gov/omb/fedreg_1997standards).
... detailed0..*CodingThe 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.
... text0..1stringPlain text representation of the race concept(s).

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/us-core-race
US Core Race 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... extension 0..0
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... extension 0..0
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... extension 0..0
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- US Core Race Extension -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-race" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="ombCategory"> 1..5 Extension  <!-- 1..5 American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="detailed"> 0..* Extension  <!-- 0..* Extended race codes -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="text"> 0..1 Extension  <!-- 0..1 Race Text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // US Core Race Extension
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White // R! 
        // from Element: extension
        "url" : "ombCategory", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Extended race codes //
        // from Element: extension
        "url" : "detailed", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Race Text //
        // from Element: extension
        "url" : "text", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-race", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))