US Core Implementation Guide
6.0.0-ballot - STU6 Ballot
US
US Core Implementation Guide
6.0.0-ballot - STU6 Ballot
US
This page is part of the US Core (v6.0.0-ballot: STU6 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
| Active as of 2022-09-30 |
Definitions for the us-core-tribal-affiliation extension.
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | A tribe or band with which a person associates whether or not they are an enrolled member. Optional Extension Element - found in all resources. |
| 2. Extension.extension:tribalAffiliation | |
| SliceName | tribalAffiliation |
| Definition | Affiliated tribe or band name |
| Control | 1..1 |
| Type | Extension |
| Must Support | true |
| 3. Extension.extension:tribalAffiliation.url | |
| Control | 1..1 |
| Type | uri |
| Fixed Value | tribalAffiliation |
| 4. Extension.extension:tribalAffiliation.value[x] | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TribalEntityUS; other codes may be used where these codes are not suitable Tribal Entity recognized by the United States Bureau Of Indian Affairs |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 5. Extension.extension:isEnrolled | |
| SliceName | isEnrolled |
| Definition | Whether the individual is an enrolled tribe member |
| Control | 0..1 |
| Type | Extension |
| 6. Extension.extension:isEnrolled.url | |
| Control | 1..1 |
| Type | uri |
| Fixed Value | isEnrolled |
| 7. Extension.extension:isEnrolled.value[x] | |
| Control | 1..1 |
| Type | boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 8. Extension.url | |
| Fixed Value | http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation |
| 9. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | A tribe or band with which a person associates whether or not they are an enrolled member. Optional Extension Element - found in all resources. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element 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.extension:tribalAffiliation | |
| SliceName | tribalAffiliation |
| Definition | Affiliated tribe or band name 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. |
| Control | 10..1* |
| Type | Extension |
| Must Support | true |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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()) |
| 3. Extension.extension:tribalAffiliation.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | tribalAffiliation |
| 4. Extension.extension:tribalAffiliation.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 10..1 |
| Binding | The codes SHALL be taken from TribalEntityUS; other codes may be used where these codes are not suitableFor codes, see (unbound) Tribal Entity recognized by the United States Bureau Of Indian Affairs |
| Type | Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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 | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 5. Extension.extension:isEnrolled | |
| SliceName | isEnrolled |
| Definition | Whether the individual is an enrolled tribe member 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. |
| Control | 0..1* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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()) |
| 6. Extension.extension:isEnrolled.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | isEnrolled |
| 7. Extension.extension:isEnrolled.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 10..1 |
| Type | Choice of: boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, 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, Expression, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation |
| 9. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element 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.
| 1. Extension | |
| Definition | A tribe or band with which a person associates whether or not they are an enrolled member. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| 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. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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 are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.extension:tribalAffiliation | |
| SliceName | tribalAffiliation |
| Definition | Affiliated tribe or band name |
| Control | 1..1 |
| Type | Extension |
| Must Support | true |
| Invariants | Defined on this element 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()) |
| 5. Extension.extension:tribalAffiliation.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 6. Extension.extension:tribalAffiliation.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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:tribalAffiliation.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | tribalAffiliation |
| 8. Extension.extension:tribalAffiliation.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TribalEntityUS; other codes may be used where these codes are not suitable Tribal Entity recognized by the United States Bureau Of Indian Affairs |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. Extension.extension:isEnrolled | |
| SliceName | isEnrolled |
| Definition | Whether the individual is an enrolled tribe member |
| Control | 0..1 |
| Type | Extension |
| Invariants | Defined on this element 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()) |
| 10. Extension.extension:isEnrolled.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 11. Extension.extension:isEnrolled.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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element 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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Extension.extension:isEnrolled.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | isEnrolled |
| 13. Extension.extension:isEnrolled.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 1..1 |
| Type | boolean |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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. |
| Fixed Value | http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation |
| 15. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
IG © 2022+ HL7 International - Cross-Group Projects. Package hl7.fhir.us.core#6.0.0-ballot based on FHIR 4.0.1. Generated 2022-12-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change