Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Tribal Affiliation Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/TribalAffiliationObservation Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: TribalAffiliationObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.506:2023-05-01

This template represents the tribe or band that an individual associates with, within the United States. It is recommended systems include the Tribal Affiliation Observation in the Social History section. The tribe or band name is drawn from an HL7 code system that aligns with the Indian entities list, a list of tribes or bands recognized by and eligible to receive services from the United States Bureau of Indian Affairs. This template does not represent tribal enrollment. Please see Indian Entities Recognized by and Eligible To Receive Services From the United States Bureau of Indian Affairs.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from SocialHistoryObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... templateId 2..*II
... templateId:tribal-affiliation-obs 1..1II
.... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
.... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... code 1..1CDTribal Affiliation
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... @code 1..1cs
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
.... low 0..0
.... center 0..0
.... width 0..0
.... high 0..0
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredTribalEntityUS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:social-history-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.38
..... @extension 1..1stRequired Pattern: 2022-06-01
.... templateId:tribal-affiliation-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code C1..1CDTribal Affiliation
Binding: Social History Type (preferred)
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)
Additional BindingsPurposeDocumentation
Social Determinants of Health ConditionsPreferred Binding
Social Determinant of Health Observations

... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:social-history-entry-sprt-obs 0..*EntryRelationshipWhen an Assessment Scale Observation is contained in a Social History Observation instance that is a Social Determinant of Health Social History Observation, that Assessment Scale Observation MAY contain Assessment Scale Supporting Observations that contain LOINC question and answer pairs from SDOH screening instruments.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... observation C1..1AssessmentScaleObservationBase for all types and resources
.... entryRelationship:social-history-entry-sprt-act 0..*EntryRelationshipWhen an Entry Reference is contained in a Social History Template instance that is a Social Determinant of Health Social History, that Entry Reference **MAY** reference an Assessment Scale Observation elsewhere in the document that represent LOINC question and answer pairs from SDOH screening instruments.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... act C1..1EntryReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codepreferredSocialHistoryType
Observation.statusCoderequiredActStatus
Observation.valuerequiredTribalEntityUS
Observation.entryRelationship:social-history-entry-sprt-obs.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:social-history-entry-sprt-act.typeCoderequiredFixed Value: SPRT

Constraints

IdGradePath(s)DetailsRequirements
4515-8555errorObservationIf Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM.
:
4515-32956warningObservation.codeIf @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956).
: codeSystem = '2.16.840.1.113883.6.1' or translation.where(codeSystem = '2.16.840.1.113883.6.1').exists()
should-sh-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:social-history-entry-sprt-obs.observation, Observation.entryRelationship:social-history-entry-sprt-act.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-valuewarningObservationSHOULD contain value
: value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:social-history-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.38
..... @extension 1..1stRequired Pattern: 2022-06-01
.... templateId:tribal-affiliation-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code C1..1CDTribal Affiliation
Binding: Social History Type (preferred)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TEL
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)
Additional BindingsPurposeDocumentation
Social Determinants of Health ConditionsPreferred Binding
Social Determinant of Health Observations

... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (example)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:social-history-entry-sprt-obs 0..*EntryRelationshipWhen an Assessment Scale Observation is contained in a Social History Observation instance that is a Social Determinant of Health Social History Observation, that Assessment Scale Observation MAY contain Assessment Scale Supporting Observations that contain LOINC question and answer pairs from SDOH screening instruments.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1AssessmentScaleObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:social-history-entry-sprt-act 0..*EntryRelationshipWhen an Entry Reference is contained in a Social History Template instance that is a Social Determinant of Health Social History, that Entry Reference **MAY** reference an Assessment Scale Observation elsewhere in the document that represent LOINC question and answer pairs from SDOH screening instruments.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:social-history-obs.nullFlavorrequiredCDANullFlavor
Observation.templateId:tribal-affiliation-obs.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codepreferredSocialHistoryType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.valuerequiredTribalEntityUS
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.entryRelationship:social-history-entry-sprt-obs.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-obs.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-obs.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:social-history-entry-sprt-act.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-act.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-act.typeCoderequiredFixed Value: SPRT
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4515-8555errorObservationIf Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM.
:
4515-32956warningObservation.codeIf @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956).
: codeSystem = '2.16.840.1.113883.6.1' or translation.where(codeSystem = '2.16.840.1.113883.6.1').exists()
should-sh-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:social-history-entry-sprt-obs.observation, Observation.entryRelationship:social-history-entry-sprt-act.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-valuewarningObservationSHOULD contain value
: value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from SocialHistoryObservation

Summary

Mandatory: 6 elements
Prohibited: 4 elements

Differential View

This structure is derived from SocialHistoryObservation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... templateId 2..*II
... templateId:tribal-affiliation-obs 1..1II
.... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
.... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... code 1..1CDTribal Affiliation
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... @code 1..1cs
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
.... low 0..0
.... center 0..0
.... width 0..0
.... high 0..0
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredTribalEntityUS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:social-history-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.38
..... @extension 1..1stRequired Pattern: 2022-06-01
.... templateId:tribal-affiliation-obs 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... code C1..1CDTribal Affiliation
Binding: Social History Type (preferred)
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)
Additional BindingsPurposeDocumentation
Social Determinants of Health ConditionsPreferred Binding
Social Determinant of Health Observations

... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:social-history-entry-sprt-obs 0..*EntryRelationshipWhen an Assessment Scale Observation is contained in a Social History Observation instance that is a Social Determinant of Health Social History Observation, that Assessment Scale Observation MAY contain Assessment Scale Supporting Observations that contain LOINC question and answer pairs from SDOH screening instruments.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... observation C1..1AssessmentScaleObservationBase for all types and resources
.... entryRelationship:social-history-entry-sprt-act 0..*EntryRelationshipWhen an Entry Reference is contained in a Social History Template instance that is a Social Determinant of Health Social History, that Entry Reference **MAY** reference an Assessment Scale Observation elsewhere in the document that represent LOINC question and answer pairs from SDOH screening instruments.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... act C1..1EntryReferenceBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codepreferredSocialHistoryType
Observation.statusCoderequiredActStatus
Observation.valuerequiredTribalEntityUS
Observation.entryRelationship:social-history-entry-sprt-obs.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:social-history-entry-sprt-act.typeCoderequiredFixed Value: SPRT

Constraints

IdGradePath(s)DetailsRequirements
4515-8555errorObservationIf Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM.
:
4515-32956warningObservation.codeIf @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956).
: codeSystem = '2.16.840.1.113883.6.1' or translation.where(codeSystem = '2.16.840.1.113883.6.1').exists()
should-sh-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:social-history-entry-sprt-obs.observation, Observation.entryRelationship:social-history-entry-sprt-act.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-valuewarningObservationSHOULD contain value
: value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C1..1SocialHistoryObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, referenceRange, sdtcInFulfillmentOf1, templateId, templateId, classCode, moodCode, id, code, text, statusCode, effectiveTime, value, author, entryRelationship, entryRelationship, entryRelationship
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 2..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:social-history-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.38
..... @extension 1..1stRequired Pattern: 2022-06-01
.... templateId:tribal-affiliation-obs 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.506
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassObservation (2.0.0) (required)
Fixed Value: OBS
... @moodCode 1..1csBinding: XActMoodDocumentObservation (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 1..*II
... code C1..1CDTribal Affiliation
Binding: Social History Type (preferred)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csRequired Pattern: 95370-3
.... @codeSystem 1..1oid, uuid, ruidLOINC
Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TEL
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe effectiveTime reflects a point in time observation when the current tribal affiliation status was observed. Note: This template represents a "snapshot in time" observation, simply reflecting the patient's tribal affiliation at the time of the observation. As a result, the effectiveTime is constrained to just a time stamp.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
... priorityCode 0..1CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: AllLanguages (required)
... value 1..1CDNOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
Binding: TribalEntityUS (required)
Additional BindingsPurposeDocumentation
Social Determinants of Health ConditionsPreferred Binding
Social Determinant of Health Observations

... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (example)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation
.... entryRelationship:social-history-entry-sprt-obs 0..*EntryRelationshipWhen an Assessment Scale Observation is contained in a Social History Observation instance that is a Social Determinant of Health Social History Observation, that Assessment Scale Observation MAY contain Assessment Scale Supporting Observations that contain LOINC question and answer pairs from SDOH screening instruments.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1AssessmentScaleObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:social-history-entry-sprt-act 0..*EntryRelationshipWhen an Entry Reference is contained in a Social History Template instance that is a Social Determinant of Health Social History, that Entry Reference **MAY** reference an Assessment Scale Observation elsewhere in the document that represent LOINC question and answer pairs from SDOH screening instruments.
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SPRT
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act C1..1EntryReferenceBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipType (2.0.0) (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.nullFlavorrequiredCDANullFlavor
Observation.typeId.nullFlavorrequiredCDANullFlavor
Observation.templateId:social-history-obs.nullFlavorrequiredCDANullFlavor
Observation.templateId:tribal-affiliation-obs.nullFlavorrequiredCDANullFlavor
Observation.classCoderequiredFixed Value: OBS
Observation.moodCoderequiredFixed Value: EVN
Observation.codepreferredSocialHistoryType
Observation.code.nullFlavorrequiredCDANullFlavor
Observation.text.nullFlavorrequiredCDANullFlavor
Observation.text.compressionrequiredCDACompressionAlgorithm
Observation.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Observation.text.mediaTypeexampleMediaType
Observation.text.representationrequiredBinaryDataEncoding
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.nullFlavorrequiredCDANullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeexampleActPriority
Observation.languageCoderequiredAllLanguages
Observation.valuerequiredTribalEntityUS
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeexampleObservationMethod
Observation.entryRelationship:social-history-entry-sprt-obs.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-obs.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-obs.typeCoderequiredFixed Value: SPRT
Observation.entryRelationship:social-history-entry-sprt-act.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-act.typeId.nullFlavorrequiredCDANullFlavor
Observation.entryRelationship:social-history-entry-sprt-act.typeCoderequiredFixed Value: SPRT
Observation.referenceRange.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeId.nullFlavorrequiredCDANullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4515-8555errorObservationIf Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM.
:
4515-32956warningObservation.codeIf @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956).
: codeSystem = '2.16.840.1.113883.6.1' or translation.where(codeSystem = '2.16.840.1.113883.6.1').exists()
should-sh-authorwarningObservationSHOULD contain author
: author.exists()
should-text-ref-valuewarningObservation, Observation.entryRelationship:social-history-entry-sprt-obs.observation, Observation.entryRelationship:social-history-entry-sprt-act.actSHOULD contain text/reference/@value
: text.reference.value.exists()
should-valuewarningObservationSHOULD contain value
: value.exists()
value-starts-octothorpeerrorObservation.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from SocialHistoryObservation

Summary

Mandatory: 6 elements
Prohibited: 4 elements

 

Other representations of profile: CSV, Excel