Case Based Surveillance Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Extension: Case Based Surveillance Ethnicity 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 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 extension is based on the equivalent US Core extension though utilizes the public health focused PHIN Value Set and limiting data based on established standards in public health case based surveillance messaging.
The official URL for this extension is:
http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
Status: active
Extension maintained by: Georgia Tech Research Institute (GTRI)
Context of Use
This extension may be used on the following element(s):
- Patient
CBS Ethnicity Extension
This Complex Extension for ethnicity allows one ethnicity code of which:
- Must Support one code from OMB Ethnicity Categories
- Must include text description of ethnicity
Example can be found in GenV2 Test Case Patient
Usage info
Usage:
- Use this Extension: Case Based Surveillance Patient Profile
- Examples for this Extension: Bundle/GenV2-TC-Document, Bundle/HAICA-TC-Document, Patient/GenV2-TC-Patient, Patient/HAICA-TC-Patient, Patient/Lyme-TC-Patient, Patient/STD-TC-Patient
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | CBS Ethnicity Extension | |
  extension | 1..* | Extension | Extension | |
  extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino|other|unknown |
  extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
  value[x] | 1..1 | Coding | Value of extension Binding: Ethnicity Group including Unknown (required): 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. | |
| extension:text | S | 1..1 | Extension | Ethnicity Text |
| extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
 value[x] | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity" | |
 value[x] | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS 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|other|unknown |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
| value[x] | 1..1 | Coding | Value of extension Binding: Ethnicity Group including Unknown (required): 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. | |
| extension:text | S | 1..1 | Extension | Ethnicity Text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| value[x] | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS Ethnicity Extension | |
| extension | 1..* | Extension | Extension | |
| extension:ombCategory | S | 0..1 | Extension | Hispanic or Latino|Not Hispanic or Latino|other|unknown |
| extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
| value[x] | 1..1 | Coding | Value of extension Binding: Ethnicity Group including Unknown (required): 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. | |
| extension:text | S | 1..1 | Extension | Ethnicity Text |
| extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| value[x] | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS 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|other|unknown |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
| value[x] | 1..1 | Coding | Value of extension Binding: Ethnicity Group including Unknown (required): 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. | |
| extension:text | S | 1..1 | Extension | Ethnicity Text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| value[x] | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Extension.extension:ombCategory.value[x] | required | PHVS_EthnicityGroup_CDC_Unk |
Constraints
| Id | Grade | Path | Details | Requirements |
| ele-1 | error | Extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension:ombCategory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.extension:ombCategory | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension:ombCategory.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.extension:text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.extension:text | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension:text.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |