Canadian Baseline
1.1.0 - CI Build
Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions
Draft as of 2019-12-18 |
Definitions for the ext-ethnicity extension.
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | A code classifying the person's ethnic group or ethnicity as the category of people who identify with each other, usually on the basis of a presumed common genealogy or ancestry or on other similarities. |
Comments | This attribute is based on the belief of the person or the person reporting the attribute, not on any formal analysis of genetic, geneological or historical relationships as these would need to be captured as observations. |
Control | 0..1 |
Is Modifier | false |
2. Extension.url | |
Control | 1..1 |
Fixed Value | http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity |
4. Extension.valueCoding | |
Definition | Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality |
Control | 1..1 |
Binding | The codes SHOULD be taken from EthnicityCode (preferred to https://fhir.infoway-inforoute.ca/ValueSet/ethnicitycode )One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. |
Example | <br/><b>Example of the Ethnicity extension</b>:{ "system" : "http://snomed.info/sct", "code" : "733446001", "display" : "Canadian (ethnic group)" } |
6. Extension.valueCoding.system | |
Short | Identity of the terminology system |
Comments | Expected URI is one of the following: SNOMED CT International (http://snomed.info/sct) or SNOMED CT CA Edition (https://fhir.infoway-inforoute.ca/CodeSystem/snomedctcaextension) |
Control | 1..? |
8. Extension.valueCoding.code | |
Definition | One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. |
Short | Code defining ethnicity concept |
Control | 1..? |
10. Extension.valueCoding.display | |
Definition | Plain text representation of the ethnicity concept |
Short | Optional description of the ethnicity code |
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | A code classifying the person's ethnic group or ethnicity as the category of people who identify with each other, usually on the basis of a presumed common genealogy or ancestry or on other similarities. Optional Extension Element - found in all resources. |
Short | ExtensionOptional Extensions Element |
Comments | This attribute is based on the belief of the person or the person reporting the attribute, not on any formal analysis of genetic, geneological or historical relationships as these would need to be captured as observations. |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
2. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity |
4. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
6. Extension.value[x]:valueCoding | |
Slice Name | valueCoding |
Definition | Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Binding | The codes SHOULD be taken from For codes, see EthnicityCode (preferred to https://fhir.infoway-inforoute.ca/ValueSet/ethnicitycode )One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. |
Type | Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Example | <br/><b>Example of the Ethnicity extension</b>:{ "system" : "http://snomed.info/sct", "code" : "733446001", "display" : "Canadian (ethnic group)" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Extension.value[x]:valueCoding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | Expected URI is one of the following: SNOMED CT International (http://snomed.info/sct) or SNOMED CT CA Edition (https://fhir.infoway-inforoute.ca/CodeSystem/snomedctcaextension) The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Extension.value[x]:valueCoding.code | |
Definition | One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Short | Code defining ethnicity conceptSymbol in syntax defined by the system |
Control | 10..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | A code classifying the person's ethnic group or ethnicity as the category of people who identify with each other, usually on the basis of a presumed common genealogy or ancestry or on other similarities. |
Short | Extension |
Comments | This attribute is based on the belief of the person or the person reporting the attribute, not on any formal analysis of genetic, geneological or historical relationships as these would need to be captured as observations. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
2. Extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. Extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
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. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity |
8. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 1..1 |
Type | Coding |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
10. Extension.value[x]:valueCoding | |
Slice Name | valueCoding |
Definition | Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality |
Short | Value of extension |
Control | 1..1 |
Binding | The codes SHOULD be taken from EthnicityCode (preferred to https://fhir.infoway-inforoute.ca/ValueSet/ethnicitycode )One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. |
Type | Coding |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Example | <br/><b>Example of the Ethnicity extension</b>:{ "system" : "http://snomed.info/sct", "code" : "733446001", "display" : "Canadian (ethnic group)" } |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. Extension.value[x]:valueCoding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
14. Extension.value[x]:valueCoding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
Comments | 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on Extension.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Extension.value[x]:valueCoding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | Expected URI is one of the following: SNOMED CT International (http://snomed.info/sct) or SNOMED CT CA Edition (https://fhir.infoway-inforoute.ca/CodeSystem/snomedctcaextension) |
Control | 1..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
18. Extension.value[x]:valueCoding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Short | Version of the system - if relevant |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. Extension.value[x]:valueCoding.code | |
Definition | One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality. |
Short | Code defining ethnicity concept |
Control | 1..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. Extension.value[x]:valueCoding.display | |
Definition | Plain text representation of the ethnicity concept |
Short | Optional description of the ethnicity code |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. Extension.value[x]:valueCoding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | If this coding was chosen directly by the user |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |