RegionOfInterest (CDA Class) - XML Representation - Clinical Document Architecture v2.0.1

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions
Logical Model: CDAR2.RegionOfInterest - XML Profile

Active as of 2023-10-03
XML representation of the RegionOfInterest logical model.
Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="RegionOfInterest"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>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 &quot;circling&quot; 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 &quot;SUBJ&quot;. A RegionOfInterest must reference exactly one ObservationMedia or one ExternalObservation. If the RegionOfInterest is the target of a &lt;renderMultimedia&gt; reference, then it shall only reference an ObservationMedia and not an ExternalObservation.</p>
      <p>An XML attribute &quot;ID&quot; 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).</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
    <valueUri value="regionOfInterest"/>
  </extension>
  <url
       value="http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"/>
  <version value="2.0.1"/>
  <name value="CDAR2.RegionOfInterest"/>
  <title value="RegionOfInterest (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-10-03T20:44:04+00:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structdoc"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="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 &quot;circling&quot; 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 &quot;SUBJ&quot;. 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 &quot;ID&quot; 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 value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type
        value="http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="RegionOfInterest">
      <path value="RegionOfInterest"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="Base definition for all types defined in FHIR type system."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="ele-1"/>
        <severity value="error"/>
        <human value="All FHIR elements must have a @value or children"/>
        <expression
                    value="hasValue() or (children().count() &gt; id.count())"/>
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="RegionOfInterest.ID">
      <path value="RegionOfInterest.ID"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.ID"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="id"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"/>
      </type>
    </element>
    <element id="RegionOfInterest.classCode">
      <path value="RegionOfInterest.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.classCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="ROIOVL"/>
      <fixedCode value="ROIOVL"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClassROI"/>
      </binding>
    </element>
    <element id="RegionOfInterest.moodCode">
      <path value="RegionOfInterest.moodCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.moodCode"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="EVN"/>
      <fixedCode value="EVN"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
      </binding>
    </element>
    <element id="RegionOfInterest.realmCode">
      <path value="RegionOfInterest.realmCode"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.realmCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="RegionOfInterest.typeId">
      <path value="RegionOfInterest.typeId"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.typeId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.templateId">
      <path value="RegionOfInterest.templateId"/>
      <definition
                  value="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 value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.id">
      <path value="RegionOfInterest.id"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.id"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.code">
      <path value="RegionOfInterest.code"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.code"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="RegionOfInterest.value">
      <path value="RegionOfInterest.value"/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.value"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/INT"/>
      </type>
    </element>
    <element id="RegionOfInterest.subject">
      <path value="RegionOfInterest.subject"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="RegionOfInterest.subject"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
      </type>
    </element>
    <element id="RegionOfInterest.specimen">
      <path value="RegionOfInterest.specimen"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.specimen"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
      </type>
    </element>
    <element id="RegionOfInterest.performer">
      <path value="RegionOfInterest.performer"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.performer"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
      </type>
    </element>
    <element id="RegionOfInterest.author">
      <path value="RegionOfInterest.author"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.author"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
      </type>
    </element>
    <element id="RegionOfInterest.informant">
      <path value="RegionOfInterest.informant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.informant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
      </type>
    </element>
    <element id="RegionOfInterest.participant">
      <path value="RegionOfInterest.participant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.participant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
      </type>
    </element>
    <element id="RegionOfInterest.entryRelationship">
      <path value="RegionOfInterest.entryRelationship"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.entryRelationship"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
      </type>
    </element>
    <element id="RegionOfInterest.reference">
      <path value="RegionOfInterest.reference"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.reference"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
      </type>
    </element>
    <element id="RegionOfInterest.precondition">
      <path value="RegionOfInterest.precondition"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="RegionOfInterest.precondition"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="RegionOfInterest">
      <path value="RegionOfInterest"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="RegionOfInterest.ID">
      <path value="RegionOfInterest.ID"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"/>
      </type>
    </element>
    <element id="RegionOfInterest.classCode">
      <path value="RegionOfInterest.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="ROIOVL"/>
      <fixedCode value="ROIOVL"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActClassROI"/>
      </binding>
    </element>
    <element id="RegionOfInterest.moodCode">
      <path value="RegionOfInterest.moodCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <defaultValueCode value="EVN"/>
      <fixedCode value="EVN"/>
      <binding>
        <strength value="required"/>
        <valueSet value="http://terminology.hl7.org/ValueSet/v3-ActMood"/>
      </binding>
    </element>
    <element id="RegionOfInterest.realmCode">
      <path value="RegionOfInterest.realmCode"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="RegionOfInterest.typeId">
      <path value="RegionOfInterest.typeId"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.templateId">
      <path value="RegionOfInterest.templateId"/>
      <definition
                  value="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 value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.id">
      <path value="RegionOfInterest.id"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="RegionOfInterest.code">
      <path value="RegionOfInterest.code"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="RegionOfInterest.value">
      <path value="RegionOfInterest.value"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/INT"/>
      </type>
    </element>
    <element id="RegionOfInterest.subject">
      <path value="RegionOfInterest.subject"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
      </type>
    </element>
    <element id="RegionOfInterest.specimen">
      <path value="RegionOfInterest.specimen"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
      </type>
    </element>
    <element id="RegionOfInterest.performer">
      <path value="RegionOfInterest.performer"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
      </type>
    </element>
    <element id="RegionOfInterest.author">
      <path value="RegionOfInterest.author"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
      </type>
    </element>
    <element id="RegionOfInterest.informant">
      <path value="RegionOfInterest.informant"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
      </type>
    </element>
    <element id="RegionOfInterest.participant">
      <path value="RegionOfInterest.participant"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
      </type>
    </element>
    <element id="RegionOfInterest.entryRelationship">
      <path value="RegionOfInterest.entryRelationship"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
      </type>
    </element>
    <element id="RegionOfInterest.reference">
      <path value="RegionOfInterest.reference"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
      </type>
    </element>
    <element id="RegionOfInterest.precondition">
      <path value="RegionOfInterest.precondition"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
      </type>
    </element>
  </differential>
</StructureDefinition>