De-Identification, Anonymization, Redaction Toolkit Services
0.1.0 - STU1 Release 1 - Standard for Trial-Use United States of America flag

De-Identification, Anonymization, Redaction Toolkit Services, published by HL7 International / Cross Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-darts/ and changes regularly. See the Directory of published versions

Extension: UDS Plus Race Extension

Official URL: http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-race-extension Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: UDSPlusRaceExtension

Indicates the race of the patient.

Context of Use

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

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from USCoreRaceExtension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 & Constraints    Filter: Filtersdoco
.. Extension C 1..1 USCoreRaceExtension Indicates the race of the Patient.
Constraints: us-core-23
... 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..6 Extension 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: 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 including absence reasons. . (required)
.... extension:text S 1..1 Extension 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: 1

Differential View

This structure is derived from USCoreRaceExtension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 & Constraints    Filter: Filtersdoco
.. Extension C 1..1 USCoreRaceExtension Indicates the race of the Patient.
Constraints: us-core-23
... 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..6 Extension 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: 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 including absence reasons. . (required)
.... extension:text S 1..1 Extension 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: 1

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:ombCategory.​value[x] Base required Race Categories . 📦20250419 VSAC v0.24
Extension.extension:detailed.​value[x] Base required Detailed race including absence reasons. . 📦20250419 VSAC v0.24

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-23 error Extension If "ASKU" or "UNK" are present, then no other OMB race categories can be present. extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1