Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Binary.profile.xml

Example StructureDefinition/Binary (XML)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any No defined compartments

Raw XML ( canonical form + also see XML Format Specification )

Jump past Narrative

StructureDefinition for binary

<?xml version="1.0" encoding="UTF-8"?>


  
  
    
  
  
    
    
      
        
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
            
              
                
              
            
          
        
        
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
          goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
          sPVYVAgIJrA/sAAAAASUVORK5CYII=)
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAACC
            ElEQVQ4y4XTv2sUQRTA8e9Mzt3kjoOLSXFgZ6GJQlALCysLC89OsLTXv0VFxE4stRAEQUghSWEXuM4qMZpATsUD70dyMdnduZ15z2
            IvMV5IfDDNm5nPm59GVTkpms1mTVXvhxDuichlEZn03m+KyJL3/mWj0fiKqp7YVlZWXrfbbR2PTqeji4uLn1WVEqdECKFRr9eP5Wd
            nZ/HeXwROB0TEA3S7XarVKiLC1tYW8/PzeO/5LxBCUABrLXEc02q1KJfLB30F0P144dPU9LVL1kwcrU06WP0ewhML4JwDYDgcHo7I
            87wAjNq5ypU3Z8arT8F5u/xejw52zmGM+Rcg1wyIcc/BTYCdBlODyh3ElA1AHMekaUoURURRBECWZSNgaGzBxxAU9jfQ9jrJr2dcb
            bXobRYHlQAzo9X1gDR9+KUArE6CwLefZD9WCW6P0uRZKreXqADkHXZ3dshzjwRholJH397AOXcTwHTfzQ1n7q6NnYEAy+DWQVNwKW
            QJ6vcx557Se7HAzIN1M9rCwVteA/rAYDRRICQgSZEr7WLYO3bzJVJGQBu0D74PkoHkoBnIHvjfkO9AGABmDHCjFWgH8i7kPQh9yEe
            YH4DfLhBJgA2A7BBQJ9uwXWY3rhJqFo1AaiB1CBngwKZQcqAeSFSduL9Akj7qPF64jnALS5VTPwdgPwwJ+uog9Qcx4kRZiPKqxgAA
            AABJRU5ErkJggg== 
            Binary : A resource that represents the data of a single raw artifact as digital content
             accessible in its native format.  A Binary resource can contain any content, whether text,
             image, pdf, zip archive, etc.
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold; color:
             black; background-color: #e6ffe6
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4pxPure binary content defined by a format other than FHIR
            Elements defined in Ancestors: 
            The logical id of the resource, as used in the URL for the resource. Once assigned, this
             value never changes., 

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Binary"/> 
  <meta> 
    <lastUpdated value="2023-03-26T15:21:02.749+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
       top;">
        <tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:

         top">
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a>           </th>           <th class="hierarchy" style="width: 100px">            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a>           </th>           <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a>             <span style="float: right">              <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">                <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/>               </a>             </span>           </th>         </tr>         <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:

         white">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas
          e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M
          MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Resource"/>              <span title="Binary : A resource that represents the data of a single raw artifact as digital

             content accessible in its native format.  A Binary resource can contain any content,
             whether text, image, pdf, zip archive, etc.">Binary</span> 
            <a name="Binary"> </a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold;

             color: black; background-color: #e6ffe6" title="Standards Status = Normative">N</a> 
          </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px"/> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="resource.html">Resource</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">Pure binary content defined by a format other than FHIR
            <br/>              <br/>  Elements defined in Ancestors:             <a href="resource.html#Resource" title="The logical id of the resource, as used in the URL for the resource. Once assigned,

             this value never changes.">id</a> , 

            <a href="resource.html#Resource" title="The metadata about the resource. This is content that is maintained by the infrastructure.
             Changes to the content might not always be associated with version changes to the resource., 
            A reference to a set of rules that were followed when the resource was constructed, and
             which must be understood when processing the content. Often, this is a reference to an
             implementation guide that defines the special rules along with other profiles etc., 
            
          
        

        
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
          BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6
          EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5CYII=)
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
            7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
            klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
            TRgwAAAABJRU5ErkJggg== 

             Changes to the content might not always be associated with version changes to the
             resource.">meta</a> , 
            <a href="resource.html#Resource" title="A reference to a set of rules that were followed when the resource was constructed,

             and which must be understood when processing the content. Often, this is a reference
             to an implementation guide that defines the special rules along with other profiles
             etc.">implicitRules</a> , 
            <a href="resource.html#Resource" title="The base language in which the resource is written.">language</a>           </td>         </tr>         <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:

         #F7F7F7">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
           url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAw
          EwfT6/ddA0GBAxO3NrLlKUj9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/>  
            <span title="Binary.contentType : MimeType of the binary content represented as a standard MimeType
             (BCP 13).
            
          
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4pxMimeType of the binary content
            
             (
            )
          
        

        
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KG
          goAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgC
          sPVYVAgIJrA/sAAAAASUVORK5CYII=)
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
            7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxj
            wv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAadEVYdFNvZnR3YXJlAFBhaW50Lk5FVCB2My41LjEwMPRyoQAAAFxJREFUOE/NjE
            EOACEIA/0o/38GGw+agoXYeNnDJDCUDnd/gkoFKhWozJiZI3gLwY6rAgxhsPKTPUzycTl8lAryMyMsVQG6TFi6cHULyz8KOjC7OIQ
            KlQpU3uPjAwhX2CCcGsgOAAAAAElFTkSuQmCC 
            Binary.securityContext : This element identifies another resource that can be used as
             a proxy of the security sensitivity to use when deciding and enforcing access control
             rules for the Binary resource. Given that the Binary resource contains very few elements
             that can be used to determine the sensitivity of the data and relationships to individuals,
             the referenced resource stands in as a proxy equivalent for this purpose. This referenced
             resource may be related to the Binary (e.g. Media, DocumentReference), or may be some
             non-related Resource purely as a security proxy. E.g. to identify that the binary resource
             relates to a patient, and access should only be granted to applications that have access
             to the patient.
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
            (
            )
          
          vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid;
           padding:0px 4px 0px 4px
        

        
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iV
          BORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkR
          jgNAAAAAASUVORK5CYII=)
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
            L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC
            data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAR
            klEQVQ4y2P8//8/AyWAhYFCMAgMuHjx4n+KXaCv+I0szW8WpCG8kFO1lGFKW/SIjAUYgxz/MzAwMDC+nqhDUTQyjuYFBgCNmhP4Ov
            TRgwAAAABJRU5ErkJggg== 
            
            
          
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
            
          
          vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px
        

        
          
            
            
               Documentation for this format
            
          
        
      
    
  
  
    
  
  
    
  
  
    
  
  
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
    
      
      
    
  
  
    
      
      
    
  
  A resource that represents the data of a single raw artifact as digital content accessible
   in its native format.  A Binary resource can contain any content, whether text, image,
   pdf, zip archive, etc.
  There are situations where it is useful or required to handle pure binary content using
   the same framework as other resources.
  
  
    
    
    
  
  
  
  
  
  
  
    
      
      
      A resource that represents the data of a single raw artifact as digital content accessible
       in its native format.  A Binary resource can contain any content, whether text, image,
       pdf, zip archive, etc.
      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).
      
      
      
        
        
        
      
      
      
      
        
        
      
      
        
        
      
    
    
      
      
      The logical id of the resource, as used in the URL for the resource. Once assigned, this
       value never changes.
      The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation.
      
      
      
        
        
        
      
    <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
       (j)  -->
      
        
          
        
        
      
      
      
    
    
      
      

             (BCP 13).">contentType</span> 
            <a name="Binary.contentType"> </a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">
            <a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element is included in summaries">Σ</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">1..1</td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">
            <a href="datatypes.html#code">code</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">MimeType of the binary content
            <br/>  Binding:             <a href="valueset-mimetypes.html">Mime Types</a>  (            <a href="terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value

             set.">Required</a> )
            <br/>            </td>         </tr>         <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:

         white">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas
          e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAALUlEQVR4Xu3IoREAIAwEwfT6/ddA0GBAxO3NrLlKUj
          9263wAAAAvrgEAADClAVWFQIBRHMicAAAAAElFTkSuQmCC)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Reference to another Resource"/>              <span title="Binary.securityContext : This element identifies another resource that can be used

             as a proxy of the security sensitivity to use when deciding and enforcing access
             control rules for the Binary resource. Given that the Binary resource contains
             very few elements that can be used to determine the sensitivity of the data and
             relationships to individuals, the referenced resource stands in as a proxy equivalent
             for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReferen
            ce), or may be some non-related Resource purely as a security proxy. E.g. to identify
             that the binary resource relates to a patient, and access should only be granted
             to applications that have access to the patient.">securityContext</span> 
            <a name="Binary.securityContext"> </a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="elementdefinition-definitions.html#ElementDefinition.isSummary" style="padding-left: 3px; padding-right: 3px; color: black; null" title="This element is included in summaries">Σ</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">0..1</td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">
            <a href="references.html#Reference">Reference</a> (            <a href="resourcelist.html">Any</a> )          </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0

           solid; padding:0px 4px 0px 4px">Identifies another resource to use as proxy when enforcing access control
            <br/>            </td>         </tr>         <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:

         #F7F7F7">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image:
           url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAg
          DsHd9/w4EQIOamFnaBgAA4MMKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/>             <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type"/>              <span title="Binary.data : The actual content, base64 encoded.">data</span>             <a name="Binary.data"> </a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px"/> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">0..1</td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">
            <a href="datatypes.html#base64Binary">base64Binary</a>           </td>           <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px

           #F0F0F0 solid; padding:0px 4px 0px 4px">The actual content
            <br/>            </td>         </tr>         <tr>           <td class="hierarchy" colspan="5">            <br/>              <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">              <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/>  Documentation for this format            </a>           </td>         </tr>       </table>     </div>   </text>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category">    <valueString value="Foundation.Other"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">    <valueCode value="normative"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">    <valueCode value="4.0.0"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">    <valueInteger value="5"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category">    <valueCode value="not-classified"/>   </extension>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">    <valueCode value="fhir"/>   </extension>   <url value="http://hl7.org/fhir/StructureDefinition/Binary"/>   <version value="5.0.0"/>   <name value="Binary"/>   <status value="active"/>   <experimental value="false"/>   <date value="2023-03-26T15:21:02+11:00"/>   <publisher value="Health Level Seven International (FHIR Infrastructure)"/>   <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/fiwg/index.cfm"/>     </telecom>   </contact>   <description value="A resource that represents the data of a single raw artifact as digital content

   accessible in its native format.  A Binary resource can contain any content, whether
   text, image, pdf, zip archive, etc."/> 
  <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <purpose value="There are situations where it is useful or required to handle pure binary content

   using the same framework as other resources."/> 
  <fhirVersion value="5.0.0"/>   <mapping>     <identity value="w5"/>     <uri value="http://hl7.org/fhir/fivews"/>     <name value="FiveWs Pattern Mapping"/>   </mapping>   <mapping>     <identity value="rim"/>     <uri value="http://hl7.org/v3"/>     <name value="RIM Mapping"/>   </mapping>   <kind value="resource"/>   <abstract value="false"/>   <type value="Binary"/>   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Resource"/>   <derivation value="specialization"/>   <snapshot>     <element id="Binary">      <path value="Binary"/>       <short value="Pure binary content defined by a format other than FHIR"/>       <definition value="A resource that represents the data of a single raw artifact as digital content

       accessible in its native format.  A Binary resource can contain any content, whether
       text, image, pdf, zip archive, etc."/> 
      <comment value="Typically, Binary resources are used for handling content such as:  
