US Core

US Core Implementation Guide (Release 1.1.0 Ballot )

This page is part of the US Core (v1.1.0: STU2 Ballot 1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-us-core-ethnicity Profile.

Extension
Definition	Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.
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 (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
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
Extension.extension
Definition	An Extension
Control	0..*
Type	Extension
Extension.extension(ombCategory)
Definition	The 2 ethnicity 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..1
Type	Extension
Must Support	true
Extension.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
Extension.extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0
Type	Extension
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.
Extension.extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
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
Extension.extension.valueCoding
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	1..1
Binding	The 2 ethnicity 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](https://www.whitehouse.gov/omb/fedreg_1997standards). The codes SHALL be taken from OMB Ethnicity Categories
Type	Coding
Extension.extension(detailed)
Definition	The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.
Control	0..*
Type	Extension
Extension.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
Extension.extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0
Type	Extension
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.
Extension.extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
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
Extension.extension.valueCoding
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	1..1
Binding	The 41 [CDC ethnicity codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 2 OMB ethnicity category codes. The codes SHALL be taken from US-Core Detailed ethnicity
Type	Coding
Extension.extension(text)
Definition	Plain text representation of the ethnicity concept(s).
Control	1..1
Type	Extension
Must Support	true
Extension.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
Extension.extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..0
Type	Extension
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.
Extension.extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
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
Extension.extension.valueString
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	1..1
Type	string
Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
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-ethnicity
Extension.value[x]
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..0
Type	Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]