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
{ "resourceType" : "StructureDefinition", "id" : "us-core-ethnicity", "text" : { "status" : "generated", "div" : "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity">http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: US Core ethnicity Extension</p><p><b>title</b>: US Core ethnicity Extension</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: HL7 US Realm Steering Committee</p><p><b>contact</b>: </p><p><b>description</b>: 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.</p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity">http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: US Core ethnicity Extension</p><p><b>title</b>: US Core ethnicity Extension</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: HL7 US Realm Steering Committee</p><p><b>contact</b>: </p><p><b>description</b>: 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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.</p><p><b>purpose</b>: Complies with 2015 Edition Common Clinical Data Set for patient race.</p><p><b>fhirVersion</b>: 3.0.0</p><h3>Mappings</h3><table class="grid"><tr><td>-</td><td><b>Identity</b></td><td><b>Uri</b></td><td><b>Name</b></td></tr><tr><td>*</td><td>rim</td><td><a href="http://hl7.org/v3">http://hl7.org/v3</a></td><td>RIM Mapping</td></tr></table><p><b>kind</b>: COMPLEXTYPE</p><p><b>abstract</b>: false</p><p><b>contextType</b>: RESOURCE</p><p><b>context</b>: Patient</p><p><b>type</b>: Extension</p><p><b>baseDefinition</b>: <a href="http://hl7.org/fhir/StructureDefinition/Extension">http://hl7.org/fhir/StructureDefinition/Extension</a></p><p><b>derivation</b>: CONSTRAINT</p><h3>Snapshots</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table><h3>Differentials</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div>" }, "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity", "version" : "1.0.0", "name" : "US Core ethnicity Extension", "title" : "US Core ethnicity Extension", "status" : "draft", "date" : "2016-08-01", "publisher" : "HL7 US Realm Steering Committee", "contact" : [ { "telecom" : [ { "system" : "url", "value" : "http://www.healthit.gov" } ] } ], "description" : "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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.", "purpose" : "Complies with 2015 Edition Common Clinical Data Set for patient race.", "fhirVersion" : "3.0.0", "mapping" : [ { "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" } ], "kind" : "complex-type", "abstract" : false, "contextType" : "resource", "context" : [ "Patient" ], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [ { "id" : "Extension:ethnicity", "path" : "Extension", "sliceName" : "ethnicity", "short" : "US Core ethnicity Extension", "definition" : "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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "condition" : [ "ele-1" ], "constraint" : [ { "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "children().count() > id.count()", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "Extension" } ], "isModifier" : false }, { "id" : "Extension:ethnicity.id", "path" : "Extension.id", "representation" : [ "xmlAttr" ], "short" : "xml:id (or equivalent in JSON)", "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension", "path" : "Extension.extension", "slicing" : { "id" : "2", "discriminator" : [ { "type" : "value", "path" : "url" } ], "ordered" : false, "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory", "path" : "Extension.extension", "sliceName" : "ombCategory", "short" : "Hispanic or Latino|Not Hispanic or Latino", "definition" : "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](https://www.whitehouse.gov/omb/fedreg_1997standards).", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "mustSupport" : true, "isModifier" : false, "mapping" : [ { "identity" : "iso11179", "map" : "/ClinicalDocument/recordTarget/patientRole/patient/ethnicGroupCode" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory.id", "path" : "Extension.extension.id", "representation" : [ "xmlAttr" ], "short" : "xml:id (or equivalent in JSON)", "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory.extension", "path" : "Extension.extension.extension", "short" : "Additional Content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory.url", "path" : "Extension.extension.url", "representation" : [ "xmlAttr" ], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [ { "code" : "uri" } ], "fixedUri" : "ombCategory", "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory.valueCoding", "path" : "Extension.extension.valueCoding", "short" : "Value of extension", "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Coding" } ], "binding" : { "strength" : "required", "description" : "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](https://www.whitehouse.gov/omb/fedreg_1997standards).", "valueSetReference" : { "reference" : "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category" } }, "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.extension:detailed", "path" : "Extension.extension", "sliceName" : "detailed", "short" : "Extended ethnicity codes", "definition" : "The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.", "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "isModifier" : false, "mapping" : [ { "identity" : "iso11179", "map" : "/ClinicalDocument/recordTarget/patientRole/patient/sdtc:ethnicGroupCode" } ] }, { "id" : "Extension:ethnicity.extension:detailed.id", "path" : "Extension.extension.id", "representation" : [ "xmlAttr" ], "short" : "xml:id (or equivalent in JSON)", "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:detailed.extension", "path" : "Extension.extension.extension", "short" : "Additional Content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:detailed.url", "path" : "Extension.extension.url", "representation" : [ "xmlAttr" ], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [ { "code" : "uri" } ], "fixedUri" : "detailed", "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.extension:detailed.valueCoding", "path" : "Extension.extension.valueCoding", "short" : "Value of extension", "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "Coding" } ], "binding" : { "strength" : "required", "description" : "The 41 [CDC ethnicity codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 2 OMB ethnicity category codes.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity" } }, "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.extension:text", "path" : "Extension.extension", "sliceName" : "text", "short" : "ethnicity Text", "definition" : "Plain text representation of the ethnicity concept(s).", "min" : 1, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "mustSupport" : true, "isModifier" : false }, { "id" : "Extension:ethnicity.extension:text.id", "path" : "Extension.extension.id", "representation" : [ "xmlAttr" ], "short" : "xml:id (or equivalent in JSON)", "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:text.extension", "path" : "Extension.extension.extension", "short" : "Additional Content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : [ "extensions", "user content" ], "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [ { "code" : "Extension" } ], "mapping" : [ { "identity" : "rim", "map" : "n/a" } ] }, { "id" : "Extension:ethnicity.extension:text.url", "path" : "Extension.extension.url", "representation" : [ "xmlAttr" ], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [ { "code" : "uri" } ], "fixedUri" : "text", "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.extension:text.valueString", "path" : "Extension.extension.valueString", "short" : "Value of extension", "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "string" } ], "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.url", "path" : "Extension.url", "representation" : [ "xmlAttr" ], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [ { "code" : "uri" } ], "fixedUri" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity", "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] }, { "id" : "Extension:ethnicity.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min" : 0, "max" : "0", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [ { "code" : "base64Binary" }, { "code" : "boolean" }, { "code" : "code" }, { "code" : "date" }, { "code" : "dateTime" }, { "code" : "decimal" }, { "code" : "id" }, { "code" : "instant" }, { "code" : "integer" }, { "code" : "markdown" }, { "code" : "oid" }, { "code" : "positiveInt" }, { "code" : "string" }, { "code" : "time" }, { "code" : "unsignedInt" }, { "code" : "uri" }, { "code" : "Address" }, { "code" : "Age" }, { "code" : "Annotation" }, { "code" : "Attachment" }, { "code" : "CodeableConcept" }, { "code" : "Coding" }, { "code" : "ContactPoint" }, { "code" : "Count" }, { "code" : "Distance" }, { "code" : "Duration" }, { "code" : "HumanName" }, { "code" : "Identifier" }, { "code" : "Money" }, { "code" : "Period" }, { "code" : "Quantity" }, { "code" : "Range" }, { "code" : "Ratio" }, { "code" : "Reference" }, { "code" : "SampledData" }, { "code" : "Signature" }, { "code" : "Timing" }, { "code" : "Meta" } ], "mapping" : [ { "identity" : "rim", "map" : "N/A" } ] } ] }, "differential" : { "element" : [ { "id" : "Extension:ethnicity", "path" : "Extension", "sliceName" : "ethnicity", "short" : "US Core ethnicity Extension", "definition" : "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](http://www.cdc.gov/phin/resources/vocabulary/index.html) 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.", "min" : 0, "max" : "1", "isModifier" : false }, { "id" : "Extension:ethnicity.extension:ombcategory", "path" : "Extension.extension", "sliceName" : "ombCategory", "short" : "Hispanic or Latino|Not Hispanic or Latino", "definition" : "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](https://www.whitehouse.gov/omb/fedreg_1997standards).", "min" : 0, "max" : "1", "type" : [ { "code" : "Extension" } ], "mustSupport" : true, "isModifier" : false, "mapping" : [ { "identity" : "iso11179", "map" : "/ClinicalDocument/recordTarget/patientRole/patient/ethnicGroupCode" } ] }, { "id" : "Extension:ethnicity.extension:ombcategory.url", "path" : "Extension.extension.url", "min" : 1, "max" : "1", "type" : [ { "code" : "uri" } ], "fixedUri" : "ombCategory" }, { "id" : "Extension:ethnicity.extension:ombcategory.valueCoding", "path" : "Extension.extension.valueCoding", "min" : 1, "max" : "1", "type" : [ { "code" : "Coding" } ], "binding" : { "strength" : "required", "description" : "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](https://www.whitehouse.gov/omb/fedreg_1997standards).", "valueSetReference" : { "reference" : "http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category" } } }, { "id" : "Extension:ethnicity.extension:detailed", "path" : "Extension.extension", "sliceName" : "detailed", "short" : "Extended ethnicity codes", "definition" : "The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.", "min" : 0, "max" : "*", "type" : [ { "code" : "Extension" } ], "isModifier" : false, "mapping" : [ { "identity" : "iso11179", "map" : "/ClinicalDocument/recordTarget/patientRole/patient/sdtc:ethnicGroupCode" } ] }, { "id" : "Extension:ethnicity.extension:detailed.url", "path" : "Extension.extension.url", "min" : 1, "max" : "1", "type" : [ { "code" : "uri" } ], "fixedUri" : "detailed" }, { "id" : "Extension:ethnicity.extension:detailed.valueCoding", "path" : "Extension.extension.valueCoding", "min" : 1, "max" : "1", "type" : [ { "code" : "Coding" } ], "binding" : { "strength" : "required", "description" : "The 41 [CDC ethnicity codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 2 OMB ethnicity category codes.", "valueSetReference" : { "reference" : "http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity" } } }, { "id" : "Extension:ethnicity.extension:text", "path" : "Extension.extension", "sliceName" : "text", "short" : "ethnicity Text", "definition" : "Plain text representation of the ethnicity concept(s).", "min" : 1, "max" : "1", "type" : [ { "code" : "Extension" } ], "mustSupport" : true, "isModifier" : false }, { "id" : "Extension:ethnicity.extension:text.url", "path" : "Extension.extension.url", "min" : 1, "max" : "1", "type" : [ { "code" : "uri" } ], "fixedUri" : "text" }, { "id" : "Extension:ethnicity.extension:text.valueString", "path" : "Extension.extension.valueString", "min" : 1, "max" : "1", "type" : [ { "code" : "string" } ] }, { "id" : "Extension:ethnicity.url", "path" : "Extension.url", "min" : 1, "max" : "1", "fixedUri" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity" } ] } }