Clinical Document Architecture with Australian Schema - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: RegionOfInterest (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest Version: 1.0.1
Active as of 2025-10-10 Maturity Level: 1 Responsible: HL7 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).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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

Path Status Usage ValueSet Version Source
RegionOfInterest.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RegionOfInterest.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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)

Path Status Usage ValueSet Version Source
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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

Path Status Usage ValueSet Version Source
RegionOfInterest.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RegionOfInterest.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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

Path Status Usage ValueSet Version Source
RegionOfInterest.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RegionOfInterest.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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)

Path Status Usage ValueSet Version Source
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RegionOfInterest 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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

Path Status Usage ValueSet Version Source
RegionOfInterest.nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.typeId.​nullFlavor Base required CDANullFlavor 📦1.0.1 This IG
RegionOfInterest.classCode Base required ActClassROI 📦2.0.0 THO v5.2
RegionOfInterest.moodCode Base required CDAActMood 📦1.0.1 This IG
RegionOfInterest.code Base required ROIOverlayShape 📍2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RegionOfInterest.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel