Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: TribalAffiliationObservation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the TribalAffiliationObservation logical model.

Guidance on how to interpret the contents of this table can be found here

0. Observation
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-2).

4. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4537-3).

6. Observation.templateId
Control2..?
8. Observation.templateId:templateId1
Slice NametemplateId1
ShorttemplateId
Comments

SHALL contain exactly one [1..1] templateId (CONF:4537-1) such that it

Control1..1
10. Observation.templateId:templateId1.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.506" (CONF:4537-4).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.506
12. Observation.templateId:templateId1.extension
Comments

SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-5).

Control1..?
Pattern Value2023-05-01
14. Observation.code
Comments

SHALL contain exactly one [1..1] code (CONF:4537-6).

16. Observation.code.code
Comments

This code SHALL contain exactly one [1..1] @code="95370-3" Tribal Affiliation (CONF:4537-7).

Control1..?
Pattern Value95370-3
18. Observation.code.codeSystem
Comments

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:4537-8).

Control1..?
Pattern Value2.16.840.1.113883.6.1
20. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:4537-9).

22. Observation.statusCode.code
Comments

This statusCode SHALL contain exactly one [1..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4537-10).

24. Observation.effectiveTime
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:4537-11).

26. Observation.effectiveTime.low
Comments

This effectiveTime SHALL NOT contain exactly one [1..1] low (CONF:4537-33048).

Control1..?
28. Observation.effectiveTime.center
Comments

This effectiveTime SHALL NOT contain exactly one [1..1] center (CONF:4537-33051).

Control1..?
30. Observation.effectiveTime.width
Comments

This effectiveTime SHALL NOT contain exactly one [1..1] width (CONF:4537-33049).

Control1..?
32. Observation.effectiveTime.high
Comments

This effectiveTime SHALL NOT contain exactly one [1..1] high (CONF:4537-33050).

Control1..?
34. Observation.value
Comments

SHALL contain exactly one [1..1] value, which SHALL be selected from ValueSet TribalEntityUS http://terminology.hl7.org/ValueSet/v3-TribalEntityUS DYNAMIC (CONF:4537-12).

Control1..?
BindingThe codes SHALL be taken from TribalEntityUS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC

Guidance on how to interpret the contents of this table can be found here

0. Observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-2).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueOBS
4. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4537-3).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. Observation.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
8. Observation.templateId:social-history-obs
Slice Namesocial-history-obs
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

ShorttemplateId
Comments

SHALL contain exactly one [1..1] templateId (CONF:4515-8550) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Observation.templateId:social-history-obs.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.38" (CONF:4515-10526).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.38
12. Observation.templateId:social-history-obs.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Comments

SHALL contain exactly one [1..1] @extension="2022-06-01" (CONF:4515-32495).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2022-06-01
14. Observation.templateId:templateId1
Slice NametemplateId1
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

ShorttemplateId
Comments

SHALL contain exactly one [1..1] templateId (CONF:4537-1) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Observation.templateId:templateId1.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.506" (CONF:4537-4).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.506
18. Observation.templateId:templateId1.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Comments

SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-5).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2023-05-01
20. Observation.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

SHALL contain at least one [1..*] id (CONF:4515-8551).


Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control10..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
22. Observation.code
Definition

Describes what was observed. Sometimes this is called the observation "name".

ShortType of observation (code / type)
Comments

SHALL contain exactly one [1..1] code (CONF:4537-6).


All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.

Control1..1
This element is affected by the following invariants: obs-7
BindingThe codes SHOULD be taken from For example codes, see Social History Typehttp://hl7.org/fhir/ValueSet/observation-codes
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept
Is Modifierfalse
XML FormatThe type of this property is determined using the xsi:typeattribute.
Requirements

Knowing what kind of observation is being made is essential to understanding the observation.

Alternate NamesName
Invariants4515-32956: If @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). ()
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Observation.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

This code SHALL contain exactly one [1..1] @code="95370-3" Tribal Affiliation (CONF:4537-7).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Pattern Value95370-3
26. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Comments

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:4537-8).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
Pattern Value2.16.840.1.113883.6.1
28. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:4537-9).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
30. Observation.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

This statusCode SHALL contain exactly one [1..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4537-10).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valuecompleted
32. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
34. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
36. Observation.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
38. Observation.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
40. Observation.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
42. Observation.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
44. Observation.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
46. Observation.effectiveTime
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:4537-11).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
48. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] low (CONF:4537-33048).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
50. Observation.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] center (CONF:4537-33051).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
52. Observation.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] width (CONF:4537-33049).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
54. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] high (CONF:4537-33050).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
56. Observation.value
Comments

