USCore

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

StructureDefinition-us-core-race

US Core Race Extension

This Complex Extension for race allows one or more race codes of which:

Must Support at least one code from OMB Race Categories
May include additional race codes from CDC Race Codes
Must include text description of race

Context of Use: US Core Patient Profile

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Published on Tue May 21 00:00:00 AEST 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on Extension

Text Summary
Differential View
Full View
All Views

Extension

Summary of the Mandatory Requirements

a Text Extension value
- which must have a fixed Extension.extension.url = text
- which must have a string value in Extension.extension.valueString
which must have a fixed Extension.url = http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Summary of the Must Support Requirements

One or more Ombcategory Extensions
- which must have a fixed Extension.extension.url = ombCategory
- which must have a Coding value in Extension.extension.valueCoding with a required binding to OMB Race Categories

Summary of Other Supported Elements

One or more Detailed Extensions
- which must have a fixed Extension.extension.url = detailed
- which must have a Coding value in Extension.extension.valueCoding with a required binding to Detailed Race

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1		US Core Race Extension
extension:ombCategory	S	0..5	Extension	American Indian or Alaska Native\|Asian\|Black or African American\|Native Hawaiian or Other Pacific Islander\|White
url		1..1	uri	"ombCategory"
valueCoding		1..1	Coding	Binding: OMB Race Categories (required)
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
valueCoding		1..1	Coding	Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
url		1..1	uri	"text"
valueString		1..1	string
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
value[x]		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..1		US Core Race Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	SI	0..5	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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding	I	1..1	Coding	Value of extension Binding: OMB Race Categories (required)
extension:detailed	I	0..*	Extension	Extended race codes
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding	I	1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	SI	1..1	Extension	Race Text
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString	I	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
Documentation for this format

Extension

Summary of the Mandatory Requirements

a Text Extension value
- which must have a fixed Extension.extension.url = text
- which must have a string value in Extension.extension.valueString
which must have a fixed Extension.url = http://hl7.org/fhir/us/core/StructureDefinition/us-core-race

Summary of the Must Support Requirements

One or more Ombcategory Extensions
- which must have a fixed Extension.extension.url = ombCategory
- which must have a Coding value in Extension.extension.valueCoding with a required binding to OMB Race Categories

Summary of Other Supported Elements

One or more Detailed Extensions
- which must have a fixed Extension.extension.url = detailed
- which must have a Coding value in Extension.extension.valueCoding with a required binding to Detailed Race

Differential View

Name	Flags	Card.	Type	Description & Constraints
Extension		0..1		US Core Race Extension
extension:ombCategory	S	0..5	Extension	American Indian or Alaska Native\|Asian\|Black or African American\|Native Hawaiian or Other Pacific Islander\|White
url		1..1	uri	"ombCategory"
valueCoding		1..1	Coding	Binding: OMB Race Categories (required)
extension:detailed		0..*	Extension	Extended race codes
url		1..1	uri	"detailed"
valueCoding		1..1	Coding	Binding: Detailed Race (required)
extension:text	S	1..1	Extension	Race Text
url		1..1	uri	"text"
valueString		1..1	string
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
value[x]		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..1		US Core Race Extension
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:ombCategory	SI	0..5	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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"ombCategory"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding	I	1..1	Coding	Value of extension Binding: OMB Race Categories (required)
extension:detailed	I	0..*	Extension	Extended race codes
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"detailed"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCoding	I	1..1	Coding	Value of extension Binding: Detailed Race (required)
extension:text	SI	1..1	Extension	Race Text
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"text"
value[x]	I	0..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueString	I	1..1	string	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
Documentation for this format

See the Conformance requirements for a complete list of supported RESTful interactions for this IG.