* CDA Documents (i.e. with XDS) 
* PDF Documents 
* Images."/> 
      <min value="0"/>       <max value="*"/>       <base>         <path value="Binary"/>         <min value="0"/>         <max value="*"/>       </base>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="false"/>       <mapping>         <identity value="rim"/>         <map value="Entity. Role, or Act,ED"/>       </mapping>       <mapping>         <identity value="w5"/>         <map value="infrastructure.structure"/>       </mapping>     </element>     <element id="Binary.id">      <path value="Binary.id"/>       <short value="Logical id of this artifact"/>       <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned,

       this value never changes."/> 
      <comment value="Within the context of the FHIR RESTful interactions, the resource has an id except

       for cases like the create and conditional update. Otherwise, the use of the resouce
       id depends on the given use case."/> 
      <min value="0"/>       <max value="1"/>       <base>         <path value="Resource.id"/>         <min value="0"/>         <max value="1"/>       </base>       <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler

       magic (j)  -->
      <type>         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">          <valueUrl value="id"/>         </extension>         <code value="http://hl7.org/fhirpath/System.String"/>       </type>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>     </element>     <element id="Binary.meta">      <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 might not always be associated with version changes to the resource.
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
      
    
    
      
      
      A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content. Often, this is a reference to an
       implementation guide that defines the special rules along with other profiles etc.
      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. Often, when used, the URL
       is a reference to an implementation guide that defines these special rules as part of
       it's narrative along with other profiles, value sets, etc.
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      

       Changes to the content might not always be associated with version changes to the
       resource."/> 
      <min value="0"/>       <max value="1"/>       <base>         <path value="Resource.meta"/>         <min value="0"/>         <max value="1"/>       </base>       <type>         <code value="Meta"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>     </element>     <element id="Binary.implicitRules">      <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. Often, this is a reference
       to an implementation guide that defines the special rules along with other profiles
       etc."/> 
      <comment 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. Often, when used, the URL is a reference to an implementation guide
       that defines these special rules as part of its narrative along with other profiles,
       value sets, etc."/> 
      <min value="0"/>       <max value="1"/>       <base>         <path value="Resource.implicitRules"/>         <min value="0"/>         <max value="1"/>       </base>       <type>         <code value="uri"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="true"/> 
      <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional
       knowledge about the resource that modifies it's meaning or interpretation
      
    
    
      
      
      
      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).
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
      
      
        
          
        
        
          
        
        
          
        
        
        
        
      
    
    
      
      
      
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
      
      
        
          
        
        
          
        
        
        
        
      
      
        
        
      
    
    
      
      
      This element identifies another resource that can be used as a proxy of the security sensitivity
       to use when deciding and enforcing access control rules for the Binary resource. Given
       that the Binary resource contains very few elements that can be used to determine the
       sensitivity of the data and relationships to individuals, the referenced resource stands
       in as a proxy equivalent for this purpose. This referenced resource may be related to
       the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely
       as a security proxy. E.g. to identify that the binary resource relates to a patient, and
       access should only be granted to applications that have access to the patient.
      Very often, a server will also know of a resource that references the binary, and can
       automatically apply the appropriate access rules based on that reference. However, there
       are some circumstances where this is not appropriate, e.g. the binary is uploaded directly
       to the server without any linking resource, the binary is referred to from multiple different
       resources, and/or the binary is content such as an application logo that has less protection
       than any of the resources that reference it.
      
      
      
        
        
        
      
      
        
        
      
      
        
        
        
        
        
        
      
      
      
      
        
        
      
    
    
      
      
      
      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.
      
      
      
        
        
        
      
      
        
      
      
        
        
        
        
        
        
      
      
      
      
        
        
      
    
  
  
    
      
      
      A resource that represents the data of a single raw artifact as digital content accessible
       in its native format.  A Binary resource can contain any content, whether text, image,
       pdf, zip archive, etc.
      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).
      
      
      
        
        
      
    
    
      
      
      
      
      
      
        
      
      
      
        
          
        
        
          
        
        
        
        
      
      
        
        
      
    
    
      
      
      This element identifies another resource that can be used as a proxy of the security sensitivity
       to use when deciding and enforcing access control rules for the Binary resource. Given
       that the Binary resource contains very few elements that can be used to determine the
       sensitivity of the data and relationships to individuals, the referenced resource stands
       in as a proxy equivalent for this purpose. This referenced resource may be related to
       the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely
       as a security proxy. E.g. to identify that the binary resource relates to a patient, and
       access should only be granted to applications that have access to the patient.
      Very often, a server will also know of a resource that references the binary, and can
       automatically apply the appropriate access rules based on that reference. However, there
       are some circumstances where this is not appropriate, e.g. the binary is uploaded directly
       to the server without any linking resource, the binary is referred to from multiple different
       resources, and/or the binary is content such as an application logo that has less protection
       than any of the resources that reference it.
      
      
      
        
        
      
      
      
        
        
      
    
    
      
      
      
      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.
      
      
      
        
      
      
      
        
        
      
    
  

       knowledge about the resource that modifies its meaning or interpretation"/> 
      <isSummary value="true"/>     </element>     <element id="Binary.language">      <path value="Binary.language"/>       <short value="Language of the resource content"/>       <definition value="The base language in which the resource is written."/>       <comment 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"/>       <base>         <path value="Resource.language"/>         <min value="0"/>         <max value="1"/>       </base>       <type>         <code value="code"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="false"/>       <binding>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">          <valueString value="Language"/>         </extension>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">          <valueBoolean value="true"/>         </extension>         <strength value="required"/>         <description value="IETF language tag for a human language"/>         <valueSet value="http://hl7.org/fhir/ValueSet/all-languages|5.0.0"/>         <additional>           <purpose value="starter"/>           <valueSet value="http://hl7.org/fhir/ValueSet/languages"/>         </additional>       </binding>     </element>     <element id="Binary.contentType">      <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"/>       <base>         <path value="Binary.contentType"/>         <min value="1"/>         <max value="1"/>       </base>       <type>         <code value="code"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>       <binding>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">          <valueString value="MimeType"/>         </extension>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">          <valueBoolean value="true"/>         </extension>         <strength value="required"/>         <description value="The mime type of an attachment. Any valid mime type is allowed."/>         <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"/>       </binding>       <mapping>         <identity value="rim"/>         <map value="ED.mediaType"/>       </mapping>     </element>     <element id="Binary.securityContext">      <path value="Binary.securityContext"/>       <short value="Identifies another resource to use as proxy when enforcing access control"/>       <definition value="This element identifies another resource that can be used as a proxy of the security

       sensitivity to use when deciding and enforcing access control rules for the Binary
       resource. Given that the Binary resource contains very few elements that can be
       used to determine the sensitivity of the data and relationships to individuals,
       the referenced resource stands in as a proxy equivalent for this purpose. This
       referenced resource may be related to the Binary (e.g. DocumentReference), or may
       be some non-related Resource purely as a security proxy. E.g. to identify that
       the binary resource relates to a patient, and access should only be granted to
       applications that have access to the patient."/> 
      <comment value="Very often, a server will also know of a resource that references the binary, and

       can automatically apply the appropriate access rules based on that reference. However,
       there are some circumstances where this is not appropriate, e.g. the binary is
       uploaded directly to the server without any linking resource, the binary is referred
       to from multiple different resources, and/or the binary is content such as an application
       logo that has less protection than any of the resources that reference it."/> 
      <min value="0"/>       <max value="1"/>       <base>         <path value="Binary.securityContext"/>         <min value="0"/>         <max value="1"/>       </base>       <type>         <code value="Reference"/>         <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>     <element id="Binary.data">      <path value="Binary.data"/>       <short value="The actual content"/>       <definition value="The actual content, base64 encoded."/>       <comment 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="0"/>       <max value="1"/>       <base>         <path value="Binary.data"/>         <min value="0"/>         <max value="1"/>       </base>       <type>         <code value="base64Binary"/>       </type>       <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="false"/>       <mapping>         <identity value="rim"/>         <map value="ED.data"/>       </mapping>     </element>   </snapshot>   <differential>     <element id="Binary">      <path value="Binary"/>       <short value="Pure binary content defined by a format other than FHIR"/>       <definition value="A resource that represents the data of a single raw artifact as digital content

       accessible in its native format.  A Binary resource can contain any content, whether
       text, image, pdf, zip archive, etc."/> 
      <comment value="Typically, Binary resources are used for handling content such as:  
