This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). 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
StructureDefinition for Attachment
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Attachment"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <table border="0" cellpadding="0" cellspacing="0" style="border: 0px; 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; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="The logical name of the element">Name</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="Information about the use of the element">Flags</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" 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="formats.html#table" title="Reference to the type of the element">Type</a> </th> <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="formats.html#table" title="Additional information about the element">Description & Constraints</a> <span style="float: right"> <a href="formats.html#table" title="Legend for this format"> <img alt="doco" src="help16.png" style="background-color: inherit"/> </a> </span> </th> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAMQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw /npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///////yH5BAEAAB8ALAAAAAAQABAAAAV24CeOZG mepqeqqOgxjBZFa+19r4ftWQUAgqDgltthMshMIJAZ4jYDHsBARSAmFOJvq+g6HIdEFgcYmBWNxoNAsDjGHgBnmV5bCoUDHLBIq9s FEhIdcAYJdYASFRUQhQkLCwkOFwcdEBAXhVabE52ecDahKy0oIQA7" style="background-color: white; background-color: inherit" title="Element"/> <a href="datatypes-definitions.html#Attachment" title="Attachment : For referring to data content defined in other formats.">Attachment</a> <a name="Attachment"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ </span> <span title="This element has or is affected by some invariants">I</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"/> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="element.html">Element</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Content in a format defined elsewhere <br/> <span style="font-style: italic" title="att-1">It the Attachment has data, it SHALL have a contentType</span> </td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.contentType" title="Attachment.contentType : Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.">contentType</a> <a name="Attachment.contentType"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; 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: white; padding:0px 4px 0px 4px">Mime type of the content, with charset etc. <br/> <a href="http://www.rfc-editor.org/bcp/bcp13.txt" title="The mime type of an attachment. Any valid mime type is allowed.">MimeType</a> ( <a href="terminologies.html#required" title="To be conformant, instances of this element SHALL include a code from the specified value set.">Required</a>) </td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.language" title="Attachment.language : The human language of the content. The value can be any valid value according to BCP 47.">language</a> <a name="Attachment.language"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; 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: white; padding:0px 4px 0px 4px">Human language of the content (BCP-47) <br/> <a href="http://tools.ietf.org/html/bcp47" title="A human language.">Language</a> ( <a href="terminologies.html#required" title="To be conformant, instances of this element SHALL include a code from the specified value set.">Required</a>) </td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.data" title="Attachment.data : The actual data of the attachment - a sequence of bytes. In XML, represented using base64.">data</a> <a name="Attachment.data"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; 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: white; padding:0px 4px 0px 4px">Data inline, base64ed</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.url" title="Attachment.url : An alternative location where the data can be accessed.">url</a> <a name="Attachment.url"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#uri">uri</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Uri where the data can be found</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.size" title="Attachment.size : The number of bytes of data that make up this attachment.">size</a> <a name="Attachment.size"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#unsignedInt">unsignedInt</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Number of bytes of content (if url provided)</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.hash" title="Attachment.hash : The calculated hash of the data using SHA-1. Represented using base64.">hash</a> <a name="Attachment.hash"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; 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: white; padding:0px 4px 0px 4px">Hash of the data (sha-1, base64ed)</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5 CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav 7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.title" title="Attachment.title : A label or set of text to display in place of the data.">title</a> <a name="Attachment.title"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#string">string</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Label to display in place of the data</td> </tr> <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;"> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA YAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkRjgNAAAAAASUVORK5CYII=)"> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB 3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC" style="background-color: inherit"/> <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIW XMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3gYBFzI0BrFQCwAAAERJREFUOMtj/P//PwMlgImBQjDwBrCcOnWKokBgYWBgYDCU+06W5i 8MUggvnH/EOVJjAW4AuQHJ+O75LYqikXE0LzAAALePEntTkEoSAAAAAElFTkSuQmCC" style="background-color: white; background-color: inherit" title="Primitive Data Type"/> <a href="datatypes-definitions.html#Attachment.creation" title="Attachment.creation : The date that the attachment was first created.">creation</a> <a name="Attachment.creation"> </a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <span title="This element is included in summaries">Σ</span> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"> <a href="datatypes.html#dateTime">dateTime</a> </td> <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Date attachment was first created</td> </tr> <tr> <td class="hierarchy" colspan="5"> <br/> <a href="formats.html#table" title="Legend for this format"> <img alt="doco" src="help16.png" style="background-color: inherit"/> Documentation for this format </a> </td> </tr> </table> </div> </text> <url value="http://hl7.org/fhir/StructureDefinition/Attachment"/> <name value="Attachment"/> <status value="draft"/> <publisher value="HL7 FHIR Standard"/> <contact> <telecom> <system value="other"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <date value="2015-12-11T17:38:40+11:00"/> <description value="Base StructureDefinition for Attachment Type"/> <requirements value="Many models need to include data defined in other specifications that is complex and opaque to the healthcare model. This includes documents, media recordings, structured data, etc."/> <fhirVersion value="1.2.0"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <kind value="datatype"/> <abstract value="false"/> <base value="http://hl7.org/fhir/StructureDefinition/Element"/> <snapshot> <element> <path value="Attachment"/> <short value="Content in a format defined elsewhere"/> <definition value="For referring to data content defined in other formats."/> <comments value="When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment"."/> <min value="0"/> <max value="*"/> <type> <code value="Element"/> </type> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="data.empty() or contentType"/> </extension> <key value="att-1"/> <severity value="error"/> <human value="It the Attachment has data, it SHALL have a contentType"/> <xpath value="not(exists(f:data)) or exists(f:contentType)"/> </constraint> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ED/RP"/> </mapping> <mapping> <identity value="rim"/> <map value="ED"/> </mapping> </element> <element> <path value="Attachment.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Attachment.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Attachment.contentType"/> <short value="Mime type of the content, with charset etc."/> <definition value="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate."/> <requirements value="Processors of the data need to be able to know how to interpret the data."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <exampleCode value="text/plain; charset=UTF-8, image/png"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The mime type of an attachment. Any valid mime type is allowed."/> <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> <mapping> <identity value="v2"/> <map value="ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"/> </mapping> <mapping> <identity value="rim"/> <map value="./mediaType, ./charset"/> </mapping> </element> <element> <path value="Attachment.language"/> <short value="Human language of the content (BCP-47)"/> <definition value="The human language of the content. The value can be any valid value according to BCP 47."/> <requirements value="Users need to be able to choose between the languages in a set of attachments."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <exampleCode value="en-AU"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="rim"/> <map value="./language"/> </mapping> </element> <element> <path value="Attachment.data"/> <short value="Data inline, base64ed"/> <definition value="The actual data of the attachment - a sequence of bytes. In XML, represented using base64."/> <comments value="The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON."/> <requirements value="The data needs to able to be transmitted inline."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ED.5"/> </mapping> <mapping> <identity value="rim"/> <map value="./data"/> </mapping> </element> <element> <path value="Attachment.url"/> <short value="Uri where the data can be found"/> <definition value="An alternative location where the data can be accessed."/> <comments value="If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data."/> <requirements value="The data needs to be transmitted by reference."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <exampleUri value="http://www.acme.com/logo-small.png"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RP.1+RP.2 - if they refer to a URL (see v2.6)"/> </mapping> <mapping> <identity value="rim"/> <map value="./reference/literal"/> </mapping> </element> <element> <path value="Attachment.size"/> <short value="Number of bytes of content (if url provided)"/> <definition value="The number of bytes of data that make up this attachment."/> <comments value="The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference."/> <requirements value="Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </mapping> </element> <element> <path value="Attachment.hash"/> <short value="Hash of the data (sha-1, base64ed)"/> <definition value="The calculated hash of the data using SHA-1. Represented using base64."/> <requirements value="Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"/> </mapping> </element> <element> <path value="Attachment.title"/> <short value="Label to display in place of the data"/> <definition value="A label or set of text to display in place of the data."/> <requirements value="Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <exampleString value="Official Corporate Logo"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./title/data"/> </mapping> </element> <element> <path value="Attachment.creation"/> <short value="Date attachment was first created"/> <definition value="The date that the attachment was first created."/> <requirements value="This is often tracked as an integrity issue for use of the attachment."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </mapping> </element> </snapshot> <differential> <element> <path value="Attachment"/> <short value="Content in a format defined elsewhere"/> <definition value="For referring to data content defined in other formats."/> <comments value="When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment"."/> <min value="0"/> <max value="*"/> <type> <code value="Element"/> </type> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="data.empty() or contentType"/> </extension> <key value="att-1"/> <severity value="error"/> <human value="It the Attachment has data, it SHALL have a contentType"/> <xpath value="not(exists(f:data)) or exists(f:contentType)"/> </constraint> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ED/RP"/> </mapping> <mapping> <identity value="rim"/> <map value="ED"/> </mapping> </element> <element> <path value="Attachment.contentType"/> <short value="Mime type of the content, with charset etc."/> <definition value="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate."/> <requirements value="Processors of the data need to be able to know how to interpret the data."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <exampleCode value="text/plain; charset=UTF-8, image/png"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The mime type of an attachment. Any valid mime type is allowed."/> <valueSetUri value="http://www.rfc-editor.org/bcp/bcp13.txt"/> </binding> <mapping> <identity value="v2"/> <map value="ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"/> </mapping> <mapping> <identity value="rim"/> <map value="./mediaType, ./charset"/> </mapping> </element> <element> <path value="Attachment.language"/> <short value="Human language of the content (BCP-47)"/> <definition value="The human language of the content. The value can be any valid value according to BCP 47."/> <requirements value="Users need to be able to choose between the languages in a set of attachments."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <exampleCode value="en-AU"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="rim"/> <map value="./language"/> </mapping> </element> <element> <path value="Attachment.data"/> <short value="Data inline, base64ed"/> <definition value="The actual data of the attachment - a sequence of bytes. In XML, represented using base64."/> <comments value="The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON."/> <requirements value="The data needs to able to be transmitted inline."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ED.5"/> </mapping> <mapping> <identity value="rim"/> <map value="./data"/> </mapping> </element> <element> <path value="Attachment.url"/> <short value="Uri where the data can be found"/> <definition value="An alternative location where the data can be accessed."/> <comments value="If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data."/> <requirements value="The data needs to be transmitted by reference."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <exampleUri value="http://www.acme.com/logo-small.png"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="RP.1+RP.2 - if they refer to a URL (see v2.6)"/> </mapping> <mapping> <identity value="rim"/> <map value="./reference/literal"/> </mapping> </element> <element> <path value="Attachment.size"/> <short value="Number of bytes of content (if url provided)"/> <definition value="The number of bytes of data that make up this attachment."/> <comments value="The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference."/> <requirements value="Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </mapping> </element> <element> <path value="Attachment.hash"/> <short value="Hash of the data (sha-1, base64ed)"/> <definition value="The calculated hash of the data using SHA-1. Represented using base64."/> <requirements value="Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"/> </mapping> </element> <element> <path value="Attachment.title"/> <short value="Label to display in place of the data"/> <definition value="A label or set of text to display in place of the data."/> <requirements value="Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <exampleString value="Official Corporate Logo"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="./title/data"/> </mapping> </element> <element> <path value="Attachment.creation"/> <short value="Date attachment was first created"/> <definition value="The date that the attachment was first created."/> <requirements value="This is often tracked as an integrity issue for use of the attachment."/> <min value="0"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A (needs data type R3 proposal)"/> </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.