US Core Implementation Guide
​9.0.0-ballot - United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 9.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Extension: US Core Ethnicity Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Version: 9.0.0-ballot
Standards status: Trial-use Active as of 2023-10-17 Maturity Level: 3 Computable Name: USCoreEthnicityExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.26

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

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 Race & Ethnicity - CDC (CDCREC) code system. Detailed ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories:

  • Hispanic or Latino
  • Not Hispanic or Latino.

Context of Use

Profile specific implementation guidance

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

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

  • A n ethnicity search parameter has been defined for this extension. However, there are no ethnicity search requirements for the Client or Server.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 8.0.0:

  • The resource metadata has changed (description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

    Description Differentials, Snapshots, and other representations.

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension US Core ethnicity Extension
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
    ..... url 1..1 uri "ombCategory"
    ..... value[x] 1..1 Coding Value of extension
    Binding: Ethnicity Categories . (required)
    .... extension:detailed 0..* Extension Extended ethnicity codes
    ..... url 1..1 uri "detailed"
    ..... value[x] 1..1 Coding Value of extension
    Binding: Detailed Ethnicity Including Absence Reasons . (required)
    .... extension:text S 1..1 Extension ethnicity Text
    ..... 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"
    ... value[x] 0..0

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Extension.extension:ombCategory.​value[x] Base required Ethnicity Categories . 📦20250419 VSAC v0.23
    Extension.extension:detailed.​value[x] Base required Detailed Ethnicity Including Absence Reasons . 📦20250419 VSAC v0.23
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension US Core ethnicity Extension
    ... id 0..1 string Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:ombCategory S 0..1 Extension 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: Ethnicity Categories . (required)
    .... extension:detailed 0..* Extension Extended ethnicity codes
    ..... 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 Including Absence Reasons . (required)
    .... extension:text S 1..1 Extension 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

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.extension:ombCategory.​value[x] Base required Ethnicity Categories . 📦20250419 VSAC v0.23
    Extension.extension:detailed.​value[x] Base required Detailed Ethnicity Including Absence Reasons . 📦20250419 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Summary

    Complex Extension: 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 Race & Ethnicity - CDC (CDCREC) code system. Detailed ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories:

    • Hispanic or Latino
    • Not Hispanic or Latino.

    Maturity: 3

    Differential ViewDifferential View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension US Core ethnicity Extension
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:ombCategory S 0..1 Extension Hispanic or Latino|Not Hispanic or Latino
    ..... url 1..1 uri "ombCategory"
    ..... value[x] 1..1 Coding Value of extension
    Binding: Ethnicity Categories . (required)
    .... extension:detailed 0..* Extension Extended ethnicity codes
    ..... url 1..1 uri "detailed"
    ..... value[x] 1..1 Coding Value of extension
    Binding: Detailed Ethnicity Including Absence Reasons . (required)
    .... extension:text S 1..1 Extension ethnicity Text
    ..... 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"
    ... value[x] 0..0

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Extension.extension:ombCategory.​value[x] Base required Ethnicity Categories . 📦20250419 VSAC v0.23
    Extension.extension:detailed.​value[x] Base required Detailed Ethnicity Including Absence Reasons . 📦20250419 VSAC v0.23

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension US Core ethnicity Extension
    ... id 0..1 string Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:ombCategory S 0..1 Extension 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: Ethnicity Categories . (required)
    .... extension:detailed 0..* Extension Extended ethnicity codes
    ..... 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 Including Absence Reasons . (required)
    .... extension:text S 1..1 Extension 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

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.extension:ombCategory.​value[x] Base required Ethnicity Categories . 📦20250419 VSAC v0.23
    Extension.extension:detailed.​value[x] Base required Detailed Ethnicity Including Absence Reasons . 📦20250419 VSAC v0.23

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    Summary

    Complex Extension: 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 Race & Ethnicity - CDC (CDCREC) code system. Detailed ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories:

    • Hispanic or Latino
    • Not Hispanic or Latino.

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron