ObservationMedia (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.ObservationMedia - XML Profile

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


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ObservationMedia"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>A derivative of the RIM Observation class that represents multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type.</p>
      <p>An XML attribute &quot;ID&quot; of type XML ID, is added to ObservationMedia 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>
      <p>The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation.</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="observationMedia"/>
  </extension>
  <url
       value="http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"/>
  <version value="2.0.1"/>
  <name value="CDAR2.ObservationMedia"/>
  <title value="ObservationMedia (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 multimedia that is logically part of the current document. This class is only for multimedia that is logically part of the attested content of the document. Rendering a referenced ObservationMedia requires a software tool that recognizes the particular MIME media type.
An XML attribute &quot;ID&quot; of type XML ID, is added to ObservationMedia 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).
The distinction between ObservationMedia and ExternalObservation is that ObservationMedia entries are part of the attested content of the document whereas ExternalObservations are not. For instance, when a clinician draws a picture as part of a progress note, that picture is represented as a CDA ObservationMedia. If that clinician is also describing a finding seen on a chest-x-ray, the referenced chest-x-ray is represented as a CDA ExternalObservation."/>
  <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/ObservationMedia"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="ObservationMedia">
      <path value="ObservationMedia"/>
      <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="ObservationMedia.ID">
      <path value="ObservationMedia.ID"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.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="ObservationMedia.classCode">
      <path value="ObservationMedia.classCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.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="OBS"/>
      <fixedCode value="OBS"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ActClassObservation"/>
      </binding>
    </element>
    <element id="ObservationMedia.moodCode">
      <path value="ObservationMedia.moodCode"/>
      <representation value="xmlAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.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="ObservationMedia.realmCode">
      <path value="ObservationMedia.realmCode"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.realmCode"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="ObservationMedia.typeId">
      <path value="ObservationMedia.typeId"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.typeId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ObservationMedia.templateId">
      <path value="ObservationMedia.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="ObservationMedia.templateId"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ObservationMedia.id">
      <path value="ObservationMedia.id"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.id"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ObservationMedia.languageCode">
      <path value="ObservationMedia.languageCode"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.languageCode"/>
        <min value="0"/>
        <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-HumanLanguage"/>
      </binding>
    </element>
    <element id="ObservationMedia.value">
      <path value="ObservationMedia.value"/>
      <representation value="typeAttr"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.value"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="ObservationMedia.subject">
      <path value="ObservationMedia.subject"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ObservationMedia.subject"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
      </type>
    </element>
    <element id="ObservationMedia.specimen">
      <path value="ObservationMedia.specimen"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.specimen"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
      </type>
    </element>
    <element id="ObservationMedia.performer">
      <path value="ObservationMedia.performer"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.performer"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
      </type>
    </element>
    <element id="ObservationMedia.author">
      <path value="ObservationMedia.author"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.author"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
      </type>
    </element>
    <element id="ObservationMedia.informant">
      <path value="ObservationMedia.informant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.informant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
      </type>
    </element>
    <element id="ObservationMedia.participant">
      <path value="ObservationMedia.participant"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.participant"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
      </type>
    </element>
    <element id="ObservationMedia.entryRelationship">
      <path value="ObservationMedia.entryRelationship"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.entryRelationship"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
      </type>
    </element>
    <element id="ObservationMedia.reference">
      <path value="ObservationMedia.reference"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.reference"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
      </type>
    </element>
    <element id="ObservationMedia.precondition">
      <path value="ObservationMedia.precondition"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.precondition"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="ObservationMedia">
      <path value="ObservationMedia"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element id="ObservationMedia.ID">
      <path value="ObservationMedia.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="ObservationMedia.classCode">
      <path value="ObservationMedia.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="OBS"/>
      <fixedCode value="OBS"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://terminology.hl7.org/ValueSet/v3-ActClassObservation"/>
      </binding>
    </element>
    <element id="ObservationMedia.moodCode">
      <path value="ObservationMedia.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="ObservationMedia.realmCode">
      <path value="ObservationMedia.realmCode"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/CS"/>
      </type>
    </element>
    <element id="ObservationMedia.typeId">
      <path value="ObservationMedia.typeId"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ObservationMedia.templateId">
      <path value="ObservationMedia.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="ObservationMedia.id">
      <path value="ObservationMedia.id"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/II"/>
      </type>
    </element>
    <element id="ObservationMedia.languageCode">
      <path value="ObservationMedia.languageCode"/>
      <min value="0"/>
      <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-HumanLanguage"/>
      </binding>
    </element>
    <element id="ObservationMedia.value">
      <path value="ObservationMedia.value"/>
      <representation value="typeAttr"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="http://hl7.org/cda/stds/core/StructureDefinition/ED"/>
      </type>
    </element>
    <element id="ObservationMedia.subject">
      <path value="ObservationMedia.subject"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Subject"/>
      </type>
    </element>
    <element id="ObservationMedia.specimen">
      <path value="ObservationMedia.specimen"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Specimen"/>
      </type>
    </element>
    <element id="ObservationMedia.performer">
      <path value="ObservationMedia.performer"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Performer2"/>
      </type>
    </element>
    <element id="ObservationMedia.author">
      <path value="ObservationMedia.author"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Author"/>
      </type>
    </element>
    <element id="ObservationMedia.informant">
      <path value="ObservationMedia.informant"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Informant"/>
      </type>
    </element>
    <element id="ObservationMedia.participant">
      <path value="ObservationMedia.participant"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Participant2"/>
      </type>
    </element>
    <element id="ObservationMedia.entryRelationship">
      <path value="ObservationMedia.entryRelationship"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"/>
      </type>
    </element>
    <element id="ObservationMedia.reference">
      <path value="ObservationMedia.reference"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Reference"/>
      </type>
    </element>
    <element id="ObservationMedia.precondition">
      <path value="ObservationMedia.precondition"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition"/>
      </type>
    </element>
  </differential>
</StructureDefinition>