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: RegionOfInterest (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest Version: 2.0.1
Active as of 2023-10-03 Computable Name: CDAR2.RegionOfInterest

A derivative of the RIM Observation class that represents a region of interest on an image, using an overlay shape. RegionOfInterest is used to make reference to specific regions in images, e.g., to specify the site of a physical finding by “circling” a region in a schematic picture of a human body. The units of the coordinate values in RegionOfInterest.value are in pixels, expressed as a list of integers. The origin is in the upper left hand corner, with positive X values going to the right and positive Y values going down. The relationship between a RegionOfInterest and its referenced ObservationMedia or ExternalObservation is specified by traversing the entryRelationship or reference class, respectively, where typeCode equals “SUBJ”. A RegionOfInterest must reference exactly one ObservationMedia or one ExternalObservation. If the RegionOfInterest is the target of a renderMultimedia reference, then it shall only reference an ObservationMedia and not an ExternalObservation. An XML attribute “ID” of type XML ID, is added to RegionOfInterest within the CDA Schema. This attribute serves as the target of a renderMultiMedia reference (see renderMultiMedia). All values of attributes of type XML ID must be unique within the document (per the W3C XML specification).

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @ID 0..1xs:ID
... @classCode 1..1csBinding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1csBinding: ActMood (required)
Fixed Value: EVN
... typeId 0..1II
... templateId 0..*II
... id 1..*II
... code 1..1CS
... value 1..*INT
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
RegionOfInterest.moodCoderequiredFixed Value: EVN

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel