Clinical Document Architecture
2.0.0-sd-ballot - ballot

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-ballot: CDA 2.0 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: ObservationMedia - XML Profile

Active as of 2023-10-27

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>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/type-profile-style">
    <valueUri value="cda"/>
  </extension>
  <url
       value="http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"/>
  <version value="2.0.0-sd-ballot"/>
  <name value="ObservationMedia"/>
  <title value="ObservationMedia (CDA Class)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-10-27T07:17:32+11: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 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/cda/stds/core/StructureDefinition/InfrastructureRoot"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="ObservationMedia">
      <path value="ObservationMedia"/>
      <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="ObservationMedia.nullFlavor">
      <path value="ObservationMedia.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="ObservationMedia.realmCode">
      <path value="ObservationMedia.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="ObservationMedia.typeId">
      <path value="ObservationMedia.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="ObservationMedia.typeId.nullFlavor">
      <path value="ObservationMedia.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="ObservationMedia.typeId.assigningAuthorityName">
      <path value="ObservationMedia.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="ObservationMedia.typeId.displayable">
      <path value="ObservationMedia.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="ObservationMedia.typeId.root">
      <path value="ObservationMedia.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="ObservationMedia.typeId.extension">
      <path value="ObservationMedia.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="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="InfrastructureRoot.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"/>
      <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.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://hl7.org/fhir/ValueSet/all-languages"/>
      </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>
    <element id="ObservationMedia.sdtcPrecondition2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
        <valueString value="precondition2"/>
      </extension>
      <path value="ObservationMedia.sdtcPrecondition2"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="ObservationMedia.sdtcPrecondition2"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"/>
      </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.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://hl7.org/fhir/ValueSet/all-languages"/>
      </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>
    <element id="ObservationMedia.sdtcPrecondition2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace">
        <valueUri value="urn:hl7-org:sdtc"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name">
        <valueString value="precondition2"/>
      </extension>
      <path value="ObservationMedia.sdtcPrecondition2"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code
              value="http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"/>
      </type>
    </element>
  </differential>
</StructureDefinition>