RegionOfInterest (CDA Class) - Clinical Document Architecture with Australian Schema v1.0.0

Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) 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.0
Active as of 2024-08-29			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).

Usage:

Use this Logical Model Profile: Entry (CDA Class), EntryRelationship (CDA Class) and OrganizerComponent (CDA Class)

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
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: ADHA 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
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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

Name	Card.	Type	Description & Constraints
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: ADHA 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
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

Name	Card.	Type	Description & Constraints
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: ADHA 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
templateId	0..*	II
@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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
RegionOfInterest.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

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:

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
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: ADHA 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
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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

Key Elements View

Name	Card.	Type	Description & Constraints
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: ADHA 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
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

Snapshot View

Name	Card.	Type	Description & Constraints
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: ADHA 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
templateId	0..*	II
@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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
RegionOfInterest.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
RegionOfInterest.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
RegionOfInterest.classCode	required	Fixed Value: ROIOVL `http://terminology.hl7.org/ValueSet/v3-ActClassROI`
RegionOfInterest.moodCode	required	Fixed Value: EVN `http://hl7.org/cda/stds/core/ValueSet/CDAActMood` from this IG
RegionOfInterest.code	required	ROIOverlayShape `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`

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:

Other representations of profile: CSV, Excel

IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-08-29
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change