STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/ED.xml

Raw XML (canonical form)

Logical Model V3 Data type ED (EncapsulatedData)

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ED"/>
  <extension url="http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/ED"/>
  <name value="V3 Data type ED (EncapsulatedData)"/>
  <display value="V3 Data type ED (EncapsulatedData)"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7"/>
  <description value="Data that is primarily intended for human interpretation or for further machine processing
   outside the scope of HL7. This includes unformatted or formatted written language, multimedia
   data, or structured information in as defined by a different standard (e.g., XML-signatures.)
   Instead of the data itself, an may contain only a reference (see .) Note that the data
   type is a specialization of the data type when the media type is text/plain."/>
  <kind value="logical"/>
  <abstract value="false"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ANY"/>
  <snapshot>
    <element>
      <path value="ED"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="ED.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"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="ED.representation"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.data"/>
      <representation value="xmlText"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
    <element>
      <path value="ED.mediaType"/>
      <representation value="xmlAttr"/>
      <label value="Media Type"/>
      <definition value="Identifies the type of the encapsulated data and identifies a method to interpret or render
       the data."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.charset"/>
      <representation value="xmlAttr"/>
      <label value="Charset"/>
      <definition value="For character-based encoding types, this property specifies the character set and character
       encoding used. The charset shall be identified by an Internet Assigned Numbers Authority
       (IANA) Charset Registration [] in accordance with RFC 2978 []."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.language"/>
      <representation value="xmlAttr"/>
      <label value="Language"/>
      <definition value="For character based information the language property specifies the human language of
       the text."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.compression"/>
      <representation value="xmlAttr"/>
      <label value="Compression"/>
      <definition value="Indicates whether the raw byte data is compressed, and what compression algorithm was
       used."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-CompressionAlgorithm"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="ED.reference"/>
      <label value="Reference"/>
      <definition value="A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to
       precisely the same binary data that could as well have been provided as inline data."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="TEL"/>
      </type>
    </element>
    <element>
      <path value="ED.integrityCheck"/>
      <representation value="xmlAttr"/>
      <label value="Integrity Check"/>
      <definition value="The integrity check is a short binary value representing a cryptographically strong checksum
       that is calculated over the binary data. The purpose of this property, when communicated
       with a reference is for anyone to validate later whether the reference still resolved
       to the same data that the reference resolved to when the encapsulated data value with
       reference was created."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
    <element>
      <path value="ED.integrityCheckAlgorithm"/>
      <representation value="xmlAttr"/>
      <label value="Integrity Check Algorithm"/>
      <definition value="Specifies the algorithm used to compute the integrityCheck value. The cryptographically
       strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard.
       It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in
       the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default
       choice for the integrity check algorithm. Note that SHA-256 is also entering widespread
       usage."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-IntegrityCheckAlgorithm"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="ED.thumbnail"/>
      <label value="Thumbnail"/>
      <definition value="An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources
       than the full data, while still maintaining some distinctive similarity with the full
       data. A thumbnail is typically used with by-reference encapsulated data. It allows a user
       to select data more efficiently before actually downloading through the reference."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="ED"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="ED"/>
      <min value="1"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
    </element>
    <element>
      <path value="ED.representation"/>
      <representation value="xmlAttr"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.data"/>
      <representation value="xmlText"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
    <element>
      <path value="ED.mediaType"/>
      <representation value="xmlAttr"/>
      <label value="Media Type"/>
      <definition value="Identifies the type of the encapsulated data and identifies a method to interpret or render
       the data."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.charset"/>
      <representation value="xmlAttr"/>
      <label value="Charset"/>
      <definition value="For character-based encoding types, this property specifies the character set and character
       encoding used. The charset shall be identified by an Internet Assigned Numbers Authority
       (IANA) Charset Registration [] in accordance with RFC 2978 []."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.language"/>
      <representation value="xmlAttr"/>
      <label value="Language"/>
      <definition value="For character based information the language property specifies the human language of
       the text."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="ED.compression"/>
      <representation value="xmlAttr"/>
      <label value="Compression"/>
      <definition value="Indicates whether the raw byte data is compressed, and what compression algorithm was
       used."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-CompressionAlgorithm"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="ED.reference"/>
      <label value="Reference"/>
      <definition value="A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to
       precisely the same binary data that could as well have been provided as inline data."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="TEL"/>
      </type>
    </element>
    <element>
      <path value="ED.integrityCheck"/>
      <representation value="xmlAttr"/>
      <label value="Integrity Check"/>
      <definition value="The integrity check is a short binary value representing a cryptographically strong checksum
       that is calculated over the binary data. The purpose of this property, when communicated
       with a reference is for anyone to validate later whether the reference still resolved
       to the same data that the reference resolved to when the encapsulated data value with
       reference was created."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
    <element>
      <path value="ED.integrityCheckAlgorithm"/>
      <representation value="xmlAttr"/>
      <label value="Integrity Check Algorithm"/>
      <definition value="Specifies the algorithm used to compute the integrityCheck value. The cryptographically
       strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard.
       It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in
       the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default
       choice for the integrity check algorithm. Note that SHA-256 is also entering widespread
       usage."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/v3-IntegrityCheckAlgorithm"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="ED.thumbnail"/>
      <label value="Thumbnail"/>
      <definition value="An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources
       than the full data, while still maintaining some distinctive similarity with the full
       data. A thumbnail is typically used with by-reference encapsulated data. It allows a user
       to select data more efficiently before actually downloading through the reference."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="ED"/>
      </type>
    </element>
  </differential>
</StructureDefinition>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.