FHIR IG Statistics: StructureDefinition/RegionOfInterest
| Package | au.digitalhealth.cda.schema |
| Type | StructureDefinition |
| Id | RegionOfInterest |
| FHIR Version | R5 |
| Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-RegionOfInterest.html |
| URL | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-07-21T22:05:27+00:00 |
| Name | RegionOfInterest |
| Title | RegionOfInterest (CDA Class) |
| Realm | au |
| Authority | national |
| Description | 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). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| Kind | logical |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
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).
Source
{
"resourceType": "StructureDefinition",
"id": "RegionOfInterest",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "regionOfInterest"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
}
],
"url": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest",
"version": "1.0.0",
"name": "RegionOfInterest",
"title": "RegionOfInterest (CDA Class)",
"status": "active",
"experimental": false,
"date": "2025-07-21T22:05:27+00:00",
"publisher": "HL7",
"description": "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.\n\nAn 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).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.0.0"
}
],
"element": [
{
"id": "RegionOfInterest",
"path": "RegionOfInterest",
"short": "Base for all types and resources",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "RegionOfInterest.nullFlavor",
"path": "RegionOfInterest.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "RegionOfInterest.realmCode",
"path": "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",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.realmCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id": "RegionOfInterest.typeId",
"path": "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.",
"min": 0,
"max": "1",
"base": {
"path": "InfrastructureRoot.typeId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}
]
},
{
"id": "RegionOfInterest.typeId.nullFlavor",
"path": "RegionOfInterest.typeId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "RegionOfInterest.typeId.assigningAuthorityName",
"path": "RegionOfInterest.typeId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "RegionOfInterest.typeId.displayable",
"path": "RegionOfInterest.typeId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id": "RegionOfInterest.typeId.root",
"path": "RegionOfInterest.typeId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "Identifies the type as an HL7 Registered model",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "RegionOfInterest.typeId.extension",
"path": "RegionOfInterest.typeId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 1,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "RegionOfInterest.templateId",
"path": "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",
"min": 0,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "RegionOfInterest.ID",
"path": "RegionOfInterest.ID",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "RegionOfInterest.ID",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"
]
}
]
},
{
"id": "RegionOfInterest.classCode",
"path": "RegionOfInterest.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "RegionOfInterest.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ROIOVL",
"fixedCode": "ROIOVL",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassROI"
}
},
{
"id": "RegionOfInterest.moodCode",
"path": "RegionOfInterest.moodCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "RegionOfInterest.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "EVN",
"fixedCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id": "RegionOfInterest.id",
"path": "RegionOfInterest.id",
"min": 1,
"max": "*",
"base": {
"path": "RegionOfInterest.id",
"min": 1,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "RegionOfInterest.code",
"path": "RegionOfInterest.code",
"min": 1,
"max": "1",
"base": {
"path": "RegionOfInterest.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0"
}
},
{
"id": "RegionOfInterest.value",
"path": "RegionOfInterest.value",
"min": 1,
"max": "*",
"base": {
"path": "RegionOfInterest.value",
"min": 1,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "RegionOfInterest.subject",
"path": "RegionOfInterest.subject",
"min": 0,
"max": "1",
"base": {
"path": "RegionOfInterest.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id": "RegionOfInterest.specimen",
"path": "RegionOfInterest.specimen",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
}
]
},
{
"id": "RegionOfInterest.performer",
"path": "RegionOfInterest.performer",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
}
]
},
{
"id": "RegionOfInterest.author",
"path": "RegionOfInterest.author",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id": "RegionOfInterest.informant",
"path": "RegionOfInterest.informant",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id": "RegionOfInterest.participant",
"path": "RegionOfInterest.participant",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "RegionOfInterest.entryRelationship",
"path": "RegionOfInterest.entryRelationship",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "RegionOfInterest.reference",
"path": "RegionOfInterest.reference",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.reference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
}
]
},
{
"id": "RegionOfInterest.precondition",
"path": "RegionOfInterest.precondition",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.precondition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
}
]
},
{
"id": "RegionOfInterest.sdtcPrecondition2",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "precondition2"
}
],
"path": "RegionOfInterest.sdtcPrecondition2",
"min": 0,
"max": "*",
"base": {
"path": "RegionOfInterest.sdtcPrecondition2",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"
}
]
}
]
},
"differential": {
"element": [
{
"id": "RegionOfInterest",
"path": "RegionOfInterest",
"min": 1,
"max": "1"
},
{
"id": "RegionOfInterest.ID",
"path": "RegionOfInterest.ID",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"type": [
{
"code": "id",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"
]
}
]
},
{
"id": "RegionOfInterest.classCode",
"path": "RegionOfInterest.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "ROIOVL",
"fixedCode": "ROIOVL",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassROI"
}
},
{
"id": "RegionOfInterest.moodCode",
"path": "RegionOfInterest.moodCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode": "EVN",
"fixedCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id": "RegionOfInterest.id",
"path": "RegionOfInterest.id",
"min": 1,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "RegionOfInterest.code",
"path": "RegionOfInterest.code",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0"
}
},
{
"id": "RegionOfInterest.value",
"path": "RegionOfInterest.value",
"min": 1,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/INT"
}
]
},
{
"id": "RegionOfInterest.subject",
"path": "RegionOfInterest.subject",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id": "RegionOfInterest.specimen",
"path": "RegionOfInterest.specimen",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
}
]
},
{
"id": "RegionOfInterest.performer",
"path": "RegionOfInterest.performer",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
}
]
},
{
"id": "RegionOfInterest.author",
"path": "RegionOfInterest.author",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id": "RegionOfInterest.informant",
"path": "RegionOfInterest.informant",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id": "RegionOfInterest.participant",
"path": "RegionOfInterest.participant",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "RegionOfInterest.entryRelationship",
"path": "RegionOfInterest.entryRelationship",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "RegionOfInterest.reference",
"path": "RegionOfInterest.reference",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
}
]
},
{
"id": "RegionOfInterest.precondition",
"path": "RegionOfInterest.precondition",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
}
]
},
{
"id": "RegionOfInterest.sdtcPrecondition2",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "precondition2"
}
],
"path": "RegionOfInterest.sdtcPrecondition2",
"min": 0,
"max": "*",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"
}
]
}
]
}
}
FHIR