HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.1 - Standard for Trial-Use International flag

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.1.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: UDS Plus Race Extension

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-race-extension Version: 1.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: UDSPlusRaceExtension

Indicates the race of the patient.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient

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 USCoreRaceExtension

Summary

Complex Extension: Indicates the race of the patient.

Maturity: 2

This structure is derived from USCoreRaceExtension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreRaceExtension Indicates the race of the Patient.
... Slices for extension Content/Rules for all slices
.... extension:detailed 1..* Extension Extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreRaceExtension Indicates the race of the Patient.
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ombCategory S 0..5 Extension (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ombCategory"
..... value[x] 1..1 Coding Value 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 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "detailed"
..... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
.... extension:text S 1..1 Extension (USCDI) Race Text
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "text"
..... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

This structure is derived from USCoreRaceExtension

Summary

Complex Extension: Indicates the race of the patient.

Maturity: 2

Differential View

This structure is derived from USCoreRaceExtension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreRaceExtension Indicates the race of the Patient.
... Slices for extension Content/Rules for all slices
.... extension:detailed 1..* Extension Extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreRaceExtension Indicates the race of the Patient.
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ombCategory S 0..5 Extension (USCDI) American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "ombCategory"
..... value[x] 1..1 Coding Value 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 1..* Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "detailed"
..... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
.... extension:text S 1..1 Extension (USCDI) Race Text
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "text"
..... value[x] 1..1 string Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:ombCategory.value[x]requiredOmbRaceCategories
http://hl7.org/fhir/us/core/ValueSet/omb-race-category
Extension.extension:detailed.value[x]requiredDetailedRace
http://hl7.org/fhir/us/core/ValueSet/detailed-race

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()