* CDA Documents (i.e. with XDS) 
* PDF Documents 
* Images."/> 
      <min value="0"/>       <max value="*"/>       <mustSupport value="false"/>       <isModifier value="false"/>       <mapping>         <identity value="w5"/>         <map value="infrastructure.structure"/>       </mapping>       <mapping>         <identity value="rim"/>         <map value="ED"/>       </mapping>     </element>     <element id="Binary.contentType">      <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>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>       <binding>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">          <valueString value="MimeType"/>         </extension>         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">          <valueBoolean value="true"/>         </extension>         <strength value="required"/>         <description value="The mime type of an attachment. Any valid mime type is allowed."/>         <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0"/>       </binding>       <mapping>         <identity value="rim"/>         <map value="ED.mediaType"/>       </mapping>     </element>     <element id="Binary.securityContext">      <path value="Binary.securityContext"/>       <short value="Identifies another resource to use as proxy when enforcing access control"/>       <definition value="This element identifies another resource that can be used as a proxy of the security

       sensitivity to use when deciding and enforcing access control rules for the Binary
       resource. Given that the Binary resource contains very few elements that can be
       used to determine the sensitivity of the data and relationships to individuals,
       the referenced resource stands in as a proxy equivalent for this purpose. This
       referenced resource may be related to the Binary (e.g. DocumentReference), or may
       be some non-related Resource purely as a security proxy. E.g. to identify that
       the binary resource relates to a patient, and access should only be granted to
       applications that have access to the patient."/> 
      <comment value="Very often, a server will also know of a resource that references the binary, and

       can automatically apply the appropriate access rules based on that reference. However,
       there are some circumstances where this is not appropriate, e.g. the binary is
       uploaded directly to the server without any linking resource, the binary is referred
       to from multiple different resources, and/or the binary is content such as an application
       logo that has less protection than any of the resources that reference it."/> 
      <min value="0"/>       <max value="1"/>       <type>         <code value="Reference"/>         <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/>       </type>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="true"/>       <mapping>         <identity value="rim"/>         <map value="n/a"/>       </mapping>     </element>     <element id="Binary.data">      <path value="Binary.data"/>       <short value="The actual content"/>       <definition value="The actual content, base64 encoded."/>       <comment 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="0"/>       <max value="1"/>       <type>         <code value="base64Binary"/>       </type>       <mustSupport value="false"/>       <isModifier value="false"/>       <isSummary value="false"/>       <mapping>         <identity value="rim"/>         <map value="ED.data"/>       </mapping>     </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.