RegionOfInterest (CDA Class) - Definitions - Clinical Document Architecture v2.0.1

Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.RegionOfInterest - Detailed Descriptions

Active as of 2023-10-03

Definitions for the RegionOfInterest logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. RegionOfInterest
Control	1..1
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. RegionOfInterest.ID
Control	0..1
Type	id(xs:ID)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RegionOfInterest.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassROI
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	ROIOVL
Fixed Value	ROIOVL
6. RegionOfInterest.moodCode
Control	1..1
Binding	The codes SHALL be taken from ActMood
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	EVN
Fixed Value	EVN
8. RegionOfInterest.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. RegionOfInterest.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. RegionOfInterest.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. RegionOfInterest.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. RegionOfInterest.code
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
18. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
20. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
22. RegionOfInterest.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
24. RegionOfInterest.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
26. RegionOfInterest.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
28. RegionOfInterest.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
30. RegionOfInterest.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
32. RegionOfInterest.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
34. RegionOfInterest.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
36. RegionOfInterest.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition

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

0. RegionOfInterest
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. RegionOfInterest.ID
Control	0..1
Type	id(xs:ID)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RegionOfInterest.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassROI
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	ROIOVL
Fixed Value	ROIOVL
6. RegionOfInterest.moodCode
Control	1..1
Binding	The codes SHALL be taken from ActMood
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	EVN
Fixed Value	EVN
8. RegionOfInterest.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. RegionOfInterest.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. RegionOfInterest.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. RegionOfInterest.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. RegionOfInterest.code
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
18. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
20. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
22. RegionOfInterest.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
24. RegionOfInterest.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
26. RegionOfInterest.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
28. RegionOfInterest.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
30. RegionOfInterest.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
32. RegionOfInterest.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
34. RegionOfInterest.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
36. RegionOfInterest.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition

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

0. RegionOfInterest
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. RegionOfInterest.ID
Control	0..1
Type	id(xs:ID)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RegionOfInterest.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassROI
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	ROIOVL
Fixed Value	ROIOVL
6. RegionOfInterest.moodCode
Control	1..1
Binding	The codes SHALL be taken from ActMood
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Default Value	EVN
Fixed Value	EVN
8. RegionOfInterest.realmCode
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. RegionOfInterest.typeId
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. RegionOfInterest.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
14. RegionOfInterest.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. RegionOfInterest.code
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
18. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
20. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
22. RegionOfInterest.specimen
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Specimen
24. RegionOfInterest.performer
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Performer2
26. RegionOfInterest.author
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Author
28. RegionOfInterest.informant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Informant
30. RegionOfInterest.participant
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Participant2
32. RegionOfInterest.entryRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
34. RegionOfInterest.reference
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Reference
36. RegionOfInterest.precondition
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/Precondition

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents | QA Report | Version History external | | Propose a change