Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

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: GenderIdentityObservation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the GenderIdentityObservation logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

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

0. Observation
XML Format | In 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 STATIC) (CONF:4537-1230).
4. Observation.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-1231).
6. Observation.templateId
Control | 2..?
8. Observation.templateId:templateId1
Slice Name | templateId1
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-1221) such that it
Control | 1..1
10. Observation.templateId:templateId1.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.34.3.45" (CONF:4537-1225).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.34.3.45
12. Observation.templateId:templateId1.extension
Comments | SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-1226).
Control | 1..?
Pattern Value | 2023-05-01
14. Observation.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-1222).
16. Observation.code.code
Comments | This code SHALL contain exactly one [1..1] @code="76691-5" Gender identity (CONF:4537-1227).
Control | 1..?
Pattern Value | 76691-5
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-1228).
Control | 1..?
Pattern Value | 2.16.840.1.113883.6.1
20. Observation.statusCode
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-33067).
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-33069).
24. Observation.effectiveTime
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4537-33068).
26. Observation.effectiveTime.low
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-33070).
Control | 1..?
28. Observation.effectiveTime.high
Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:4537-33071).
30. Observation.value
Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Gender Identity USCDI core urn:oid:2.16.840.1.113762.1.4.1021.101 DYNAMIC (CONF:4537-1223).
Control | 1..?
Binding | The codes SHALL be taken from Gender Identity USCDI core
Type | http://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
32. Observation.value.nullFlavor
Comments | This value MAY contain zero or one [0..1] @nullFlavor, which SHOULD be selected from ValueSet Asked but Unknown and Other urn:oid:2.16.840.1.113762.1.4.1114.17 DYNAMIC (CONF:4537-1232).
Binding | The codes SHOULD be taken from Asked but Unknown and Other

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.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-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 STATIC) (CONF:4537-1230).
Control | 1..1
Binding | The codes SHALL be taken from ActClassObservation
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OBS
4. Observation.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-1231).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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 Name | social-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4515-8550) such that it
Control | 1..1
Type | http://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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2022-06-01
14. Observation.templateId:templateId1
Slice Name | templateId1
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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-1221) such that it
Control | 1..1
Type | http://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.34.3.45" (CONF:4537-1225).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.34.3.45
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-1226).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-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.
Short | Logical 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.
Control | 10..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
22. Observation.code
Definition | Describes what was observed. Sometimes this is called the observation "name".
Short | Type of observation (code / type)
Comments | SHALL contain exactly one [1..1] code (CONF:4537-1222). 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.
Control | 1..1 This element is affected by the following invariants: obs-7
Binding | The codes SHOULD be taken from For example codes, see Social History Type http://hl7.org/fhir/ValueSet/observation-codes
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD CodeableConcept
Is Modifier | false
XML Format | The type of this property is determined using the `xsi:type`attribute.
Requirements | Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names | Name
Invariants | 4515-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="76691-5" Gender identity (CONF:4537-1227).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | 76691-5
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-1228).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
Pattern Value | 2.16.840.1.113883.6.1
28. Observation.statusCode
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-33067).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://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-33069).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Fixed Value | completed
32. Observation.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
34. Observation.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
36. Observation.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
40. Observation.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
42. Observation.statusCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
44. Observation.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
46. Observation.effectiveTime
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4537-33068).
Control | 1..1
Type | http://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 contain exactly one [1..1] low (CONF:4537-33070).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
50. Observation.effectiveTime.high
Definition | This is the high limit of the interval.
Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:4537-33071).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
52. Observation.value
Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Gender Identity USCDI core urn:oid:2.16.840.1.113762.1.4.1021.101 DYNAMIC (CONF:4537-1223).
Control | 1..1
Binding | The codes SHALL be taken from Gender Identity USCDI core
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Invariants | 4515-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). ()
54. Observation.value.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Comments | This value MAY contain zero or one [0..1] @nullFlavor, which SHOULD be selected from ValueSet Asked but Unknown and Other urn:oid:2.16.840.1.113762.1.4.1114.17 DYNAMIC (CONF:4537-1232).
Control | 0..1
Binding | The codes SHOULD be taken from Asked but Unknown and Other
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
56. Observation.entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32969) such that it
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This 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
58. Observation.entryRelationship:social-history-entry-sprt-obs
Slice Name | social-history-entry-sprt-obs
Short | entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32958) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
60. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SPRT
62. Observation.entryRelationship:social-history-entry-sprt-obs.observation
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Observation.entryRelationship:social-history-entry-sprt-act
Slice Name | social-history-entry-sprt-act
Short | entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
66. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SPRT
68. Observation.entryRelationship:social-history-entry-sprt-act.act
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

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

