HL7.CDA.US.CCDA\Boundary Observation - Definitions

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: BoundaryObservation - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.6.2.11 resource profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. Observation
2. Observation.classCode
Requirements	SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9282).
Pattern Value	OBS
3. Observation.moodCode
Requirements	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9283).
Pattern Value	EVN
4. Observation.code
Requirements	SHALL contain exactly one [1..1] code (CONF:81-9284).
5. Observation.code.code
Control	1..1
Requirements	This code SHALL contain exactly one [1..1] @code="113036" Frames for Display (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4 STATIC) (CONF:81-19157).
Pattern Value	113036
6. Observation.value
Control	10..*
Type	Choice of: , http://hl7.org/fhir/cda/StructureDefinition/ED, http://hl7.org/fhir/cda/StructureDefinition/TS, http://hl7.org/fhir/cda/StructureDefinition/II, http://hl7.org/fhir/cda/StructureDefinition/ST, http://hl7.org/fhir/cda/StructureDefinition/CD, http://hl7.org/fhir/cda/StructureDefinition/PQ, http://hl7.org/fhir/cda/StructureDefinition/CE, http://hl7.org/fhir/cda/StructureDefinition/TEL, http://hl7.org/fhir/cda/StructureDefinition/MO, http://hl7.org/fhir/cda/StructureDefinition/AD, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-PQ, http://hl7.org/fhir/cda/StructureDefinition/EN, http://hl7.org/fhir/cda/StructureDefinition/BL, http://hl7.org/fhir/cda/StructureDefinition/REAL, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SC, http://hl7.org/fhir/cda/StructureDefinition/RTO-PQ-PQ, http://hl7.org/fhir/cda/StructureDefinition/CV, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
Requirements	SHALL contain at least one [1..*] value with @xsi:type="INT" (CONF:81-9285).

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

1. Observation
Definition	Base definition for all types defined in FHIR type system.
Control	10..1*
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassObservation
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9282).
Pattern Value	OBS
3. Observation.moodCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9283).
Pattern Value	EVN
4. Observation.code
Definition	Describes what was observed. Sometimes this is called the observation "name".
Control	1..1
Binding	The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitableFor example codes, see LOINCCodes
Type	http://hl7.org/fhir/cda/StructureDefinition/CDCodeableConcept
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHALL contain exactly one [1..1] code (CONF:81-9284). Knowing what kind of observation is being made is essential to understanding the observation.
Alternate Names	Name
Comments	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.
5. 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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	This code SHALL contain exactly one [1..1] @code="113036" Frames for Display (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4 STATIC) (CONF:81-19157).
Pattern Value	113036
6. Observation.value
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/INT
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHALL contain at least one [1..*] value with @xsi:type="INT" (CONF:81-9285).

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

1. Observation
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
2. Observation.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassObservation
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9282).
Pattern Value	OBS
3. Observation.moodCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-9283).
Pattern Value	EVN
4. Observation.negationInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
5. Observation.realmCode
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
6. Observation.typeId
Control	0..1
Type	http://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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
8. Observation.id
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
9. Observation.code
Control	1..1
Binding	The codes SHALL be taken from ObservationType; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHALL contain exactly one [1..1] code (CONF:81-9284).
10. Observation.code.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
11. 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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	This code SHALL contain exactly one [1..1] @code="113036" Frames for Display (CodeSystem: DCM urn:oid:1.2.840.10008.2.16.4 STATIC) (CONF:81-19157).
Pattern Value	113036
12. Observation.code.codeSystem
Definition	Specifies the code system that defines the code.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
13. Observation.code.codeSystemName
Definition	The common name of the coding system.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
14. Observation.code.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
15. Observation.code.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
16. Observation.code.sdtcValueSet
Definition	The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `valueSet`.
17. Observation.code.sdtcValueSetVersion
Definition	The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `valueSetVersion`.
18. Observation.code.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ED
19. Observation.code.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CR
20. Observation.code.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
XML Representation	The type of this property is determined using the xsi:type attribute.
21. Observation.derivationExpr
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ST
22. Observation.text
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ED
XML Representation	The type of this property is determined using the xsi:type attribute.
23. Observation.statusCode
Control	0..1
Binding	The codes SHALL be taken from ActStatus
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
24. Observation.effectiveTime
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-TS
25. Observation.priorityCode
Control	0..1
Binding	The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
26. Observation.repeatNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/IVL-INT
27. Observation.languageCode
Control	0..1
Binding	The codes SHALL be taken from HumanLanguage
Type	http://hl7.org/fhir/cda/StructureDefinition/CS
28. Observation.value
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/INT
XML Representation	The type of this property is determined using the xsi:type attribute.
Requirements	SHALL contain at least one [1..*] value with @xsi:type="INT" (CONF:81-9285).
29. Observation.interpretationCode
Control	0..*
Binding	The codes SHALL be taken from ObservationInterpretation
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
30. Observation.methodCode
Control	0..*
Binding	The codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
31. Observation.targetSiteCode
Definition	Drawn from concept domain ActSite
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/CD
32. Observation.subject
Control	0..1
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Observation.subject.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
34. Observation.subject.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Observation.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
35. Observation.subject.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationTargetSubject
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	SBJ
Fixed Value	SBJ
36. Observation.subject.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
37. Observation.subject.awarenessCode
Control	0..1
Binding	The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
38. Observation.subject.relatedSubject
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
39. Observation.specimen
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Specimen
40. Observation.performer
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Performer2
41. Observation.author
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Author
42. Observation.informant
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Observation.informant.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
44. Observation.informant.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Observation.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
45. Observation.informant.typeCode
Control	1..1
Binding	The codes SHALL be taken from ParticipationInformationGenerator
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INF
Fixed Value	INF
46. Observation.informant.contextControlCode
Control	1..1
Binding	The codes SHALL be taken from ContextControl
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	OP
Fixed Value	OP
47. Observation.informant.assignedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
48. Observation.informant.relatedEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
49. Observation.participant
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Participant2
50. Observation.entryRelationship
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) 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)
51. Observation.entryRelationship.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
52. Observation.entryRelationship.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Observation.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
53. Observation.entryRelationship.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
54. Observation.entryRelationship.inversionInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
55. Observation.entryRelationship.contextConductionInd
Control	1..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	true
56. Observation.entryRelationship.sequenceNumber
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/INT
57. Observation.entryRelationship.negationInd
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
58. Observation.entryRelationship.seperatableInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
59. Observation.entryRelationship.observation
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Observation
60. Observation.entryRelationship.regionOfInterest
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
61. Observation.entryRelationship.observationMedia
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
62. Observation.entryRelationship.substanceAdministration
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
63. Observation.entryRelationship.supply
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Supply
64. Observation.entryRelationship.procedure
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Procedure
65. Observation.entryRelationship.encounter
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Encounter
66. Observation.entryRelationship.organizer
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organizer
67. Observation.entryRelationship.act
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Act
68. Observation.reference
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. Observation.reference.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
70. Observation.reference.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Observation.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
71. Observation.reference.typeCode
Control	1..1
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
72. Observation.reference.seperatableInd
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/BL
73. Observation.reference.externalAct
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalAct
74. Observation.reference.externalObservation
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
75. Observation.reference.externalProcedure
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
76. Observation.reference.externalDocument
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
77. Observation.precondition
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/Precondition
78. Observation.referenceRange
Control	0..*
Type	Element
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Observation.referenceRange.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
80. Observation.referenceRange.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing	This element introduces a set of slices on Observation.referenceRange.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
81. Observation.referenceRange.typeCode
Control	1..1
Binding	The codes SHALL be taken from ActRelationshipPertains
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	REFV
Fixed Value	REFV
82. Observation.referenceRange.observationRange
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ObservationRange