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

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

Logical Model: AllergyIntoleranceObservation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the AllergyIntoleranceObservation logical model.

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

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

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

4. 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-7380).

6. Observation.negationInd
ShortUse negationInd="true" to indicate that the allergy was not observed.
Comments

MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

8. Observation.templateId
Control2..?
10. Observation.templateId:secondary
Slice Namesecondary
Comments

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

Control1..1
12. Observation.templateId:secondary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.7
14. Observation.templateId:secondary.extension
Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526).

Control1..?
Pattern Value2014-06-09
16. Observation.id
Comments

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

18. Observation.code
Comments

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

20. Observation.code.code
Comments

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

22. 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-32153).

24. Observation.statusCode
Comments

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

26. 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 STATIC) (CONF:1098-19085).

28. Observation.effectiveTime
ShortIf 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-7387).

30. Observation.effectiveTime.low
ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
Comments

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

32. Observation.effectiveTime.high
ShortThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
Comments

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

34. Observation.value
ShortThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
BindingThe codes SHALL be taken from Allergy and Intolerance Type
36. 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-31143).

38. Observation.entryRelationship:criticality
Slice Namecriticality
Comments

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

Control0..1
40. Observation.entryRelationship:criticality.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-32911).

Fixed ValueSUBJ
42. Observation.entryRelationship:criticality.inversionInd
Comments

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

Control1..?
Fixed Valuetrue
44. Observation.entryRelationship:criticality.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-32913).

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

Base definition for all types defined in FHIR type system.

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

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

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

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. Observation.negationInd
ShortUse negationInd="true" to indicate that the allergy was not observed.
Comments

MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

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

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

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

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

ShorttemplateId
Comments

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.24.3.90" (CONF:1098-16306).

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
14. Observation.templateId:templateId1.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32527).

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
16. Observation.templateId:secondary
Slice Namesecondary
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

Comments

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488).

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

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526).

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
22. 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-7382).


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
24. 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-15947).


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
BindingUnless not suitable, these codes SHALL be taken from For 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()))
26. 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-15948).

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
28. 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-32153).

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
30. Observation.statusCode
Comments

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

Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
32. 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 STATIC) (CONF:1098-19085).

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
34. 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
36. 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
38. 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
40. 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
42. 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
44. 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
46. 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
48. Observation.effectiveTime
ShortIf 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-7387).

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

This is the low limit of the interval.

ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
Comments

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

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

This is the high limit of the interval.

ShortThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
54. Observation.value
ShortThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Comments

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

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
56. 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
58. Observation.author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. 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: , and can be differentiated using the following discriminators:
  • value @ typeCode
62. Observation.participant:participant1
Slice Nameparticipant1
Shortparticipant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
64. 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
66. 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
68. 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
70. 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
72. 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
74. 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
BindingFor example codes, see Substance Reactant for Intolerance
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
76. 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: , and can be differentiated using the following discriminators:
  • value @ typeCode
  • profile @ observation
78. 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
80. 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
82. 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
84. Observation.entryRelationship:entryRelationship1.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. 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
88. 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
90. 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
92. Observation.entryRelationship:entryRelationship2.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. 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
96. 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
98. 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
100. Observation.entryRelationship:entryRelationship3.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Observation.entryRelationship:entryRelationship4
Slice NameentryRelationship4
ShortentryRelationship
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
104. 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
106. 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
108. Observation.entryRelationship:entryRelationship4.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Observation.entryRelationship:criticality
Slice Namecriticality
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
112. Observation.entryRelationship:criticality.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-32911).

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
114. Observation.entryRelationship:criticality.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-32912).

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
116. Observation.entryRelationship:criticality.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Observation
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

Control1..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. Observation.negationInd
ShortUse negationInd="true" to indicate that the allergy was not observed.
Comments

MAY contain zero or one [0..1] @negationInd (CONF:1098-31526).

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

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

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

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

ShorttemplateId
Comments

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

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

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

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

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

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

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.24.3.90" (CONF:1098-16306).

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
24. Observation.templateId:templateId1.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32527).

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
26. Observation.templateId:secondary
Slice Namesecondary
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

Comments

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

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

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

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

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

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

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

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

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

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.7" (CONF:1098-10488).

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

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

Comments

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32526).

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
38. Observation.id
Comments

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

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

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

Control1..1
BindingUnless not suitable, these codes SHALL be taken from 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
44. Observation.code.code
Definition

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

Comments

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

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-32153).

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
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatThe type of this property is determined using the xsi:typeattribute.
68. Observation.statusCode
Comments

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

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

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

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

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

Comments

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

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

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation
92. Observation.effectiveTime
ShortIf 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-7387).

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

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

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

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

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

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

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

This is the low limit of the interval.

ShortThe effectiveTime/low (a.k.a. "onset date") asserts when the allergy/intolerance became biologically active.
Comments

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

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

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

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

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

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

This is the high limit of the interval.

ShortThe effectiveTime/high (a.k.a. "resolution date") asserts when the allergy/intolerance became biologically resolved.
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
LabelHigh Boundary
108. Observation.priorityCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
110. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-INT
112. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
114. Observation.value
ShortThe consumable participant points to the precise allergen or substance of intolerance. Because the consumable and the reaction are more clinically relevant than a categorization of the allergy/adverse event type, many systems will simply assign a fixed value here (e.g., "allergy to substance").
Comments

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

Control1..1
BindingThe codes SHALL be taken from Allergy and Intolerance Type
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
XML FormatThe type of this property is determined using the xsi:typeattribute.
116. Observation.value.nullFlavor
Definition

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

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

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

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
120. 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
122. 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
124. 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
126. 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
128. Observation.value.sdtcValueSet
Definition

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

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.
130. Observation.value.sdtcValueSetVersion
Definition

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

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.
132. 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
134. 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
136. 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
138. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
140. Observation.methodCode
Control0..*
BindingUnless not suitable, these codes SHALL be taken from ObservationMethod
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
142. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
144. Observation.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
146. Observation.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
148. Observation.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
150. Observation.author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Observation.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
154. 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: , and can be differentiated using the following discriminators:
  • value @ typeCode
156. Observation.participant:participant1
Slice Nameparticipant1
Shortparticipant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
158. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
160. 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
162. 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
164. 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
166. 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
168. 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
170. 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.
172. Observation.participant:participant1.time
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
174. Observation.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
176. 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
178. 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
180. 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
182. Observation.participant:participant1.participantRole.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
184. 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.
186. Observation.participant:participant1.participantRole.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
188. Observation.participant:participant1.participantRole.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
190. Observation.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
192. Observation.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
194. 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
196. 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
198. 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
200. 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
202. 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
BindingFor example codes, see Substance Reactant for Intolerance
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
204. Observation.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
206. Observation.participant:participant1.participantRole.playingEntity.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
208. Observation.participant:participant1.participantRole.playingEntity.sdtcBirthTime
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.
210. Observation.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
212. Observation.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity
214. 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: , and can be differentiated using the following discriminators:
  • value @ typeCode
  • profile @ observation
216. 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
218. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
220. 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
222. 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
224. 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
226. 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
228. 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
230. 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
232. 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.
234. Observation.entryRelationship:entryRelationship1.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
236. Observation.entryRelationship:entryRelationship1.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
238. Observation.entryRelationship:entryRelationship1.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
240. Observation.entryRelationship:entryRelationship1.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
242. Observation.entryRelationship:entryRelationship1.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
244. Observation.entryRelationship:entryRelationship1.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
246. Observation.entryRelationship:entryRelationship1.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
248. Observation.entryRelationship:entryRelationship1.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
250. Observation.entryRelationship:entryRelationship1.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
252. Observation.entryRelationship:entryRelationship1.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
254. Observation.entryRelationship:entryRelationship1.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
256. 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
258. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
260. 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
262. 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
264. 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
266. 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
268. 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
270. 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
272. 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.
274. Observation.entryRelationship:entryRelationship2.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
276. Observation.entryRelationship:entryRelationship2.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
278. Observation.entryRelationship:entryRelationship2.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
280. Observation.entryRelationship:entryRelationship2.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
282. Observation.entryRelationship:entryRelationship2.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
284. Observation.entryRelationship:entryRelationship2.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
286. Observation.entryRelationship:entryRelationship2.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
288. Observation.entryRelationship:entryRelationship2.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
290. Observation.entryRelationship:entryRelationship2.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
292. Observation.entryRelationship:entryRelationship2.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
294. Observation.entryRelationship:entryRelationship2.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
296. 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
298. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
300. 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
302. 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
304. 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
306. 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
308. 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
310. 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
312. 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.
314. Observation.entryRelationship:entryRelationship3.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
316. Observation.entryRelationship:entryRelationship3.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
318. Observation.entryRelationship:entryRelationship3.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
320. Observation.entryRelationship:entryRelationship3.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
322. Observation.entryRelationship:entryRelationship3.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. Observation.entryRelationship:entryRelationship3.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
326. Observation.entryRelationship:entryRelationship3.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
328. Observation.entryRelationship:entryRelationship3.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
330. Observation.entryRelationship:entryRelationship3.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
332. Observation.entryRelationship:entryRelationship3.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
334. Observation.entryRelationship:entryRelationship3.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
336. Observation.entryRelationship:entryRelationship4
Slice NameentryRelationship4
ShortentryRelationship
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
338. 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 NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
340. 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
342. 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
344. 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
346. 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
348. 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
350. 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
352. 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.
354. Observation.entryRelationship:entryRelationship4.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
356. Observation.entryRelationship:entryRelationship4.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
358. Observation.entryRelationship:entryRelationship4.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
360. Observation.entryRelationship:entryRelationship4.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
362. Observation.entryRelationship:entryRelationship4.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

SHALL contain exactly one [1..1] 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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
364. Observation.entryRelationship:entryRelationship4.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
366. Observation.entryRelationship:entryRelationship4.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
368. Observation.entryRelationship:entryRelationship4.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
370. Observation.entryRelationship:entryRelationship4.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
372. Observation.entryRelationship:entryRelationship4.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
374. Observation.entryRelationship:entryRelationship4.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
376. Observation.entryRelationship:criticality
Slice Namecriticality
Comments

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

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
378. Observation.entryRelationship:criticality.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
380. Observation.entryRelationship:criticality.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
382. Observation.entryRelationship:criticality.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
384. Observation.entryRelationship:criticality.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
386. Observation.entryRelationship:criticality.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-32911).

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
388. Observation.entryRelationship:criticality.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-32912).

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
390. Observation.entryRelationship:criticality.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
392. Observation.entryRelationship:criticality.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.
394. Observation.entryRelationship:criticality.sequenceNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT
396. Observation.entryRelationship:criticality.seperatableInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
398. Observation.entryRelationship:criticality.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
400. Observation.entryRelationship:criticality.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
402. Observation.entryRelationship:criticality.observation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Comments

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

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Criticality Observation)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
404. Observation.entryRelationship:criticality.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
406. Observation.entryRelationship:criticality.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
408. Observation.entryRelationship:criticality.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
410. Observation.entryRelationship:criticality.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
412. Observation.entryRelationship:criticality.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
414. Observation.entryRelationship:criticality.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply
416. Observation.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
418. Observation.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
420. Observation.referenceRange
Definition

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

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

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
424. 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
426. 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
428. 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
430. Observation.referenceRange.typeCode
Control0..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueREFV
432. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationRange