Binary.profile.xml

StructureDefinition for binary

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Binary"/>
  <meta>
    <lastUpdated value="2015-04-03T14:24:32.000+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Binary"/>
  <name value="Binary"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Binary Resource"/>
  <status value="draft"/>
  <date value="2015-04-03T14:24:32+11:00"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="Binary"/>
      <short value="Pure binary content defined by sime other format than FHIR"/>
      <definition value="A binary resource can contain any content, whether text, image, pdf, zip archive, etc."/>
      <comments value="Typically, Binary resources are used for handling content such as:  * CDA Documents (i.e.
       with XDS) * PDF Documents * Images (the Media resource is preferred for handling images,
       but not possible when the content is already binary - e.g. XDS)."/>
      <requirements value="There are situations where it is useful or required to handle pure binary content using
       the same framework as other resources."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Binary.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="Binary.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="Binary.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="Asserting this rule set restricts the content to be only understood by a limited set of
       trading partners. This inherently limits the usefulness of the data in the long term.
       However the existing health eco-system is highly fractured, and not yet ready to define,
       collect, and exchange data in a generally computable sense. Wherever possible, implementers
       and/or specification writers should avoid using this element as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="Binary.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="Language is provided to support indexing and accessibility (typically, services such as
       text to speech use the language tag). The html language tag in the narrative applies 
       to the narrative. The language tag on the resource may be used to specify the language
       of other presentations generated from the data in the resource  Not all the content has
       to be in the base language. The Resource.language should not be assumed to apply to the
       narrative automatically. If a language is specified, it should it also be specified on
       the div element in the html (see rules in HTML5 for information about the relationship
       between xml:lang and the html lang attribute)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="Binary.contentType"/>
      <short value="MimeType of the binary content"/>
      <definition value="MimeType of the binary content represented as a standard MimeType (BCP 13)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="MimeType"/>
        <strength value="required"/>
        <description value="The mime type of an attachment"/>
        <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/>
      </binding>
    </element>
    <element>
      <path value="Binary.content"/>
      <short value="The actual content"/>
      <definition value="The actual content, base64 encoded."/>
      <comments value="If the content type is itself base64 encoding, then this will be base64 encoded twice
       - what is created by un-base64ing the content must be the specified content type."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Binary"/>
      <short value="Pure binary content defined by sime other format than FHIR"/>
      <definition value="A binary resource can contain any content, whether text, image, pdf, zip archive, etc."/>
      <comments value="Typically, Binary resources are used for handling content such as:  * CDA Documents (i.e.
       with XDS) * PDF Documents * Images (the Media resource is preferred for handling images,
       but not possible when the content is already binary - e.g. XDS)."/>
      <requirements value="There are situations where it is useful or required to handle pure binary content using
       the same framework as other resources."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Binary.contentType"/>
      <short value="MimeType of the binary content"/>
      <definition value="MimeType of the binary content represented as a standard MimeType (BCP 13)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="MimeType"/>
        <strength value="required"/>
        <description value="The mime type of an attachment"/>
        <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/>
      </binding>
    </element>
    <element>
      <path value="Binary.content"/>
      <short value="The actual content"/>
      <definition value="The actual content, base64 encoded."/>
      <comments value="If the content type is itself base64 encoding, then this will be base64 encoded twice
       - what is created by un-base64ing the content must be the specified content type."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="base64Binary"/>
      </type>
    </element>
  </differential>
</StructureDefinition>