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

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

URL for this extension: 


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

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 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.

Context of Use: Use on element: Patient

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
US Core ethnicity 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
. . . ombCategory 1..1 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](https://www.whitehouse.gov/omb/fedreg_1997standards).
. . . detailed 0..* Coding The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.
. . . text 0..1 string Plain text representation of the ethnicity concept(s).

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
US Core ethnicity 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
. . . extension 1..1 Extension Hispanic or Latino|Not Hispanic or Latino
. . . . extension 0 .. 0
. . . . url 1..1 uri "ombCategory"
. . . . valueCoding 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories ( required )
. . . extension 0..* Extension Extended ethnicity codes
. . . . extension 0 .. 0
. . . . url 1..1 uri "detailed"
. . . . valueCoding 1..1 Coding Value of extension
Binding: US-Core Detailed ethnicity ( required )
. . . extension 0..1 Extension ethnicity Text
. . . . extension 0 .. 0
. . . . url 1..1 uri "text"
. . . . valueString 1..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

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

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-ethnicity" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="ombCategory"> 1..1 Extension  <!-- 1..1 Hispanic or Latino|Not Hispanic or Latino -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="detailed"> 0..* Extension  <!-- 0..* Extended ethnicity codes -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="text"> 0..1 Extension  <!-- 0..1 ethnicity Text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template 

{ // US Core ethnicity Extension
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Hispanic or Latino|Not Hispanic or Latino // R! 
        // from Element: extension
        "url" : "ombCategory", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Extended ethnicity codes //
        // from Element: extension
        "url" : "detailed", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // ethnicity Text //
        // from Element: extension
        "url" : "text", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
US Core ethnicity 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
. . . ombCategory 1..1 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](https://www.whitehouse.gov/omb/fedreg_1997standards).
. . . detailed 0..* Coding The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.
. . . text 0..1 string Plain text representation of the ethnicity concept(s).

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
US Core ethnicity 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.
Use on element: Patient
. . . extension 1..1 Extension Hispanic or Latino|Not Hispanic or Latino
. . . . extension 0 .. 0
. . . . url 1..1 uri "ombCategory"
. . . . valueCoding 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories ( required )
. . . extension 0..* Extension Extended ethnicity codes
. . . . extension 0 .. 0
. . . . url 1..1 uri "detailed"
. . . . valueCoding 1..1 Coding Value of extension
Binding: US-Core Detailed ethnicity ( required )
. . . extension 0..1 Extension ethnicity Text
. . . . extension 0 .. 0
. . . . url 1..1 uri "text"
. . . . valueString 1..1 string Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

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

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-ethnicity" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="ombCategory"> 1..1 Extension  <!-- 1..1 Hispanic or Latino|Not Hispanic or Latino -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="detailed"> 0..* Extension  <!-- 0..* Extended ethnicity codes -->
  <valueCoding><!-- 1..1 Coding Value of extension --></valueCoding>
 </extension>
 <extension url="text"> 0..1 Extension  <!-- 0..1 ethnicity Text -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template 

{ // US Core ethnicity Extension
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // Hispanic or Latino|Not Hispanic or Latino // R! 
        // from Element: extension
        "url" : "ombCategory", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // Extended ethnicity codes //
        // from Element: extension
        "url" : "detailed", // R! 
        "valueCoding" : { Coding } // R! Value of extension
      },
      { // ethnicity Text //
        // from Element: extension
        "url" : "text", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity", // 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')]) )