HL7.FHIR.US.CORE\US Core Race Extension - Definitions

This page is part of the US Core (v6.0.0: STU6) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: USCoreRaceExtension - Detailed Descriptions

Active as of 2019-05-21

Definitions for the us-core-race extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition	Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: American Indian or Alaska Native Asian Black or African American Native Hawaiian or Other Pacific Islander White. Optional Extension Element - found in all resources.
Control	0..1*
2. Extension.extension:ombCategory
SliceName	ombCategory
Definition	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.
Control	0..5
Type	Extension
Must Support	true
3. Extension.extension:ombCategory.url
Control	1..1
Type	uri
Fixed Value	ombCategory
4. Extension.extension:ombCategory.value[x]
Control	1..1
Binding	The codes SHALL be taken from OMB Race Categories 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
Type	Coding
[x] Note	See Choice of Data Types for further information about how to use [x]
5. Extension.extension:detailed
SliceName	detailed
Definition	The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.
Control	0..*
Type	Extension
6. Extension.extension:detailed.url
Control	1..1
Type	uri
Fixed Value	detailed
7. Extension.extension:detailed.value[x]
Control	1..1
Binding	The codes SHALL be taken from Detailed Race
Type	Coding
[x] Note	See Choice of Data Types for further information about how to use [x]
8. Extension.extension:text
SliceName	text
Definition	Plain text representation of the race concept(s).
Control	1..1
Type	Extension
Must Support	true
9. Extension.extension:text.url
Control	1..1
Type	uri
Fixed Value	text
10. Extension.extension:text.value[x]
Control	1..1
Type	string
[x] Note	See Choice of Data Types for further information about how to use [x]
11. Extension.url
Fixed Value	http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
12. Extension.value[x]
Control	0..01
[x] Note	See Choice of Data Types for further information about how to use [x]

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition	Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: American Indian or Alaska Native Asian Black or African American Native Hawaiian or Other Pacific Islander White. Optional Extension Element - found in all resources.
Control	0..1* This element is affected by the following invariants: ele-1
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
2. Extension.extension:ombCategory
SliceName	ombCategory
Definition	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. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..5*
Type	Extension
Must Support	true
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
3. Extension.extension:ombCategory.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	ombCategory
4. Extension.extension:ombCategory.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Binding	The codes SHALL be taken from OMB Race CategoriesFor codes, see (unbound) 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
Type	Choice of: Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Extension.extension:detailed
SliceName	detailed
Definition	The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. Extension.extension:detailed.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	detailed
7. Extension.extension:detailed.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Binding	The codes SHALL be taken from Detailed RaceFor codes, see (unbound)
Type	Choice of: Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Extension.extension:text
SliceName	text
Definition	Plain text representation of the race concept(s). May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	10..1*
Type	Extension
Must Support	true
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Extension.extension:text.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	text
10. Extension.extension:text.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Type	Choice of: string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
12. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	0..01
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition	Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: American Indian or Alaska Native Asian Black or African American Native Hawaiian or Other Pacific Islander White.
Control	0..1 This element is affected by the following invariants: ele-1
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
3. Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:ombCategory
SliceName	ombCategory
Definition	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.
Control	0..5
Type	Extension
Must Support	true
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Extension.extension:ombCategory.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
6. Extension.extension:ombCategory.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
7. Extension.extension:ombCategory.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	ombCategory
8. Extension.extension:ombCategory.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Binding	The codes SHALL be taken from OMB Race Categories 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
Type	Coding
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.extension:detailed
SliceName	detailed
Definition	The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.
Control	0..*
Type	Extension
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Extension.extension:detailed.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
11. Extension.extension:detailed.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:detailed.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	detailed
13. Extension.extension:detailed.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Binding	The codes SHALL be taken from Detailed Race
Type	Coding
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Extension.extension:text
SliceName	text
Definition	Plain text representation of the race concept(s).
Control	1..1
Type	Extension
Must Support	true
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Extension.extension:text.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
16. Extension.extension:text.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
17. Extension.extension:text.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	text
18. Extension.extension:text.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	string
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
20. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	0..0
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))