STU3 Candidate
AdministrationThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
US Core ethnicity Extension
{
"resourceType": "StructureDefinition",
"id": "us-core-ethnicity",
"url": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity",
"name": "US Core ethnicity Extension",
"title": "US Core ethnicity Extension",
"status": "draft",
"publisher": "Health Level Seven International (US Realm Steering Committee)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/Committees/usrealm"
}
]
}
],
"date": "2013-12-03",
"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:\r- Hispanic or Latino\r- Not Hispanic or Latino.",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
},
{
"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:uscoreethnicityextension",
"path": "Extension",
"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:\r- Hispanic or Latino\r- 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"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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:uscoreethnicityextension.extension",
"path": "Extension.extension",
"slicing": {
"id": "76",
"discriminator": [
"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:uscoreethnicityextension.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": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "cda",
"map": "/ClinicalDocument/recordTarget/patientRole/patient/ethnicGroupCode"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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:uscoreethnicityextension.extension:ombcategory.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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.",
"comments": "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:uscoreethnicityextension.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/ValueSet/omb-ethnicity"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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"
}
],
"mapping": [
{
"identity": "cda",
"map": "/ClinicalDocument/recordTarget/patientRole/patient/sdtc:ethnicGroupCode"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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:uscoreethnicityextension.extension:detailed.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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.",
"comments": "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:uscoreethnicityextension.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/ValueSet/detailed-ethnicity"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:uscoreethnicityextension.extension:text",
"path": "Extension.extension",
"sliceName": "text",
"short": "ethnicity Text",
"definition": "Plain text representation of the ethnicity concept(s).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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:uscoreethnicityextension.extension:text.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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.",
"comments": "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:uscoreethnicityextension.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:uscoreethnicityextension.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.",
"comments": "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/StructureDefinition/us-core-ethnicity",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:uscoreethnicityextension.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:uscoreethnicityextension",
"path": "Extension",
"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:\r- Hispanic or Latino\r- Not Hispanic or Latino.",
"min": 0,
"max": "1"
},
{
"id": "Extension:uscoreethnicityextension.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": 1,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "cda",
"map": "/ClinicalDocument/recordTarget/patientRole/patient/ethnicGroupCode"
}
]
},
{
"id": "Extension:uscoreethnicityextension.extension:ombcategory.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:uscoreethnicityextension.extension:ombcategory.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "ombCategory"
},
{
"id": "Extension:uscoreethnicityextension.extension:ombcategory.value[x]",
"path": "Extension.extension.value[x]",
"min": 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/ValueSet/omb-ethnicity"
}
}
},
{
"id": "Extension:uscoreethnicityextension.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"
}
],
"mapping": [
{
"identity": "cda",
"map": "/ClinicalDocument/recordTarget/patientRole/patient/sdtc:ethnicGroupCode"
}
]
},
{
"id": "Extension:uscoreethnicityextension.extension:detailed.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:uscoreethnicityextension.extension:detailed.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "detailed"
},
{
"id": "Extension:uscoreethnicityextension.extension:detailed.value[x]",
"path": "Extension.extension.value[x]",
"min": 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/ValueSet/detailed-ethnicity"
}
}
},
{
"id": "Extension:uscoreethnicityextension.extension:text",
"path": "Extension.extension",
"sliceName": "text",
"short": "ethnicity Text",
"definition": "Plain text representation of the ethnicity concept(s).",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:uscoreethnicityextension.extension:text.extension:extension",
"path": "Extension.extension.extension",
"sliceName": "extension",
"max": "0"
},
{
"id": "Extension:uscoreethnicityextension.extension:text.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "text"
},
{
"id": "Extension:uscoreethnicityextension.extension:text.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension:uscoreethnicityextension.url",
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
},
{
"id": "Extension:uscoreethnicityextension.value[x]",
"path": "Extension.value[x]",
"min": 0,
"max": "0"
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:25+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change