Case Based Surveillance Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Extension: Case Based Surveillance Race Extension
Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.
The official URL for this extension is:
http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
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 Race Extension
This Complex Extension for race allows one race code of which:
- Must Support one code from OMB Race Categories
- May include an extended race code
- May include a text field for an other race
- Must Support text description of race
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/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
Summary
Mandatory: 0 element (8 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 5 elements
Prohibited: 5 elements
Slices
This structure defines the following Slices:
- The element Extension.extension.value[x] is sliced based on the value of type:$this
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | CBS 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 as well as null flavors |
   extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
 Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Open by type:$this | |
  valueCoding | 1..1 | Coding | Value of extension Binding: Race Category including Null Flavor (required): The 5 race 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:detailed | 0..* | Extension | Extended race codes | |
| extension | 0..0 | |||
| url | 1..1 | uri | "detailed" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Open by type:$this | |
| valueCoding | 1..1 | Coding | Value of extension Binding: DetailedRace (3.1.1) (required): The 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes. | |
| extension:otherRace | 0..* | Extension | Other Race | |
| extension | 0..0 | |||
| url | 1..1 | uri | "otherRace" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Open by type:$this | |
 valueString | 1..1 | string | Value of extension | |
| extension:text | S | 0..1 | Extension | Race Text |
| extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Open by type:$this | |
| valueString | 1..1 | string | Value of extension | |
 url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race" | |
 value[x] | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS Race Extension | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White as well as null flavors |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
 Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: Race Category including Null Flavor (required): The 5 race 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:detailed | 0..* | Extension | Extended race codes | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "detailed" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: DetailedRace (3.1.1) (required): The 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes. | |
| extension:otherRace | 0..* | Extension | Other Race | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "otherRace" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString | 1..1 | string | Value of extension | |
| extension:text | S | 0..1 | Extension | Race Text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race" | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Mandatory: 0 element (8 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 5 elements
Prohibited: 5 elements
Slices
This structure defines the following Slices:
- The element Extension.extension.value[x] is sliced based on the value of type:$this
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS 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 as well as null flavors |
| extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Open by type:$this | |
| valueCoding | 1..1 | Coding | Value of extension Binding: Race Category including Null Flavor (required): The 5 race 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:detailed | 0..* | Extension | Extended race codes | |
| extension | 0..0 | |||
| url | 1..1 | uri | "detailed" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Open by type:$this | |
| valueCoding | 1..1 | Coding | Value of extension Binding: DetailedRace (3.1.1) (required): The 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes. | |
| extension:otherRace | 0..* | Extension | Other Race | |
| extension | 0..0 | |||
| url | 1..1 | uri | "otherRace" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Open by type:$this | |
| valueString | 1..1 | string | Value of extension | |
| extension:text | S | 0..1 | Extension | Race Text |
| extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Open by type:$this | |
| valueString | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Extension | CBS Race Extension | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:ombCategory | S | 0..5 | Extension | American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White as well as null flavors |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "ombCategory" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: Race Category including Null Flavor (required): The 5 race 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:detailed | 0..* | Extension | Extended race codes | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "detailed" | |
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: DetailedRace (3.1.1) (required): The 900+ CDC Race codes that are grouped under one of the 5 OMB race category codes. | |
| extension:otherRace | 0..* | Extension | Other Race | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "otherRace" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString | 1..1 | string | Value of extension | |
| extension:text | S | 0..1 | Extension | Race Text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..0 | |||
| url | 1..1 | uri | "text" | |
| Slices for value[x] | 1..1 | string | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueString | 1..1 | string | Value of extension | |
| url | 1..1 | uri | "http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Extension.extension:ombCategory.value[x]:valueCoding | required | PHVS_RaceCategory_CDC_NullFlavor |
| Extension.extension:detailed.value[x]:valueCoding | required | DetailedRace |
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:ombCategory.value[x]:valueCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.extension:detailed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.extension:detailed | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension:detailed.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.extension:detailed.value[x]:valueCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.extension:otherRace | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Extension.extension:otherRace | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Extension.extension:otherRace.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Extension.extension:otherRace.value[x]:valueString | 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()) | |
| ele-1 | error | Extension.extension:text.value[x]:valueString | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |