Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: AdvanceDirectiveObservation - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.48 resource profile.

1. Observation
Control1..1
2. Observation.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
Requirements

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

Pattern ValueOBS
3. Observation.moodCode
Control1..1
Typecode
Requirements

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

Pattern ValueEVN
4. Observation.negationInd
Control0..1
Typeboolean
5. Observation.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
6. Observation.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
8. Observation.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

9. Observation.templateId:primary.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
10. Observation.templateId:primary.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
11. Observation.templateId:primary.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
12. Observation.templateId:primary.root
Definition

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.48" (CONF:1198-10485).

Pattern Value2.16.840.1.113883.10.20.22.4.48
13. Observation.templateId:primary.extension
Definition

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32496).

Pattern Value2015-08-01
14. Observation.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

15. Observation.code
Control1..1
BindingThe codes SHOULD be taken from Advance Directive Type Code
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Advance Directive Type Code urn:oid:2.16.840.1.113883.1.11.20.2 DYNAMIC (CONF:1198-8651).

16. 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
17. 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.

Control0..1
Typestring
18. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
19. Observation.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
20. Observation.code.codeSystemVersion
Definition

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

Control0..1
Typestring
21. 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
22. 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
23. 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
24. Observation.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
25. Observation.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
26. Observation.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
SlicingThis element introduces a set of slices on Observation.code.translation. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • ,
  • value @ codeSystem
27. Observation.code.translation:advanceDirective
SliceNameadvanceDirective
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

This code SHALL contain exactly one [1..1] translation (CONF:1198-32842) such that it

28. Observation.code.translation:advanceDirective.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
29. Observation.code.translation:advanceDirective.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.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @code="75320-2" Advance directive (CONF:1198-32843).

Pattern Value75320-2
30. Observation.code.translation:advanceDirective.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1198-32844).

Pattern Value2.16.840.1.113883.6.1
31. Observation.code.translation:advanceDirective.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
32. Observation.code.translation:advanceDirective.codeSystemVersion
Definition

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

Control0..1
Typestring
33. Observation.code.translation:advanceDirective.displayName
Definition

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

Control0..1
Typestring
34. Observation.code.translation:advanceDirective.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
35. Observation.code.translation:advanceDirective.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
36. Observation.code.translation:advanceDirective.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
37. Observation.code.translation:advanceDirective.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
38. Observation.code.translation:advanceDirective.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
39. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
40. Observation.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
41. Observation.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1198-8652).

Pattern ValueCompleted
42. 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
43. 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.

Control1..1
Typestring
Requirements

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

Pattern Valuecompleted
44. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
45. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
46. Observation.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring
47. 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
48. 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
49. 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
50. Observation.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
51. Observation.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
52. Observation.statusCode.translation
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
53. Observation.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1198-8656).

54. 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
55. Observation.effectiveTime.value
Definition

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

Control0..1
TypedateTime
56. Observation.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
57. 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
Typecode
58. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

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

59. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

This effectiveTime SHALL contain exactly one [1..1] high (CONF:1198-15521).

InvariantsDefined on this element
1198-32449: If the Advance Directive does not have a specified ending time, the <high> element **SHALL** have the nullFlavor attribute set to *NA* (CONF:1198-32449). (: )
60. 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/fhir/cda/StructureDefinition/PQ
61. 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/fhir/cda/StructureDefinition/TS
62. Observation.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
63. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
64. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
65. Observation.value
Control0..*
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/BL, http://hl7.org/fhir/cda/StructureDefinition/ED, http://hl7.org/fhir/cda/StructureDefinition/ST, http://hl7.org/fhir/cda/StructureDefinition/CD, http://hl7.org/fhir/cda/StructureDefinition/CV, http://hl7.org/fhir/cda/StructureDefinition/CE, http://hl7.org/fhir/cda/StructureDefinition/SC, http://hl7.org/fhir/cda/StructureDefinition/II, http://hl7.org/fhir/cda/StructureDefinition/TEL, http://hl7.org/fhir/cda/StructureDefinition/AD, http://hl7.org/fhir/cda/StructureDefinition/EN, http://hl7.org/fhir/cda/StructureDefinition/INT, http://hl7.org/fhir/cda/StructureDefinition/REAL, http://hl7.org/fhir/cda/StructureDefinition/PQ, http://hl7.org/fhir/cda/StructureDefinition/MO, http://hl7.org/fhir/cda/StructureDefinition/TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS, http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
SlicingThis element introduces a set of slices on Observation.value. The slices are unordered and Open, and defines no discriminators to differentiate the slices
66. Observation.value:value1
SliceNamevalue1
Control1..1
TypeChoice of: http://hl7.org/fhir/cda/StructureDefinition/BL, http://hl7.org/fhir/cda/StructureDefinition/ED, http://hl7.org/fhir/cda/StructureDefinition/ST, http://hl7.org/fhir/cda/StructureDefinition/CD, http://hl7.org/fhir/cda/StructureDefinition/CV, http://hl7.org/fhir/cda/StructureDefinition/CE, http://hl7.org/fhir/cda/StructureDefinition/SC, http://hl7.org/fhir/cda/StructureDefinition/II, http://hl7.org/fhir/cda/StructureDefinition/TEL, http://hl7.org/fhir/cda/StructureDefinition/AD, http://hl7.org/fhir/cda/StructureDefinition/EN, http://hl7.org/fhir/cda/StructureDefinition/INT, http://hl7.org/fhir/cda/StructureDefinition/REAL, http://hl7.org/fhir/cda/StructureDefinition/PQ, http://hl7.org/fhir/cda/StructureDefinition/MO, http://hl7.org/fhir/cda/StructureDefinition/TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS, http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ
Requirements

SHALL contain exactly one [1..1] value (CONF:1198-30804).

InvariantsDefined on this element
1198-32493: If type CD, then value will be SNOMED-CT 2.16.840.1.113883.6.96 (CONF:1198-32493). (: )
67. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
68. Observation.methodCode
Control0..*
BindingThe codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
69. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
70. Observation.subject
Control0..1
TypeElement
71. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
72. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
73. Observation.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
74. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
75. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
76. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
77. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

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

78. Observation.informant
Control0..*
TypeElement
79. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
80. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
81. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
82. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
83. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
SlicingThis element introduces a set of slices on Observation.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ participantRole
  • ,
  • value @ typeCode
84. Observation.participant:participant1
SliceNameparticipant1
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

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

85. 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
86. Observation.participant:participant1.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="VRF" Verifier (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8663).

Pattern ValueVRF
87. Observation.participant:participant1.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
88. 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/fhir/cda/StructureDefinition/CS
89. 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/fhir/cda/StructureDefinition/II
90. 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/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.participant.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
91. Observation.participant:participant1.templateId:primary
SliceNameprimary
Definition

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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

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

92. Observation.participant:participant1.templateId:primary.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
93. Observation.participant:participant1.templateId:primary.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
94. Observation.participant:participant1.templateId:primary.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
95. Observation.participant:participant1.templateId:primary.root
Definition

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.1.58" (CONF:1198-10486).

Pattern Value2.16.840.1.113883.10.20.1.58
96. Observation.participant:participant1.templateId:primary.extension
Definition

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

Control0..1
Typestring
97. Observation.participant:participant1.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
98. Observation.participant:participant1.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHOULD contain zero or one [0..1] time (CONF:1198-8665).

InvariantsDefined on this element
1198-8666: The data type of Observation/participant/time in a verification **SHALL** be *TS* (time stamp) (CONF:1198-8666). (: )
99. Observation.participant:participant1.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
100. Observation.participant:participant1.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1198-8825).

101. Observation.participant:participant1.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
Default ValueROL
102. 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/fhir/cda/StructureDefinition/II
103. Observation.participant:participant1.participantRole.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
104. Observation.participant:participant1.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
105. Observation.participant:participant1.participantRole.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-28446).

106. Observation.participant:participant1.participantRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

This participantRole MAY contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-28451).

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
107. Observation.participant:participant1.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
108. Observation.participant:participant1.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
109. Observation.participant:participant1.participantRole.playingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

This participantRole MAY contain zero or one [0..1] playingEntity (CONF:1198-28428).

110. Observation.participant:participant1.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
Default ValueENT
111. Observation.participant:participant1.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
112. 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/fhir/cda/StructureDefinition/II
113. Observation.participant:participant1.participantRole.playingEntity.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
114. Observation.participant:participant1.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
115. Observation.participant:participant1.participantRole.playingEntity.name
Definition

A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PN(USRealmPersonNamePNUSFIELDED)
Requirements

The playingEntity, if present, MAY contain zero or more [0..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:1198-28454).

InvariantsDefined on this element
81-9371: The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). (: )
81-9372: The string **SHALL NOT** contain name parts (CONF:81-9372). (: )
116. Observation.participant:participant1.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
117. Observation.participant:participant1.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
118. Observation.participant:participant2
SliceNameparticipant2
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
Requirements

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

119. Observation.participant:participant2.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
120. Observation.participant:participant2.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="CST" Custodian (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8668).

Pattern ValueCST
121. Observation.participant:participant2.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Fixed ValueOP
122. Observation.participant:participant2.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/fhir/cda/StructureDefinition/CS
123. Observation.participant:participant2.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/fhir/cda/StructureDefinition/II
124. Observation.participant:participant2.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/fhir/cda/StructureDefinition/II
125. Observation.participant:participant2.sdtcFunctionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
126. Observation.participant:participant2.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
127. Observation.participant:participant2.awarenessCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
128. Observation.participant:participant2.participantRole
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParticipantRole
Requirements

SHALL contain exactly one [1..1] participantRole (CONF:1198-8669).

129. Observation.participant:participant2.participantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
Requirements

This participantRole SHALL contain exactly one [1..1] @classCode="AGNT" Agent (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1198-8670).

Default ValueROL
Pattern ValueAGNT
130. Observation.participant:participant2.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/fhir/cda/StructureDefinition/II
131. Observation.participant:participant2.participantRole.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
132. Observation.participant:participant2.participantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
133. Observation.participant:participant2.participantRole.code
Control0..1
BindingThe codes SHOULD be taken from Personal And Legal Relationship Role Type
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:1198-28440).

134. Observation.participant:participant2.participantRole.addr
Definition

Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD(USRealmAddressADUSFIELDED)
Requirements

This participantRole SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:1198-8671).

InvariantsDefined on this element
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296). (: )
135. Observation.participant:participant2.participantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

This participantRole SHOULD contain zero or more [0..*] telecom (CONF:1198-8672).

136. Observation.participant:participant2.participantRole.playingDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
137. Observation.participant:participant2.participantRole.playingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
Requirements

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

138. Observation.participant:participant2.participantRole.playingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
Default ValueENT
139. Observation.participant:participant2.participantRole.playingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
140. Observation.participant:participant2.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/fhir/cda/StructureDefinition/II
141. Observation.participant:participant2.participantRole.playingEntity.code
Control0..1
BindingThe codes SHOULD be taken from Healthcare Agent Qualifier
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This playingEntity SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Agent Qualifier urn:oid:2.16.840.1.113883.11.20.9.51 DYNAMIC (CONF:1198-28444).

142. Observation.participant:participant2.participantRole.playingEntity.quantity
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
143. Observation.participant:participant2.participantRole.playingEntity.name
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Requirements

This playingEntity SHALL contain exactly one [1..1] name (CONF:1198-8673).

144. Observation.participant:participant2.participantRole.playingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
145. Observation.participant:participant2.participantRole.scopingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
146. Observation.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
147. Observation.entryRelationship.typeCode
Control1..1
Typecode
148. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
149. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
150. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
151. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
152. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
153. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
154. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
155. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
156. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
157. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
158. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
159. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
160. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
161. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
162. Observation.reference
Control0..*
TypeElement
SlicingThis element introduces a set of slices on Observation.reference. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ externalDocument
  • ,
  • value @ typeCode
163. Observation.reference.typeCode
Control1..1
Typecode
164. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
165. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
166. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
167. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
168. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
169. Observation.reference:reference1
SliceNamereference1
Control1..*
TypeElement
Requirements

SHOULD contain at least one [1..*] reference (CONF:1198-8692) such that it

170. Observation.reference:reference1.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8694).

Pattern ValueREFR
171. Observation.reference:reference1.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
172. Observation.reference:reference1.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
173. Observation.reference:reference1.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
174. Observation.reference:reference1.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
175. Observation.reference:reference1.externalDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
Requirements

SHALL contain exactly one [1..1] externalDocument (CONF:1198-8693).

176. Observation.reference:reference1.externalDocument.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassDocument
Typecode
Default ValueDOC
177. Observation.reference:reference1.externalDocument.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
178. Observation.reference:reference1.externalDocument.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/fhir/cda/StructureDefinition/II
179. Observation.reference:reference1.externalDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This externalDocument SHALL contain at least one [1..*] id (CONF:1198-8695).

180. Observation.reference:reference1.externalDocument.code
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-DocumentType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
181. Observation.reference:reference1.externalDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Requirements

This externalDocument MAY contain zero or one [0..1] text (CONF:1198-8696).

182. Observation.reference:reference1.externalDocument.text.nullFlavor
Definition

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

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
183. Observation.reference:reference1.externalDocument.text.charset
Definition

For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 [].

Control0..1
Typecode
184. Observation.reference:reference1.externalDocument.text.compression
Definition

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

Control0..1
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
185. Observation.reference:reference1.externalDocument.text.integrityCheck
Definition

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

Control0..1
Typebase64Binary
186. Observation.reference:reference1.externalDocument.text.integrityCheckAlgorithm
Definition

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

Control0..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
187. Observation.reference:reference1.externalDocument.text.language
Definition

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

Control0..1
Typecode
188. Observation.reference:reference1.externalDocument.text.mediaType
Definition

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

Control0..1
Typecode
189. Observation.reference:reference1.externalDocument.text.representation
Control0..1
Typecode
190. Observation.reference:reference1.externalDocument.text.data[x]
Definition

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

Control0..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
191. Observation.reference:reference1.externalDocument.text.reference
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Requirements

The text, if present, MAY contain zero or one [0..1] reference (CONF:1198-8697).

InvariantsDefined on this element
1198-8698: The URL of a referenced advance directive document **MAY** be present, and **SHALL** be represented in Observation/reference/ExternalDocument/text/reference (CONF:1198-8698). (: )
1198-8699: If a URL is referenced, then it **SHOULD** have a corresponding linkHTML element in narrative block (CONF:1198-8699). (: )
192. Observation.reference:reference1.externalDocument.text.thumbnail
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
193. Observation.reference:reference1.externalDocument.setId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
194. Observation.reference:reference1.externalDocument.versionNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
195. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
196. Observation.referenceRange
Control0..*
TypeElement
197. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
Default ValueREFV
Fixed ValueREFV
198. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange