US Core Implementation Guide
7.0.0-ballot - Ballot United States of America flag

This page is part of the US Core (v7.0.0-ballot: STU7 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 6.1.0. For a full list of available versions, see the Directory of published versions

Extension: US Core Tribal Affiliation Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation Version: 7.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreTribalAffiliationExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient
  • Element ID RelatedPerson
  • Element ID Person
  • Element ID Practitioner
  • Element ID FamilyMemberHistory

Profile Specific Implementation Guidance:

  • isEnrolled is an optional sub-extension for systems that choose to collect this information

Usage info

Usage:

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

Complex Extension: This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

  • tribalAffiliation: CodeableConcept: Affiliated tribe or band name
  • isEnrolled: boolean: Whether the individual is an enrolled tribe member

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionTribal Affiliation Extension
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:tribalAffiliation S1..1ExtensionAffiliated tribe or band name
.... url 1..1uri"tribalAffiliation"
.... value[x] 1..1CodeableConceptTribal Entity US
Binding: TribalEntityUS (extensible): Tribal Entity recognized by the United States Bureau Of Indian Affairs.

... extension:isEnrolled 0..1ExtensionEnrolled tribe member
.... url 1..1uri"isEnrolled"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionTribal Affiliation Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:tribalAffiliation S1..1ExtensionAffiliated tribe or band name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"tribalAffiliation"
.... value[x] 1..1CodeableConceptTribal Entity US
Binding: TribalEntityUS (extensible): Tribal Entity recognized by the United States Bureau Of Indian Affairs.

... extension:isEnrolled 0..1ExtensionEnrolled tribe member
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"isEnrolled"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.

  • tribalAffiliation: CodeableConcept: Affiliated tribe or band name
  • isEnrolled: boolean: Whether the individual is an enrolled tribe member

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionTribal Affiliation Extension
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:tribalAffiliation S1..1ExtensionAffiliated tribe or band name
.... url 1..1uri"tribalAffiliation"
.... value[x] 1..1CodeableConceptTribal Entity US
Binding: TribalEntityUS (extensible): Tribal Entity recognized by the United States Bureau Of Indian Affairs.

... extension:isEnrolled 0..1ExtensionEnrolled tribe member
.... url 1..1uri"isEnrolled"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionTribal Affiliation Extension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:tribalAffiliation S1..1ExtensionAffiliated tribe or band name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"tribalAffiliation"
.... value[x] 1..1CodeableConceptTribal Entity US
Binding: TribalEntityUS (extensible): Tribal Entity recognized by the United States Bureau Of Indian Affairs.

... extension:isEnrolled 0..1ExtensionEnrolled tribe member
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"isEnrolled"
.... value[x] 1..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:tribalAffiliation.value[x]extensibleTribalEntityUS

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()