Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-06-19 |
XML representation of the RegionOfInterest logical model.
<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 "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.</p>
<p>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).</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/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="regionOfInterest"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
<valueUri
value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-profile-style">
<valueUri value="cda"/>
</extension>
<url
value="http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"/>
<version value="2.0.0-sd-202406-matchbox-patch"/>
<name value="RegionOfInterest"/>
<title value="RegionOfInterest (CDA Class)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-06-19T17:47:42+02: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/structure"/>
</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 "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)."/>
<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/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
<derivation value="specialization"/>
<snapshot>
<element id="RegionOfInterest">
<path value="RegionOfInterest"/>
<short value="Base for all types and resources"/>
<definition
value="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 value="1"/>
<max value="1"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="RegionOfInterest.nullFlavor">
<path value="RegionOfInterest.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="RegionOfInterest.realmCode">
<path value="RegionOfInterest.realmCode"/>
<definition
value="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 value="0"/>
<max value="*"/>
<base>
<path value="InfrastructureRoot.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"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="InfrastructureRoot.typeId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
</type>
</element>
<element id="RegionOfInterest.typeId.nullFlavor">
<path value="RegionOfInterest.typeId.nullFlavor"/>
<representation value="xmlAttr"/>
<label value="Exceptional Value Detail"/>
<definition
value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ANY.nullFlavor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
</binding>
</element>
<element id="RegionOfInterest.typeId.assigningAuthorityName">
<path value="RegionOfInterest.typeId.assigningAuthorityName"/>
<representation value="xmlAttr"/>
<label value="Assigning Authority Name"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="II.assigningAuthorityName"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</type>
</element>
<element id="RegionOfInterest.typeId.displayable">
<path value="RegionOfInterest.typeId.displayable"/>
<representation value="xmlAttr"/>
<label value="Displayable"/>
<definition
value="Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="II.displayable"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"/>
</type>
</element>
<element id="RegionOfInterest.typeId.root">
<path value="RegionOfInterest.typeId.root"/>
<representation value="xmlAttr"/>
<label value="Root"/>
<definition value="Identifies the type as an HL7 Registered model"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="II.root"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/oid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/uuid"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/ruid"/>
</type>
<fixedString value="2.16.840.1.113883.1.3"/>
</element>
<element id="RegionOfInterest.typeId.extension">
<path value="RegionOfInterest.typeId.extension"/>
<representation value="xmlAttr"/>
<label value="Extension"/>
<definition
value="A character string as a unique identifier within the scope of the identifier root."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="II.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
<profile
value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
</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="InfrastructureRoot.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"/>
<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://hl7.org/cda/stds/core/ValueSet/CDAActMood"/>
</binding>
</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>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0"/>
</binding>
</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>
<element id="RegionOfInterest.sdtcPrecondition2">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="precondition2"/>
</extension>
<path value="RegionOfInterest.sdtcPrecondition2"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="RegionOfInterest.sdtcPrecondition2"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"/>
</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://hl7.org/cda/stds/core/ValueSet/CDAActMood"/>
</binding>
</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>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-ROIOverlayShape|2.0.0"/>
</binding>
</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>
<element id="RegionOfInterest.sdtcPrecondition2">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
<valueUri value="urn:hl7-org:sdtc"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/xml-name">
<valueString value="precondition2"/>
</extension>
<path value="RegionOfInterest.sdtcPrecondition2"/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"/>
</type>
</element>
</differential>
</StructureDefinition>