SHALL contain exactly one [1..1] value, which SHALL be selected from ValueSet TribalEntityUS http://terminology.hl7.org/ValueSet/v3-TribalEntityUS DYNAMIC (CONF:4537-12).

Control1..1
BindingThe codes SHALL be taken from TribalEntityUS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
Invariants4515-8555: If 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-32957: If the Social History Observation is a Social Determinant of Health Observation, the observation/value code **SHOULD** be selected from ValueSet [Social Determinant of Health Conditions 2.16.840.1.113762.1.4.1196.788](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1196.788/expansion) **DYNAMIC** (CONF:4515-32957). ()
58. Observation.entryRelationship
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:4515-32969) such that it

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ act
  • value @ observation
  • value @ typeCode
60. Observation.entryRelationship:social-history-entry-sprt-obs
Slice Namesocial-history-entry-sprt-obs
ShortentryRelationship
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:4515-32958) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
62. Observation.entryRelationship:social-history-entry-sprt-obs.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32960).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSPRT
64. Observation.entryRelationship:social-history-entry-sprt-obs.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Assessment Scale Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.69) (CONF:4515-32959).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Observation.entryRelationship:social-history-entry-sprt-act
Slice Namesocial-history-entry-sprt-act
ShortentryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
68. Observation.entryRelationship:social-history-entry-sprt-act.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32971).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSPRT
70. Observation.entryRelationship:social-history-entry-sprt-act.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:4515-32970).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-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. Observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4537-2).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueOBS
4. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4537-3).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. Observation.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
8. Observation.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. Observation.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Observation.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
14. Observation.templateId:social-history-obs
Slice Namesocial-history-obs
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

ShorttemplateId
Comments

SHALL contain exactly one [1..1] templateId (CONF:4515-8550) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Observation.templateId:social-history-obs.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
18. Observation.templateId:social-history-obs.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
20. Observation.templateId:social-history-obs.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
22. Observation.templateId:social-history-obs.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.38" (CONF:4515-10526).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.38
24. Observation.templateId:social-history-obs.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Comments

SHALL contain exactly one [1..1] @extension="2022-06-01" (CONF:4515-32495).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2022-06-01
26. Observation.templateId:templateId1
Slice NametemplateId1
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

ShorttemplateId
Comments

SHALL contain exactly one [1..1] templateId (CONF:4537-1) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
28. Observation.templateId:templateId1.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
30. Observation.templateId:templateId1.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
32. Observation.templateId:templateId1.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
34. Observation.templateId:templateId1.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.506" (CONF:4537-4).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Pattern Value2.16.840.1.113883.10.20.22.4.506
36. Observation.templateId:templateId1.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Comments

SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-5).

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
Pattern Value2023-05-01
38. Observation.id
Comments

SHALL contain at least one [1..*] id (CONF:4515-8551).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
40. Observation.code
Comments

SHALL contain exactly one [1..1] code (CONF:4537-6).

Control1..1
BindingThe codes SHOULD be taken from Social History Type
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
Invariants4515-32956: If @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). ()
42. Observation.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
44. Observation.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

This code SHALL contain exactly one [1..1] @code="95370-3" Tribal Affiliation (CONF:4537-7).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Pattern Value95370-3
46. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Comments

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1 STATIC) (CONF:4537-8).

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
Pattern Value2.16.840.1.113883.6.1
48. Observation.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
50. Observation.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
52. Observation.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
54. Observation.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
56. Observation.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
58. Observation.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
60. Observation.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
62. Observation.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
64. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ST
66. Observation.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatThe type of this property is determined using the xsi:typeattribute.
68. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:4537-9).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
70. Observation.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
72. Observation.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Comments

This statusCode SHALL contain exactly one [1..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:4537-10).

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode
Fixed Valuecompleted
74. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System
76. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Name
78. Observation.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCode System Version
80. Observation.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplay Name
82. Observation.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring(oid: ISO Object Identifier)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
84. Observation.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
86. Observation.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
88. Observation.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
90. Observation.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
92. Observation.effectiveTime
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:4537-11).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
94. Observation.effectiveTime.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
96. Observation.effectiveTime.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
Typestring(ts: Point in Time)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Date FormatYYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML FormatIn the XML format, this property is represented as an attribute.
98. Observation.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
BindingThe codes SHALL be taken from SetOperator
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValueI
100. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] low (CONF:4537-33048).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
102. Observation.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] center (CONF:4537-33051).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
104. Observation.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] width (CONF:4537-33049).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
LabelWidth
106. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Comments

This effectiveTime SHALL NOT contain exactly one [1..1] high (CONF:4537-33050).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
108. Observation.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
110. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
112. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
114. Observation.value
Comments

SHALL contain exactly one [1..1] value, which SHALL be selected from ValueSet TribalEntityUS http://terminology.hl7.org/ValueSet/v3-TribalEntityUS DYNAMIC (CONF:4537-12).

Control1..1
BindingThe codes SHALL be taken from TribalEntityUS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
Invariants4515-8555: If 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-32957: If the Social History Observation is a Social Determinant of Health Observation, the observation/value code **SHOULD** be selected from ValueSet [Social Determinant of Health Conditions 2.16.840.1.113762.1.4.1196.788](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1196.788/expansion) **DYNAMIC** (CONF:4515-32957). ()
116. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
118. Observation.methodCode
Control0..*
BindingUnless not suitable, these codes SHALL be taken from ObservationMethod
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
120. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
122. Observation.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
124. Observation.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
126. Observation.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
128. Observation.author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4515-31869).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. Observation.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
132. Observation.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
134. Observation.entryRelationship
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:4515-32969) such that it

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ act
  • value @ observation
  • value @ typeCode
136. Observation.entryRelationship:social-history-entry-sprt-obs
Slice Namesocial-history-entry-sprt-obs
ShortentryRelationship
Comments

MAY contain zero or more [0..*] entryRelationship (CONF:4515-32958) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
138. Observation.entryRelationship:social-history-entry-sprt-obs.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
140. Observation.entryRelationship:social-history-entry-sprt-obs.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
142. Observation.entryRelationship:social-history-entry-sprt-obs.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
144. Observation.entryRelationship:social-history-entry-sprt-obs.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
146. Observation.entryRelationship:social-history-entry-sprt-obs.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32960).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSPRT
148. Observation.entryRelationship:social-history-entry-sprt-obs.inversionInd
Definition

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
150. Observation.entryRelationship:social-history-entry-sprt-obs.contextConductionInd
Definition

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
152. Observation.entryRelationship:social-history-entry-sprt-obs.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
154. Observation.entryRelationship:social-history-entry-sprt-obs.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
156. Observation.entryRelationship:social-history-entry-sprt-obs.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
158. Observation.entryRelationship:social-history-entry-sprt-obs.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
160. Observation.entryRelationship:social-history-entry-sprt-obs.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
162. Observation.entryRelationship:social-history-entry-sprt-obs.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Assessment Scale Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.69) (CONF:4515-32959).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Observation.entryRelationship:social-history-entry-sprt-obs.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
166. Observation.entryRelationship:social-history-entry-sprt-obs.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
168. Observation.entryRelationship:social-history-entry-sprt-obs.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
170. Observation.entryRelationship:social-history-entry-sprt-obs.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
172. Observation.entryRelationship:social-history-entry-sprt-obs.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
174. Observation.entryRelationship:social-history-entry-sprt-obs.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
176. Observation.entryRelationship:social-history-entry-sprt-act
Slice Namesocial-history-entry-sprt-act
ShortentryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
178. Observation.entryRelationship:social-history-entry-sprt-act.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
180. Observation.entryRelationship:social-history-entry-sprt-act.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
182. Observation.entryRelationship:social-history-entry-sprt-act.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
184. Observation.entryRelationship:social-history-entry-sprt-act.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
186. Observation.entryRelationship:social-history-entry-sprt-act.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SPRT" Has support (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32971).

Control1..1
BindingThe codes SHALL be taken from x_ActRelationshipEntryRelationship
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueSPRT
188. Observation.entryRelationship:social-history-entry-sprt-act.inversionInd
Definition

The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
190. Observation.entryRelationship:social-history-entry-sprt-act.contextConductionInd
Definition

The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default Valuetrue
192. Observation.entryRelationship:social-history-entry-sprt-act.negationInd
Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
194. Observation.entryRelationship:social-history-entry-sprt-act.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
196. Observation.entryRelationship:social-history-entry-sprt-act.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
198. Observation.entryRelationship:social-history-entry-sprt-act.act
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Entry Reference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.122) (CONF:4515-32970).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. Observation.entryRelationship:social-history-entry-sprt-act.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
202. Observation.entryRelationship:social-history-entry-sprt-act.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
204. Observation.entryRelationship:social-history-entry-sprt-act.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
206. Observation.entryRelationship:social-history-entry-sprt-act.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
208. Observation.entryRelationship:social-history-entry-sprt-act.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
210. Observation.entryRelationship:social-history-entry-sprt-act.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
212. Observation.entryRelationship:social-history-entry-sprt-act.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
214. Observation.entryRelationship:social-history-entry-sprt-act.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
216. Observation.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
218. Observation.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
220. Observation.referenceRange
Definition

Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Observation.referenceRange.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
224. Observation.referenceRange.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
226. Observation.referenceRange.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
228. Observation.referenceRange.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
230. Observation.referenceRange.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFV
232. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange