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

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

Logical Model: SubstanceOrDeviceAllergyIntoleranceObservation - Detailed Descriptions

Draft as of 2023-12-21

Definitions for the SubstanceOrDeviceAllergyIntoleranceObservation logical model.

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

0. Observation
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
2. Observation.templateId
Control1..?
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
4. Observation.templateId:substance-device-allergy-intolerance-obs
Slice Namesubstance-device-allergy-intolerance-obs
Control1..1
6. Observation.templateId:substance-device-allergy-intolerance-obs.root
Control1..?
Pattern Value2.16.840.1.113883.10.20.24.3.90
8. Observation.templateId:substance-device-allergy-intolerance-obs.extension
Control1..?
Pattern Value2014-06-09
10. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).

Fixed ValueOBS
12. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304).

Fixed ValueEVN
14. Observation.id
Comments

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

Control1..?
16. Observation.code
Comments

SHALL contain exactly one [1..1] code (CONF:1098-16345).

18. Observation.code.code
Comments

This code SHALL contain exactly one [1..1] @code="ASSERTION" Assertion (CONF:1098-16346).

Control1..?
Pattern ValueASSERTION
20. Observation.code.codeSystem
Comments

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).

Control1..?
Pattern Value2.16.840.1.113883.5.4
22. Observation.text
ShortSHOULD reference the portion of section narrative text corresponding to this entry
24. Observation.text.reference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
26. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1098-16308).

Control1..?
28. Observation.statusCode.code
Comments

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

Control1..?
Fixed Valuecompleted
30. Observation.effectiveTime
ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

Control1..?
32. Observation.effectiveTime.low
Comments

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

Control1..?
34. Observation.effectiveTime.high
Comments

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

36. Observation.value
Comments

SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/CO, 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
38. Observation.value.code
ShortMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Comments

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

Control1..?
BindingThe codes SHALL be taken from Allergy and Intolerance Type
40. Observation.author
Comments

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

Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
42. Observation.participant
Comments

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
44. Observation.participant:participant1
Slice Nameparticipant1
Shortparticipant
Control0..*
46. Observation.participant:participant1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Fixed ValueCSM
48. Observation.participant:participant1.participantRole
Comments

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

50. Observation.participant:participant1.participantRole.classCode
Comments

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Fixed ValueMANU
52. Observation.participant:participant1.participantRole.playingEntity
Comments

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

Control1..?
54. Observation.participant:participant1.participantRole.playingEntity.classCode
Comments

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Fixed ValueMMAT
56. Observation.participant:participant1.participantRole.playingEntity.code
Comments

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

Control1..?
BindingThe codes SHOULD be taken from Substance Reactant for Intolerance
58. Observation.entryRelationship
Comments

SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it

SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
60. Observation.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortentryRelationship
Comments

MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it

Control0..1
62. Observation.entryRelationship:entryRelationship1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16335).

Fixed ValueSUBJ
64. Observation.entryRelationship:entryRelationship1.inversionInd
Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334).

Control1..?
Fixed Valuetrue
66. Observation.entryRelationship:entryRelationship1.observation
Comments

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy Status Observation)
68. Observation.entryRelationship:entryRelationship2
Slice NameentryRelationship2
ShortentryRelationship
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it

Control0..*
70. Observation.entryRelationship:entryRelationship2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

Fixed ValueMFST
72. Observation.entryRelationship:entryRelationship2.inversionInd
Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338).

Control1..?
Fixed Valuetrue
74. Observation.entryRelationship:entryRelationship2.observation
Comments

SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Reaction Observation)
76. Observation.entryRelationship:entryRelationship3
Slice NameentryRelationship3
ShortentryRelationship
Comments

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

Control0..1
78. Observation.entryRelationship:entryRelationship3.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16342).

Fixed ValueSUBJ
80. Observation.entryRelationship:entryRelationship3.inversionInd
Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343).

Control1..?
Fixed Valuetrue
82. Observation.entryRelationship:entryRelationship3.observation
Comments

SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Severity Observation)
84. Observation.entryRelationship:entryRelationship4
Slice NameentryRelationship4
ShortentryRelationship
Control0..1
86. Observation.entryRelationship:entryRelationship4.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936).

Fixed ValueSUBJ
88. Observation.entryRelationship:entryRelationship4.inversionInd
Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937).

Control1..?
Fixed Valuetrue
90. Observation.entryRelationship:entryRelationship4.observation
Comments

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

Control1..?
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)

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

0. Observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
2. 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

Control1..*
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:
  • value @ root
  • value @ extension
4. Observation.templateId:substance-device-allergy-intolerance-obs
Slice Namesubstance-device-allergy-intolerance-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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
6. Observation.templateId:substance-device-allergy-intolerance-obs.root
Definition

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

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.24.3.90
8. Observation.templateId:substance-device-allergy-intolerance-obs.extension
Definition

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

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 Value2014-06-09
10. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation (2.0.0)
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
12. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304).

Control1..1
BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
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
14. 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:1098-16307).


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
16. 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:1098-16345).


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
BindingFor example codes, see ObservationTypehttp://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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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="ASSERTION" Assertion (CONF:1098-16346).

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 ValueASSERTION
20. 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.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).

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.5.4
22. Observation.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortSHOULD reference the portion of section narrative text corresponding to this entryText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EDNarrative
Is Modifierfalse
XML FormatThe type of this property is determined using the xsi:typeattribute.
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Observation.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
26. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1098-16308).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
28. 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" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-26354).

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
30. 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
32. 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
34. 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
36. 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
38. 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
40. 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
42. 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
44. Observation.effectiveTime
ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

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

This is the low limit of the interval.

Comments

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

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

This is the high limit of the interval.

Comments

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

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

SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
52. 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.

ShortMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Comments

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
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
54. Observation.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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:1098-31144).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
56. Observation.participant
Comments

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
58. Observation.participant:participant1
Slice Nameparticipant1
Shortparticipant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
60. Observation.participant:participant1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Control1..1
BindingThe codes SHALL be taken from ParticipationType
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 ValueCSM
62. Observation.participant:participant1.participantRole
Comments

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
64. Observation.participant:participant1.participantRole.classCode
Comments

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
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 ValueROL
Fixed ValueMANU
66. Observation.participant:participant1.participantRole.playingEntity
Comments

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
68. Observation.participant:participant1.participantRole.playingEntity.classCode
Comments

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
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 ValueENT
Fixed ValueMMAT
70. Observation.participant:participant1.participantRole.playingEntity.code
Comments

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

Control1..1
BindingThe codes SHOULD be taken from Substance Reactant for Intolerance
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
72. Observation.entryRelationship
Comments

SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it

Control0..*
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:
  • profile @ observation
74. Observation.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortentryRelationship
Comments

MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
76. Observation.entryRelationship:entryRelationship1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16335).

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 ValueSUBJ
78. Observation.entryRelationship:entryRelationship1.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334).

Control1..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.
Fixed Valuetrue
80. Observation.entryRelationship:entryRelationship1.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy Status Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
82. Observation.entryRelationship:entryRelationship2
Slice NameentryRelationship2
ShortentryRelationship
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
84. Observation.entryRelationship:entryRelationship2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

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 ValueMFST
86. Observation.entryRelationship:entryRelationship2.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338).

Control1..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.
Fixed Valuetrue
88. Observation.entryRelationship:entryRelationship2.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Reaction Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
90. Observation.entryRelationship:entryRelationship3
Slice NameentryRelationship3
ShortentryRelationship
Comments

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
92. Observation.entryRelationship:entryRelationship3.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16342).

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 ValueSUBJ
94. Observation.entryRelationship:entryRelationship3.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343).

Control1..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.
Fixed Valuetrue
96. Observation.entryRelationship:entryRelationship3.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Severity Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
98. Observation.entryRelationship:entryRelationship4
Slice NameentryRelationship4
ShortentryRelationship
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
100. Observation.entryRelationship:entryRelationship4.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936).

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 ValueSUBJ
102. Observation.entryRelationship:entryRelationship4.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937).

Control1..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.
Fixed Valuetrue
104. Observation.entryRelationship:entryRelationship4.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())

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

0. Observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-author: SHOULD contain author (author.exists())
2. Observation.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 CDANullFlavor
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
4. Observation.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
6. Observation.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
8. Observation.typeId.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 CDANullFlavor
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
10. Observation.typeId.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
12. Observation.typeId.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
14. Observation.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
16. Observation.typeId.extension
Definition

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

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
18. 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

Control1..*
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:
  • value @ root
  • value @ extension
20. Observation.templateId:substance-device-allergy-intolerance-obs
Slice Namesubstance-device-allergy-intolerance-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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
22. Observation.templateId:substance-device-allergy-intolerance-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 CDANullFlavor
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
24. Observation.templateId:substance-device-allergy-intolerance-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
26. Observation.templateId:substance-device-allergy-intolerance-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
28. Observation.templateId:substance-device-allergy-intolerance-obs.root
Definition

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

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.24.3.90
30. Observation.templateId:substance-device-allergy-intolerance-obs.extension
Definition

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

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 Value2014-06-09
32. Observation.classCode
Comments

SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-16303).

Control1..1
BindingThe codes SHALL be taken from ActClassObservation (2.0.0)
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
34. Observation.moodCode
Comments

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-16304).

Control1..1
BindingThe codes SHALL be taken from XActMoodDocumentObservation (2.0.0)
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
36. 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.
38. Observation.id
Comments

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

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

SHALL contain exactly one [1..1] code (CONF:1098-16345).

Control1..1
BindingFor example codes, see ObservationType
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
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 CDANullFlavor
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="ASSERTION" Assertion (CONF:1098-16346).

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 ValueASSERTION
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.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:1098-32171).

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.5.4
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
ShortSHOULD reference the portion of section narrative text corresponding to this entry
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatThe type of this property is determined using the xsi:typeattribute.
68. Observation.text.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 CDANullFlavor
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
70. Observation.text.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
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.
LabelCompression
72. Observation.text.integrityCheck
Definition

The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.

Control0..1
Typebase64Binary(bin: Binary Data)
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.
LabelIntegrity Check
74. Observation.text.integrityCheckAlgorithm
Definition

Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
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.
LabelIntegrity Check Algorithm
76. Observation.text.language
Definition

For character based information the language property specifies the human language of the text.

Control0..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.
LabelLanguage
78. Observation.text.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
BindingFor example codes, see MediaType
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.
LabelMedia Type
80. Observation.text.representation
Control0..1
BindingThe codes SHALL be taken from Binary Data Encoding Value Set
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.
82. Observation.text.xmlText
Definition

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

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 unadorned text.
84. Observation.text.reference
Definition

A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
86. Observation.text.thumbnail
Definition

An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail
88. Observation.statusCode
Comments

SHALL contain exactly one [1..1] statusCode (CONF:1098-16308).

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
90. 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 CDANullFlavor
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
92. 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" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-26354).

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
94. 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
96. 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
98. 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
100. 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
102. 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.
104. 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.
106. 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
108. 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
110. 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
112. Observation.effectiveTime
ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became clinically active. The effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became clinically resolved. If the allergy/intolerance is known to be resolved, but the date of resolution is not known, then the high element SHALL be present, and the nullFlavor attribute SHALL be set to 'UNK'.
Comments

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-16309).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
114. 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 CDANullFlavor
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
116. 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
TypedateTime(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.
118. 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
120. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Comments

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-31536).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelLow Boundary
122. 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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
LabelCentral Value
124. 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.

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

This is the high limit of the interval.

Comments

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-31537).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
128. Observation.priorityCode
Control0..1
BindingFor example codes, see ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
130. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
132. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
134. Observation.value
Comments

SHALL contain exactly one [1..1] value with @xsi:type="CD" (CONF:1098-16312).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
136. Observation.value.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 CDANullFlavor
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
138. 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.

ShortMany systems will simply assign a fixed value here (e.g., "allergy to substance").
Comments

This value SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet Allergy and Intolerance Type urn:oid:2.16.840.1.113883.3.88.12.3221.6.2 DYNAMIC (CONF:1098-16317).

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
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
140. Observation.value.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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
142. Observation.value.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
144. Observation.value.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
146. Observation.value.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
148. 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.

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.
150. 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.

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.
152. Observation.value.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
154. Observation.value.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
156. Observation.value.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
158. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
160. Observation.methodCode
Control0..*
BindingFor example codes, see ObservationMethod
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
162. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
164. Observation.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
166. Observation.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
168. Observation.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
170. Observation.author
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

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:1098-31144).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
172. Observation.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
174. Observation.participant
Comments

