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

Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

Logical Model: au-RegionOfInterest - Detailed Descriptions

Active as of 2024-12-18

Definitions for the au-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
Short	Australian adaptation of the HL7 International CDA RegionOfInterest class
Control	1..1
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
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 (required to `http://terminology.hl7.org/ValueSet/v3-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 CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood`)
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.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
10. RegionOfInterest.code
Control	1..1
Binding	The codes SHALL be taken from ROIOverlayShape (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
12. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
14. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
16. RegionOfInterest.specimen
Short	Australian-adapted Specimen class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen
18. RegionOfInterest.performer
Short	Australian-adapted Performer class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2
20. RegionOfInterest.author
Short	Australian-adapted Author class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author
22. RegionOfInterest.informant
Short	Australian-adapted Informant class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant
24. RegionOfInterest.participant
Short	Australian-adapted Participant2 class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2
26. RegionOfInterest.entryRelationship
Short	Australian-adapted EntryRelationship class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship
28. RegionOfInterest.reference
Short	Australian-adapted Reference class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference
30. RegionOfInterest.precondition
Short	Australian-adapted Precondition class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition

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

0. RegionOfInterest
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short	Australian adaptation of the HL7 International CDA RegionOfInterest classBase for all types and resources
Control	10..1*
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. RegionOfInterest.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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.
Label	Exceptional Value Detail
4. RegionOfInterest.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. RegionOfInterest.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. RegionOfInterest.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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.
Label	Exceptional Value Detail
10. RegionOfInterest.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
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.
Label	Assigning Authority Name
12. RegionOfInterest.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
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.
Label	Displayable
14. RegionOfInterest.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
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.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. RegionOfInterest.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
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.
Label	Extension
18. 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
20. 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.
22. RegionOfInterest.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassROI (required to `http://terminology.hl7.org/ValueSet/v3-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`
24. RegionOfInterest.moodCode
Control	1..1
Binding	The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood`)
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`
26. RegionOfInterest.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
28. RegionOfInterest.code
Control	1..1
Binding	The codes SHALL be taken from ROIOverlayShape (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
30. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
32. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
34. RegionOfInterest.specimen
Short	Australian-adapted Specimen class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen
36. RegionOfInterest.performer
Short	Australian-adapted Performer class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2
38. RegionOfInterest.author
Short	Australian-adapted Author class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author
40. RegionOfInterest.informant
Short	Australian-adapted Informant class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant
42. RegionOfInterest.participant
Short	Australian-adapted Participant2 class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2
44. RegionOfInterest.entryRelationship
Short	Australian-adapted EntryRelationship class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship
46. RegionOfInterest.reference
Short	Australian-adapted Reference class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference
48. RegionOfInterest.precondition
Short	Australian-adapted Precondition class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition

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

0. RegionOfInterest
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Australian adaptation of the HL7 International CDA RegionOfInterest class
Control	1..1
Is Modifier	false
Logical Container	ADHA ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. RegionOfInterest.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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.
Label	Exceptional Value Detail
4. RegionOfInterest.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. RegionOfInterest.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. RegionOfInterest.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
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.
Label	Exceptional Value Detail
10. RegionOfInterest.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
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.
Label	Assigning Authority Name
12. RegionOfInterest.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
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.
Label	Displayable
14. RegionOfInterest.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
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.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. RegionOfInterest.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
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.
Label	Extension
18. 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
20. 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.
22. RegionOfInterest.classCode
Control	1..1
Binding	The codes SHALL be taken from ActClassROI (required to `http://terminology.hl7.org/ValueSet/v3-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`
24. RegionOfInterest.moodCode
Control	1..1
Binding	The codes SHALL be taken from CDAActMood (required to `http://hl7.org/cda/stds/core/ValueSet/CDAActMood`)
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`
26. RegionOfInterest.id
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
28. RegionOfInterest.code
Control	1..1
Binding	The codes SHALL be taken from ROIOverlayShape (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape\|2.0.0`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
30. RegionOfInterest.value
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/INT
32. RegionOfInterest.subject
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Subject
34. RegionOfInterest.specimen
Short	Australian-adapted Specimen class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Specimen
36. RegionOfInterest.performer
Short	Australian-adapted Performer class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Performer2
38. RegionOfInterest.author
Short	Australian-adapted Author class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Author
40. RegionOfInterest.informant
Short	Australian-adapted Informant class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Informant
42. RegionOfInterest.participant
Short	Australian-adapted Participant2 class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Participant2
44. RegionOfInterest.entryRelationship
Short	Australian-adapted EntryRelationship class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntryRelationship
46. RegionOfInterest.reference
Short	Australian-adapted Reference class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Reference
48. RegionOfInterest.precondition
Short	Australian-adapted Precondition class
Control	0..*
Type	http://ns.electronichealth.net.au/cda/StructureDefinition/au-Precondition