US Core Implementation Guide (Release 1.1.0 Ballot )

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

SD.22 StructureDefinition-us-core-race

US Core Race Extension

Scope and Usage

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

Context of Use: US Core Patient Profile

SD.22.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.

This profile builds on Extension

Summary of the Mandatory Requirements

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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core Race Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension S0..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)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..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 Support at least one code from OMB Race Categories
  2. May include additional race codes from CDC Race Codes
  3. Must include text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US Core Race Extension
... url 1..1"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
... extension S0..5ExtensionAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingBinding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... url 1..1uri"text"
.... valueString 1..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 S0..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)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed Race (required)
... extension S1..1ExtensionRace Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..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

 

SD.22.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

No Search criteria for uscore-race extension.