SHOULD contain zero or more [0..*] participant (CONF:1098-16318) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ typeCode
176. Observation.participant:participant1
Slice Nameparticipant1
Shortparticipant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
178. Observation.participant:participant1.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 CDANullFlavor
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.participant:participant1.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.participant:participant1.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.participant:participant1.typeId.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 CDANullFlavor
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
186. Observation.participant:participant1.typeId.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
188. Observation.participant:participant1.typeId.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
190. Observation.participant:participant1.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
192. Observation.participant:participant1.typeId.extension
Definition

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

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
194. Observation.participant:participant1.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
196. Observation.participant:participant1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="CSM" Consumable (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-16319).

Control1..1
BindingThe codes SHALL be taken from ParticipationType
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 ValueCSM
198. Observation.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
200. Observation.participant:participant1.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namefunctionCode.
202. Observation.participant:participant1.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
204. Observation.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
206. Observation.participant:participant1.participantRole
Comments

SHALL contain exactly one [1..1] participantRole (CONF:1098-16320).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
208. Observation.participant:participant1.participantRole.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 CDANullFlavor
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
210. Observation.participant:participant1.participantRole.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
212. Observation.participant:participant1.participantRole.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
214. Observation.participant:participant1.participantRole.typeId.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 CDANullFlavor
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
216. Observation.participant:participant1.participantRole.typeId.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
218. Observation.participant:participant1.participantRole.typeId.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
220. Observation.participant:participant1.participantRole.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
222. Observation.participant:participant1.participantRole.typeId.extension
Definition

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

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
224. Observation.participant:participant1.participantRole.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
226. Observation.participant:participant1.participantRole.classCode
Comments

This participantRole SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-16321).

Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
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 ValueROL
Fixed ValueMANU
228. Observation.participant:participant1.participantRole.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
230. Observation.participant:participant1.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
232. Observation.participant:participant1.participantRole.code
Control0..1
BindingFor example codes, see v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
234. Observation.participant:participant1.participantRole.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
236. Observation.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
238. Observation.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
240. Observation.participant:participant1.participantRole.playingEntity
Comments

This participantRole SHALL contain exactly one [1..1] playingEntity (CONF:1098-16322).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
242. Observation.participant:participant1.participantRole.playingEntity.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 CDANullFlavor
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
244. Observation.participant:participant1.participantRole.playingEntity.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
246. Observation.participant:participant1.participantRole.playingEntity.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
248. Observation.participant:participant1.participantRole.playingEntity.typeId.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 CDANullFlavor
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
250. Observation.participant:participant1.participantRole.playingEntity.typeId.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
252. Observation.participant:participant1.participantRole.playingEntity.typeId.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
254. Observation.participant:participant1.participantRole.playingEntity.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
256. Observation.participant:participant1.participantRole.playingEntity.typeId.extension
Definition

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

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
258. Observation.participant:participant1.participantRole.playingEntity.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
260. Observation.participant:participant1.participantRole.playingEntity.classCode
Comments

This playingEntity SHALL contain exactly one [1..1] @classCode="MMAT" Manufactured Material (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1098-16323).

Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
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 ValueENT
Fixed ValueMMAT
262. Observation.participant:participant1.participantRole.playingEntity.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
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 ValueINSTANCE
264. Observation.participant:participant1.participantRole.playingEntity.code
Comments

This playingEntity SHALL contain exactly one [1..1] code, which MAY be selected from ValueSet Substance Reactant for Intolerance urn:oid:2.16.840.1.113762.1.4.1010.1 DYNAMIC (CONF:1098-16324).

Control1..1
BindingThe codes SHOULD be taken from Substance Reactant for Intolerance
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
266. Observation.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
268. Observation.participant:participant1.participantRole.playingEntity.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
270. Observation.participant:participant1.participantRole.playingEntity.sdtcBirthTime
Definition

The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime.
272. Observation.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
274. Observation.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity
276. Observation.entryRelationship
Comments

SHOULD contain zero or one [0..1] entryRelationship (CONF:1098-32935) such that it

Control0..*
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:
  • profile @ observation
278. Observation.entryRelationship:entryRelationship1
Slice NameentryRelationship1
ShortentryRelationship
Comments

MAY contain zero or one [0..1] entryRelationship (CONF:1098-16333) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
280. Observation.entryRelationship:entryRelationship1.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 CDANullFlavor
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
282. Observation.entryRelationship:entryRelationship1.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
284. Observation.entryRelationship:entryRelationship1.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
286. Observation.entryRelationship:entryRelationship1.typeId.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 CDANullFlavor
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
288. Observation.entryRelationship:entryRelationship1.typeId.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
290. Observation.entryRelationship:entryRelationship1.typeId.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
292. Observation.entryRelationship:entryRelationship1.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
294. Observation.entryRelationship:entryRelationship1.typeId.extension
Definition

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

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
296. Observation.entryRelationship:entryRelationship1.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
298. Observation.entryRelationship:entryRelationship1.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16335).

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 ValueSUBJ
300. Observation.entryRelationship:entryRelationship1.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16334).

Control1..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.
Fixed Valuetrue
302. Observation.entryRelationship:entryRelationship1.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
304. Observation.entryRelationship:entryRelationship1.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.
306. Observation.entryRelationship:entryRelationship1.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
308. Observation.entryRelationship:entryRelationship1.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
310. Observation.entryRelationship:entryRelationship1.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
312. Observation.entryRelationship:entryRelationship1.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
314. Observation.entryRelationship:entryRelationship1.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Allergy Status Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.28:2019-06-20) (CONF:1098-16336).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Allergy Status Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
316. Observation.entryRelationship:entryRelationship1.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
318. Observation.entryRelationship:entryRelationship1.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
320. Observation.entryRelationship:entryRelationship1.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
322. Observation.entryRelationship:entryRelationship1.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
324. Observation.entryRelationship:entryRelationship1.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
326. Observation.entryRelationship:entryRelationship1.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
328. Observation.entryRelationship:entryRelationship2
Slice NameentryRelationship2
ShortentryRelationship
Comments

SHOULD contain zero or more [0..*] entryRelationship (CONF:1098-16337) such that it

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
330. Observation.entryRelationship:entryRelationship2.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 CDANullFlavor
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
332. Observation.entryRelationship:entryRelationship2.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
334. Observation.entryRelationship:entryRelationship2.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
336. Observation.entryRelationship:entryRelationship2.typeId.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 CDANullFlavor
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
338. Observation.entryRelationship:entryRelationship2.typeId.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
340. Observation.entryRelationship:entryRelationship2.typeId.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
342. Observation.entryRelationship:entryRelationship2.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
344. Observation.entryRelationship:entryRelationship2.typeId.extension
Definition

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

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
346. Observation.entryRelationship:entryRelationship2.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
348. Observation.entryRelationship:entryRelationship2.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="MFST" Is Manifestation of (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16339).

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 ValueMFST
350. Observation.entryRelationship:entryRelationship2.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16338).

Control1..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.
Fixed Valuetrue
352. Observation.entryRelationship:entryRelationship2.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
354. Observation.entryRelationship:entryRelationship2.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.
356. Observation.entryRelationship:entryRelationship2.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
358. Observation.entryRelationship:entryRelationship2.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
360. Observation.entryRelationship:entryRelationship2.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
362. Observation.entryRelationship:entryRelationship2.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
364. Observation.entryRelationship:entryRelationship2.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Reaction Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.9:2014-06-09) (CONF:1098-16340).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Reaction Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
366. Observation.entryRelationship:entryRelationship2.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
368. Observation.entryRelationship:entryRelationship2.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
370. Observation.entryRelationship:entryRelationship2.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
372. Observation.entryRelationship:entryRelationship2.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
374. Observation.entryRelationship:entryRelationship2.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
376. Observation.entryRelationship:entryRelationship2.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
378. Observation.entryRelationship:entryRelationship3
Slice NameentryRelationship3
ShortentryRelationship
Comments

