Clinical Document Architecture
2.0.0-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd: CDA2 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: RegionOfInterest (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest Version: 2.0.0-sd
Active as of 2024-05-17 Computable Name: 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 Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0
NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

This structure is derived from InfrastructureRoot

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @ID 0..1 xs:ID
... @classCode 1..1 cs Binding: ActClassROI (required)
Fixed Value: ROIOVL
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... code 1..1 CS Binding: ROIOverlayShape (2.0.0) (required)
... value 1..* INT
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... entryRelationship 0..* EntryRelationship
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
RegionOfInterest.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RegionOfInterest.classCoderequiredFixed Value: ROIOVL
http://terminology.hl7.org/ValueSet/v3-ActClassROI
RegionOfInterest.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
RegionOfInterest.coderequiredROIOverlayShape
http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0

This structure is derived from InfrastructureRoot

 

Other representations of profile: CSV, Excel