HL7 FHIR® US Core Implementation Guide (Release 3.0.1 STU3 Update for Comment)

This page is part of the US Core (v3.0.1: STU3 Ballot 3) 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

StructureDefinition-us-core-race

US Core Race Extension

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

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 Tue May 21 00:00:00 EDT 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on Extension

Extension

Summary of the Mandatory Requirements

  • a Text Extension value
    • which must have a fixed Extension.extension.url = text
    • which must have a string value in Extension.extension.valueString
  • which must have a fixed Extension.url = http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Summary of the Must Support Requirements

  1. One or more Ombcategory Extensions
    • which must have a fixed Extension.extension.url = ombCategory
    • which must have a Coding value in Extension.extension.valueCoding with a required binding to OMB Race Categories

Summary of Other Supported Elements

  1. One or more Detailed Extensions
    • which must have a fixed Extension.extension.url = detailed
    • which must have a Coding value in Extension.extension.valueCoding with a required binding to Detailed Race
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US 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"
.... valueCoding 1..1CodingBinding: OMB Race Categories (required)
... extension:detailed 0..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... url 1..1uri"text"
.... valueString 1..1string
... url 1..1"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core Race Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
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..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension:detailed 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text 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

Extension

Summary of the Mandatory Requirements

  • a Text Extension value
    • which must have a fixed Extension.extension.url = text
    • which must have a string value in Extension.extension.valueString
  • which must have a fixed Extension.url = http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Summary of the Must Support Requirements

  1. One or more Ombcategory Extensions
    • which must have a fixed Extension.extension.url = ombCategory
    • which must have a Coding value in Extension.extension.valueCoding with a required binding to OMB Race Categories

Summary of Other Supported Elements

  1. One or more Detailed Extensions
    • which must have a fixed Extension.extension.url = detailed
    • which must have a Coding value in Extension.extension.valueCoding with a required binding to Detailed Race

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US 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"
.... valueCoding 1..1CodingBinding: OMB Race Categories (required)
... extension:detailed 0..*ExtensionExtended race codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: Detailed Race (required)
... extension:text S1..1ExtensionRace Text
.... url 1..1uri"text"
.... valueString 1..1string
... url 1..1"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

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 0..*ExtensionExtension
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..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Race Categories (required)
... extension:detailed 0..*ExtensionExtended race codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: Detailed Race (required)
... extension:text 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

See the Conformance requirements for a complete list of supported RESTful interactions for this IG.