US-Core CI Build

This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-us-core-race

US Core Ethnicity Extension

Scope and Usage

This Complex Extension for race allows one or more race codes of which:

  • Must include at least one code from OMB Race Categories
  • May include additional race codes from CDC Race Codes

Context of Use: US Core Patient Profile

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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.

This profile builds on Extension.

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

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

Summary of the Mandatory Requirements

  1. Must include at least one code from OMB Race Categories
  2. May include additional race codes from CDC Race Codes
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US Core Race Extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
... value[x] 0..0
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... value[x] 0..1CodingBinding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... value[x] 0..1CodingBinding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... value[x] 0..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core Race Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueCoding 0..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueCoding 0..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

Summary of the Mandatory Requirements

  1. Must include at least one code from OMB Race Categories
  2. May include additional race codes from CDC Race Codes

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US Core Race Extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
... value[x] 0..0
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... value[x] 0..1CodingBinding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... value[x] 0..1CodingBinding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... value[x] 0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core Race Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueCoding 0..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueCoding 0..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension 0..1ExtensionRace Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Argonaut Search Criteria for StructureDefinition-us-core-race

No Search criteria for uscore-race extension.