Clinical Document Architecture with Australian Schema
1.0.0 - current
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
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest | Version: 1.0.0 | |||
| Active as of 2024-12-18 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RegionOfInterest.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
Key Elements View
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RegionOfInterest.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
| Path | Conformance | ValueSet / Code | URI |
| RegionOfInterest.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RegionOfInterest.classCode | required | Fixed Value: ROIOVLhttp://terminology.hl7.org/ValueSet/v3-ActClassROI | |
| RegionOfInterest.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMoodfrom this IG | |
| RegionOfInterest.code | required | ROIOverlayShapehttp://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| 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
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
