US Core Implementation Guide (Release 1)

This page is part of the US Core (v1.0.0: STU1) 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

1.0 - StructureDefinition-us-core-ethnicity

US Core Ethnicity Extension

Scope and Usage

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

  • Must Support one code from OMB Ethnicity Categories
  • May include additional race codes from CDC Ethnicity Codes
  • Must include text description of race

Context of Use: US Core Patient Profile

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity

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.

This profile builds on Extension.

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.

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

Summary of the Mandatory Requirements

  1. Must Support one code from OMB Ethnicity Categories
  2. May include additional ethnicity codes from CDC Ethnicity Codes
  3. Must include text
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US Core ethnicity Extension
... url 1..1"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... extension S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingBinding: OMB Ethnicity Categories (required)
... extension 0..*ExtensionExtended ethnicity codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: US-Core Detailed ethnicity (required)
... extension S1..1Extensionethnicity Text
.... url 1..1uri"text"
.... valueString 1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core ethnicity Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension 0..*ExtensionExtended ethnicity codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed ethnicity (required)
... extension S1..1Extensionethnicity Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

Summary of the Mandatory Requirements

  1. Must Support one code from OMB Ethnicity Categories
  2. May include additional ethnicity codes from CDC Ethnicity Codes
  3. Must include text

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1US Core ethnicity Extension
... url 1..1"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
... extension S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingBinding: OMB Ethnicity Categories (required)
... extension 0..*ExtensionExtended ethnicity codes
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingBinding: US-Core Detailed ethnicity (required)
... extension S1..1Extensionethnicity Text
.... url 1..1uri"text"
.... valueString 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..1US Core ethnicity Extension
... id 0..1stringxml:id (or equivalent in JSON)
... extension S0..1ExtensionHispanic or Latino|Not Hispanic or Latino
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"ombCategory"
.... valueCoding 1..1CodingValue of extension
Binding: OMB Ethnicity Categories (required)
... extension 0..*ExtensionExtended ethnicity codes
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"detailed"
.... valueCoding 1..1CodingValue of extension
Binding: US-Core Detailed ethnicity (required)
... extension S1..1Extensionethnicity Text
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"text"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for uscore-ethnicity extension.