US Core Implementation Guide
6.0.0-ballot - STU6 Ballot US

This page is part of the US Core (v6.0.0-ballot: STU6 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

Extension: US Core Race Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Version: 6.0.0-ballot
Active as of 2019-05-21 Computable Name: USCoreRaceExtension

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
  • Element ID
  • Element ID
  • Element ID
  • Element ID

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

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 1 element

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core Race Extension
... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue 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..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core Race Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue 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..*ExtensionExtended race codes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 4 elements
Prohibited: 1 element

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionUS Core Race Extension
... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue 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..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"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 0..1ExtensionUS Core Race Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:ombCategory S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"ombCategory"
.... value[x] 1..1CodingValue 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..*ExtensionExtended race codes
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"detailed"
.... value[x] 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:ombCategory.value[x]requiredOmbRaceCategories
Extension.extension:detailed.value[x]requiredDetailedRace