NCPI FHIR Implementation Guide
0.2.0 - ci-build
NCPI FHIR Implementation Guide - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2022-12-09 |
XML representation of the ncpi-drs-attachment data type profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ncpi-drs-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://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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://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 style="width: 100px" class="hierarchy"><a href="http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" 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://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="http://hl7.org/fhir/R4/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_bck0.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="StructureDefinition-ncpi-drs-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"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4conformance-rules.html#constraints" title="This element has or is affected by constraints (must-be-drs-uri)">C</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">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/R4/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><br/><span style="font-weight:bold">must-be-drs-uri: </span>attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls.</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="http://hl7.org/fhir/R4/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<url
value="https://nih-ncpi.github.io/ncpi-fhir-ig/StructureDefinition/ncpi-drs-attachment"/>
<version value="0.2.0"/>
<name value="DRSAttachment"/>
<title value="DRS Attachment"/>
<status value="draft"/>
<date value="2022-12-09T17:30:30+00:00"/>
<publisher value="NCPI FHIR Working Group"/>
<contact>
<name value="NCPI FHIR Working Group"/>
<telecom>
<system value="url"/>
<value value="https://github.com/nih-ncpi"/>
</telecom>
</contact>
<contact>
<name value="Meen Chul Kim"/>
<telecom>
<system value="email"/>
<value value="meenchul@d3b.center"/>
<use value="work"/>
</telecom>
</contact>
<description value="A FHIR Attachment with a DRS url."/>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="complex-type"/>
<abstract value="false"/>
<type 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."/>
<comment
value="When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent"."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Attachment"/>
<min value="0"/>
<max value="*"/>
</base>
<condition value="ele-1"/>
<constraint>
<key value="att-1"/>
<severity value="error"/>
<human
value="If 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)"/>
<source value="http://hl7.org/fhir/StructureDefinition/Attachment"/>
</constraint>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="must-be-drs-uri"/>
<severity value="error"/>
<human
value="attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls."/>
<expression value="$this.url.matches('^drs://.*')"/>
<source
value="https://nih-ncpi.github.io/ncpi-fhir-ig/StructureDefinition/ncpi-drs-attachment"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
<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="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Attachment.extension">
<path value="Attachment.extension"/>
<slicing>
<discriminator>
<type value="value"/>
<path value="url"/>
</discriminator>
<description value="Extensions are always sliced by (at least) url"/>
<rules value="open"/>
</slicing>
<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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/>
<comment
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>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<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."/>
<requirements
value="Processors of the data need to be able to know how to interpret the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Attachment.contentType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<example>
<label value="General"/>
<valueCode value="text/plain; charset=UTF-8, image/png"/>
</example>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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|4.0.1"/>
</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>
<example>
<label value="General"/>
<valueCode value="en-AU"/>
</example>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<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="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</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, base64 encoded."/>
<comment
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>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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="A location where the data can be accessed."/>
<comment
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"/>
<base>
<path value="Attachment.url"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
<example>
<label value="General"/>
<valueUrl value="http://www.acme.com/logo-small.png"/>
</example>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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 (before base64 encoding, if that is done)."/>
<comment
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"/>
<base>
<path value="Attachment.size"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="unsignedInt"/>
</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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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."/>
<comment
value="The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature."/>
<requirements
value="Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Attachment.hash"/>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map
value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"/>
</mapping>
</element>
<element id="Attachment.title">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<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>
<example>
<label value="General"/>
<valueString value="Official Corporate Logo"/>
</example>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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>
<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() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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"/>
<constraint>
<key value="must-be-drs-uri"/>
<severity value="error"/>
<human
value="attachment.url must start with ^drs://. A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls."/>
<expression value="$this.url.matches('^drs://.*')"/>
<source
value="https://nih-ncpi.github.io/ncpi-fhir-ig/StructureDefinition/ncpi-drs-attachment"/>
</constraint>
</element>
</differential>
</StructureDefinition>
IG © 2021+ NCPI FHIR Working Group. Package NCPI-FHIR-Implementation-Guide#0.2.0 based on FHIR 4.0.1. Generated 2022-12-09
Links: Table of Contents |
QA Report