SHOULD NOT contain zero or one [0..1] entryRelationship (CONF:1098-16341) such that it

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
380. Observation.entryRelationship:entryRelationship3.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 CDANullFlavor
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
382. Observation.entryRelationship:entryRelationship3.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
384. Observation.entryRelationship:entryRelationship3.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
386. Observation.entryRelationship:entryRelationship3.typeId.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 CDANullFlavor
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
388. Observation.entryRelationship:entryRelationship3.typeId.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
390. Observation.entryRelationship:entryRelationship3.typeId.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
392. Observation.entryRelationship:entryRelationship3.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
394. Observation.entryRelationship:entryRelationship3.typeId.extension
Definition

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

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
396. Observation.entryRelationship:entryRelationship3.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
398. Observation.entryRelationship:entryRelationship3.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-16342).

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 ValueSUBJ
400. Observation.entryRelationship:entryRelationship3.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-16343).

Control1..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.
Fixed Valuetrue
402. Observation.entryRelationship:entryRelationship3.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
404. Observation.entryRelationship:entryRelationship3.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.
406. Observation.entryRelationship:entryRelationship3.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
408. Observation.entryRelationship:entryRelationship3.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
410. Observation.entryRelationship:entryRelationship3.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
412. Observation.entryRelationship:entryRelationship3.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
414. Observation.entryRelationship:entryRelationship3.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Severity Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.8:2014-06-09) (CONF:1098-16344).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Severity Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
416. Observation.entryRelationship:entryRelationship3.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
418. Observation.entryRelationship:entryRelationship3.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
420. Observation.entryRelationship:entryRelationship3.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
422. Observation.entryRelationship:entryRelationship3.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
424. Observation.entryRelationship:entryRelationship3.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
426. Observation.entryRelationship:entryRelationship3.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
428. Observation.entryRelationship:entryRelationship4
Slice NameentryRelationship4
ShortentryRelationship
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
430. Observation.entryRelationship:entryRelationship4.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 CDANullFlavor
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
432. Observation.entryRelationship:entryRelationship4.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
434. Observation.entryRelationship:entryRelationship4.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
436. Observation.entryRelationship:entryRelationship4.typeId.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 CDANullFlavor
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
438. Observation.entryRelationship:entryRelationship4.typeId.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
440. Observation.entryRelationship:entryRelationship4.typeId.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
442. Observation.entryRelationship:entryRelationship4.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
444. Observation.entryRelationship:entryRelationship4.typeId.extension
Definition

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

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
446. Observation.entryRelationship:entryRelationship4.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
448. Observation.entryRelationship:entryRelationship4.typeCode
Comments

SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32936).

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 ValueSUBJ
450. Observation.entryRelationship:entryRelationship4.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.

Comments

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-32937).

Control1..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.
Fixed Valuetrue
452. Observation.entryRelationship:entryRelationship4.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
454. Observation.entryRelationship:entryRelationship4.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.
456. Observation.entryRelationship:entryRelationship4.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
458. Observation.entryRelationship:entryRelationship4.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
460. Observation.entryRelationship:entryRelationship4.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
462. Observation.entryRelationship:entryRelationship4.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
464. Observation.entryRelationship:entryRelationship4.observation
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] Criticality Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.145) (CONF:1098-32938).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
Is Modifierfalse
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
466. Observation.entryRelationship:entryRelationship4.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
468. Observation.entryRelationship:entryRelationship4.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
470. Observation.entryRelationship:entryRelationship4.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
472. Observation.entryRelationship:entryRelationship4.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
474. Observation.entryRelationship:entryRelationship4.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
476. Observation.entryRelationship:entryRelationship4.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
478. Observation.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
480. Observation.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
482. Observation.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
484. 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
486. 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 CDANullFlavor
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
488. 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
490. 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
492. Observation.referenceRange.typeId.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 CDANullFlavor
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
494. Observation.referenceRange.typeId.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
496. Observation.referenceRange.typeId.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
498. Observation.referenceRange.typeId.root
Definition

Identifies the type as an HL7 Registered model

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
Fixed Value2.16.840.1.113883.1.3
500. Observation.referenceRange.typeId.extension
Definition

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

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
502. 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
504. Observation.referenceRange.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipType (2.0.0)
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
506. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange
508. Observation.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.