0. Observation
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-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 STATIC) (CONF:4537-1230).
Control | 1..1
Binding | The codes SHALL be taken from ActClassObservation
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | OBS
4. Observation.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-1231).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | EVN
6. Observation.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
8. Observation.realmCode
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
10. Observation.typeId
Control | 0..1
Type | http://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
Control | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This 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 Name | social-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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4515-8550) such that it
Control | 1..1
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
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).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.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).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2022-06-01
26. Observation.templateId:templateId1
Slice Name | templateId1
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
Short | templateId
Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-1221) such that it
Control | 1..1
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning 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).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
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.34.3.45" (CONF:4537-1225).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.34.3.45
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-1226).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2023-05-01
38. Observation.id
Comments | SHALL contain at least one [1..*] id (CONF:4515-8551).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
40. Observation.code
Comments | SHALL contain exactly one [1..1] code (CONF:4537-1222).
Control | 1..1
Binding | The codes SHOULD be taken from Social History Type
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Invariants | 4515-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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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="76691-5" Gender identity (CONF:4537-1227).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Pattern Value | 76691-5
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-1228).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
Pattern Value | 2.16.840.1.113883.6.1
48. Observation.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
50. Observation.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
58. Observation.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
60. Observation.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
62. Observation.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
64. Observation.derivationExpr
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
66. Observation.text
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
XML Format | The type of this property is determined using the `xsi:type`attribute.
68. Observation.statusCode
Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-33067).
Control | 1..1
Binding | The codes SHALL be taken from ActStatus
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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-33069).
Control | 1..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
Fixed Value | completed
74. Observation.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
76. Observation.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
78. Observation.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code 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.
Control | 0..0
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display 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.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
86. Observation.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
88. Observation.statusCode.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
90. Observation.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
92. Observation.effectiveTime
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:4537-33068).
Control | 1..1
Type | http://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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional 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.
Control | 0..1
Type | string(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In 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.
Control | 0..1
Binding | The codes SHALL be taken from SetOperator
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | I
100. Observation.effectiveTime.low
Definition | This is the low limit of the interval.
Comments | This effectiveTime SHALL contain exactly one [1..1] low (CONF:4537-33070).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
106. Observation.effectiveTime.high
Definition | This is the high limit of the interval.
Comments | This effectiveTime MAY contain zero or one [0..1] high (CONF:4537-33071).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
108. Observation.priorityCode
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ActPriority
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
110. Observation.repeatNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
112. Observation.languageCode
Control | 0..1
Binding | The codes SHALL be taken from HumanLanguage
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
114. Observation.value
Comments | SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Gender Identity USCDI core urn:oid:2.16.840.1.113762.1.4.1021.101 DYNAMIC (CONF:4537-1223).
Control | 1..1
Binding | The codes SHALL be taken from Gender Identity USCDI core
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Invariants | 4515-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.value.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Comments | This value MAY contain zero or one [0..1] @nullFlavor, which SHOULD be selected from ValueSet Asked but Unknown and Other urn:oid:2.16.840.1.113762.1.4.1114.17 DYNAMIC (CONF:4537-1232).
Control | 0..1
Binding | The codes SHOULD be taken from Asked but Unknown and Other
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
118. Observation.value.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.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
120. Observation.value.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
122. Observation.value.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
124. Observation.value.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
126. Observation.value.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
128. Observation.value.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSet`.
130. Observation.value.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.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In 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 name`valueSetVersion`.
132. Observation.value.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
134. Observation.value.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
136. Observation.value.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
138. Observation.interpretationCode
Control | 0..*
Binding | The codes SHALL be taken from ObservationInterpretation
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
140. Observation.methodCode
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from ObservationMethod
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
142. Observation.targetSiteCode
Definition | Drawn from concept domain ActSite
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
144. Observation.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
146. Observation.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
148. Observation.performer
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
150. Observation.author
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Observation.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
154. Observation.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
156. Observation.entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32969) such that it
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This 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
158. Observation.entryRelationship:social-history-entry-sprt-obs
Slice Name | social-history-entry-sprt-obs
Short | entryRelationship
Comments | MAY contain zero or more [0..*] entryRelationship (CONF:4515-32958) such that it
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
160. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
162. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
164. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
166. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
168. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SPRT
170. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
172. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | true
174. Observation.entryRelationship:social-history-entry-sprt-obs.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
176. Observation.entryRelationship:social-history-entry-sprt-obs.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
178. Observation.entryRelationship:social-history-entry-sprt-obs.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
180. Observation.entryRelationship:social-history-entry-sprt-obs.act
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
182. Observation.entryRelationship:social-history-entry-sprt-obs.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
184. Observation.entryRelationship:social-history-entry-sprt-obs.observation
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation(Assessment Scale Observation)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
186. Observation.entryRelationship:social-history-entry-sprt-obs.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
188. Observation.entryRelationship:social-history-entry-sprt-obs.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
190. Observation.entryRelationship:social-history-entry-sprt-obs.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
192. Observation.entryRelationship:social-history-entry-sprt-obs.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
194. Observation.entryRelationship:social-history-entry-sprt-obs.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
196. Observation.entryRelationship:social-history-entry-sprt-obs.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
198. Observation.entryRelationship:social-history-entry-sprt-act
Slice Name | social-history-entry-sprt-act
Short | entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
200. 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.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
202. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
204. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
206. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
208. 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).
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | SPRT
210. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
212. 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.
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Default Value | true
214. Observation.entryRelationship:social-history-entry-sprt-act.negationInd
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
216. Observation.entryRelationship:social-history-entry-sprt-act.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
218. Observation.entryRelationship:social-history-entry-sprt-act.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
220. Observation.entryRelationship:social-history-entry-sprt-act.act
Definition | Base definition for all types defined in FHIR type system.
Short | Base 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).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Entry Reference)
Is Modifier | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. Observation.entryRelationship:social-history-entry-sprt-act.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
224. Observation.entryRelationship:social-history-entry-sprt-act.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
226. Observation.entryRelationship:social-history-entry-sprt-act.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
228. Observation.entryRelationship:social-history-entry-sprt-act.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
230. Observation.entryRelationship:social-history-entry-sprt-act.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
232. Observation.entryRelationship:social-history-entry-sprt-act.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
234. Observation.entryRelationship:social-history-entry-sprt-act.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
236. Observation.entryRelationship:social-history-entry-sprt-act.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
238. Observation.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
240. Observation.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
242. Observation.referenceRange
Definition | Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. Observation.referenceRange.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
246. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
248. 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.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
250. 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
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
252. Observation.referenceRange.typeCode
Control | 0..1
Binding | The codes SHALL be taken from ActRelationshipPertains
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | REFV
254. Observation.referenceRange.observationRange
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationRange