3.24.9 StructureDefinition: Shared Health Attachment - XML Profile
XML representation of the dtprofile-attachment Profile.
Narrative view of the profile
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="dtprofile-attachment"/>
<text>
<status value="extensions"/>
<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 style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td 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(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-attachment-definitions.html#Attachment">Attachment</a><a name="Attachment"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/2016may/datatypes.html#Attachment">Attachment</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Content in a format defined elsewhere</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td 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(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-attachment-definitions.html#Attachment.contentType">contentType</a><a name="Attachment.contentType"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Mime type of the content, with charset etc.</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td 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(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-attachment-definitions.html#Attachment.url">url</a><a name="Attachment.url"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Uri where the data can be found</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td 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(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-attachment-definitions.html#Attachment.size">size</a><a name="Attachment.size"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#unsignedInt">unsignedInt</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Number of bytes of content (if url provided)</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td 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(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="dtprofile-attachment-definitions.html#Attachment.title">title</a><a name="Attachment.title"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/2016may/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Label to display in place of the data</span></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/2016may/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/2016may/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<url
value="http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-attachment"/>
<version value="5.0"/>
<name value="Shared Health Attachment"/>
<status value="draft"/>
<date value="2015-09-22T06:02:49-04:00"/>
<description value="Constraints on the Attachment data type"/>
<fhirVersion value="1.4.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"/>
<baseType value="Attachment"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Attachment"/>
<derivation value="constraint"/>
<snapshot>
<element id="Attachment">
<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="*"/>
<base>
<path value="Attachment"/>
<min value="0"/>
<max value="*"/>
</base>
<maxLength value="0"/>
<constraint>
<key value="att-1"/>
<severity value="error"/>
<human value="It the Attachment has data, it SHALL have a contentType"/>
<expression value="data.empty() or contentType.exists()"/>
<xpath value="not(exists(f:data)) or exists(f:contentType)"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="ED/RP"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="ED"/>
</mapping>
</element>
<element id="Attachment.id">
<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"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="id"/>
</type>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Attachment.extension">
<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="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Attachment.contentType">
<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."/>
<comments
value="Identifies the mime type the binary content is expressed in"/>
<requirements
value="Processors of the data need to be able to know how to interpret the data."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Attachment.contentType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<exampleCode value="text/plain; charset=UTF-8, image/png"/>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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 id="Attachment.language">
<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"/>
<base>
<path value="Attachment.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<exampleCode value="en-AU"/>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<strength value="required"/>
<description value="A human language."/>
<valueSetReference>
<reference value="http://tools.ietf.org/html/bcp47"/>
</valueSetReference>
</binding>
<mapping>
<identity value="rim"/>
<map value="./language"/>
</mapping>
</element>
<element id="Attachment.data">
<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"/>
<base>
<path value="Attachment.data"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="base64Binary"/>
</type>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="ED.5"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="./data"/>
</mapping>
</element>
<element id="Attachment.url">
<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="Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment"/>
<requirements value="The data needs to be transmitted by reference."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Attachment.url"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<exampleUri value="http://www.acme.com/logo-small.png"/>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<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 id="Attachment.size">
<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="Conformance Rule: The combined size of all attachments cannot exceed 50 MB."/>
<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="1"/>
<max value="1"/>
<base>
<path value="Attachment.size"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="unsignedInt"/>
</type>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A (needs data type R3 proposal)"/>
</mapping>
</element>
<element id="Attachment.hash">
<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"/>
<base>
<path value="Attachment.hash"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="base64Binary"/>
</type>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"/>
</mapping>
</element>
<element id="Attachment.title">
<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"/>
<base>
<path value="Attachment.title"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<exampleString value="Official Corporate Logo"/>
<maxLength value="0"/>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="./title/data"/>
</mapping>
</element>
<element id="Attachment.creation">
<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"/>
<base>
<path value="Attachment.creation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="dateTime"/>
</type>
<maxLength value="0"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A (needs data type R3 proposal)"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Attachment">
<path value="Attachment"/>
</element>
<element id="Attachment.contentType">
<path value="Attachment.contentType"/>
<comments
value="Identifies the mime type the binary content is expressed in"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Attachment.url">
<path value="Attachment.url"/>
<comments
value="Conformance Rule: This will be expressed as a URL on the server - https://EnvironmentSpecificHost/EnvironmentSpecificPathInbox/Binary/[guid]. The attachment content SHALL be PUT to the same URL either immediately before or after posting the message containing this attachment"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="Attachment.size">
<path value="Attachment.size"/>
<comments
value="Conformance Rule: The combined size of all attachments cannot exceed 50 MB."/>
<min value="1"/>
<max value="1"/>
<maxValueInteger value="52428800"/>
<mustSupport value="true"/>
</element>
<element id="Attachment.title">
<path value="Attachment.title"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>