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

Cts2/OpaqueData.xml

Raw XML (canonical form)

Logical Model OpaqueData

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="OpaqueData"/>
  <url value="{http://www.omg.org/spec/CTS2/1.1/Core}OpaqueData"/>
  <name value="OpaqueData"/>
  <display value="CTS2.OpaqueData"/>
  <status value="draft"/>
  <publisher value="Generated by Xsd-to-FHIR"/>
  <contact>
    <name value="Visit the Github repository for more information"/>
    <telecom>
      <system value="other"/>
      <value value="https://github.com/cts2/CTS2-to-FHIR"/>
    </telecom>
  </contact>
  <date value="2016-02-08T19:11:02-07:00"/>
  <description value="Opaque data is the equivalent of an ASN.1 External Type ISO/IEC 8824-1:2008 Information
   technology -- Abstract Syntax Notation One (ASN.1): Specification of basic notion. Clause
   37 - Notation for the       external type or the XML Schema anyType. An OpaqueData instance
   may represent text with an optional spoken or written language code or a     formal structure
   such as embedded HTML, XML or MIME encoded data. When a formal structure is included,
   its type should be specified in the format attribute and, when the type is an XML variant,
   the corresponding     schema (or DTD) should be included in the schema parameter.The OpaqueData
   data type must be encoded in such a way that the content can be represented by a character
   string. Binary data is not permitted,although     hyperlinks to binary data are."/>
  <fhirVersion value="1.4.0"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <snapshot>
    <element>
      <path value="OpaqueData"/>
      <short value="OpaqueData"/>
      <definition value="Opaque data is the equivalent of an ASN.1 External Type ISO/IEC 8824-1:2008 Information
       technology -- Abstract Syntax Notation One (ASN.1): Specification of basic notion. Clause
       37 - Notation for the       external type or the XML Schema anyType. An OpaqueData instance
       may represent text with an optional spoken or written language code or a     formal structure
       such as embedded HTML, XML or MIME encoded data. When a formal structure is included,
       its type should be specified in the format attribute and, when the type is an XML variant,
       the corresponding     schema (or DTD) should be included in the schema parameter.The OpaqueData
       data type must be encoded in such a way that the content can be represented by a character
       string. Binary data is not permitted,although     hyperlinks to binary data are."/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="OpaqueData.value"/>
      <name value="value"/>
      <short value="the instance value"/>
      <definition value="the instance value. Note that instance value should be encoded in such a way that it allows
       embedded structures. As an example, in XML Schema, this encoding should be to xs:anyType
       or an       equivalent."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="tsAnyType"/>
      </type>
    </element>
    <element>
      <path value="OpaqueData.format"/>
      <name value="format"/>
      <short value="the format or encoding for value"/>
      <definition value="the format or encoding for value. This is typically recorded as the URI of a Mime Type."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="FormatReference"/>
      </type>
    </element>
    <element>
      <path value="OpaqueData.language"/>
      <name value="language"/>
      <short value="a reference to the written or spoken language used in value"/>
      <definition value="a reference to the written or spoken language used in value."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="LanguageReference"/>
      </type>
    </element>
    <element>
      <path value="OpaqueData.schema"/>
      <name value="schema"/>
      <short value="if the format of the document involves an XML encoding, this contains the URI of a document
       that carries the corresponding XML Schema or DTD"/>
      <definition value="if the format of the document involves an XML encoding, this contains the URI of a document
       that carries the corresponding XML Schema or DTD."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="DocumentURI"/>
      </type>
    </element>
  </snapshot>
</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.