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 Ethnicity Extension

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

Indicates the ethnicity 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 USCoreEthnicityExtension

Summary

Complex Extension: Indicates the ethnicity of the patient.

Maturity: 2

This structure is derived from USCoreEthnicityExtension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreEthnicityExtension Indicates the ethnicity 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 USCoreEthnicityExtension Indicates the ethnicity 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..1 Extension (USCDI) Hispanic or Latino|Not Hispanic or Latino
..... 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 Ethnicity Categories (required)
.... 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 ethnicity (required)
.... extension:text S 1..1 Extension (USCDI) ethnicity 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-ethnicity"

doco Documentation for this format

This structure is derived from USCoreEthnicityExtension

Summary

Complex Extension: Indicates the ethnicity of the patient.

Maturity: 2

Differential View

This structure is derived from USCoreEthnicityExtension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 1..1 USCoreEthnicityExtension Indicates the ethnicity 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 USCoreEthnicityExtension Indicates the ethnicity 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..1 Extension (USCDI) Hispanic or Latino|Not Hispanic or Latino
..... 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 Ethnicity Categories (required)
.... 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 ethnicity (required)
.... extension:text S 1..1 Extension (USCDI) ethnicity 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-ethnicity"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:ombCategory.value[x]requiredOmbEthnicityCategories
http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
Extension.extension:detailed.value[x]requiredDetailedEthnicity
http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity

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()