Non-patient File Sharing (NPFS)
2.2.1-current - ci-build

Non-patient File Sharing (NPFS), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 2.2.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.NPFS/ and changes regularly. See the Directory of published versions

## : File Manager (server) - XML Representation

Active as of 2022-10-27

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="IHE.NPFS.FileManager"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement IHE.NPFS.FileManager</b></p><a name="IHE.NPFS.FileManager"> </a><a name="hcIHE.NPFS.FileManager"> </a><a name="IHE.NPFS.FileManager-en-US"> </a><h2 id="title">File Manager (server)</h2><ul><li>Implementation Guide Version: 2.2.1-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-10-27 </li><li>Published by: IHE IT Infrastructure Technical Committee </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>CapabilityStatement for File Manager</p>
    </div><div class="lead"><em>Security</em></div><blockquote><div><p>Recommend <a href="https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html">ATNA</a>, encouraged <a href="https://profiles.ihe.net/ITI/IUA/index.html">IHE-IUA</a> or <a href="http://www.hl7.org/fhir/smart-app-launch/">SMART-app-launch</a></p>
    </div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction described as follows:<div><p>https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.FileSource</p>
    </div></li><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#DocumentReference1-1">DocumentReference</a></td><td><a href="StructureDefinition-IHE.NPFS.DocumentReference.html">https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>_id, identifier, patient:exists, date, author.identifier, format, language, location, status, relatesto, relation, relationship</td><td/><td/><td/></tr><tr><td><a href="#Binary1-2">Binary</a></td><td> </td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="DocumentReference1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>DocumentReference</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-IHE.NPFS.DocumentReference.html">NPFS DocumentReference</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>update</code>, <code>create</code>.</li></ul></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>Logical id of this artifact</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>Logical identifier of this artifact</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>patient:exists</td><td><code>token</code></td><td><div><p>This parameter shall always be used in this transaction to find resources that do not have the patient element valued</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>when the file, to which the DocumentReference refers, was submitted</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>author.identifier</td><td><code>token</code></td><td><div><p>The author that has submitted the file</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>format</td><td><code>token</code></td><td><div><p>File's format</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>language</td><td><code>token</code></td><td><div><p>The language of the file</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>uri</code></td><td><div><p>Where the file can be found</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The status of the file</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>relatesto</td><td><code>reference</code></td><td><div><p>One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>relation</td><td><code>token</code></td><td><div><p>The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>relationship</td><td><code>composite</code></td><td><div><p>The combination of the relatesTo and relation search parameter.</p>
    </div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Binary1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Binary</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><p/></div></div></div></div>
      </text>
      <url
           value="https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileManager"/>
      <version value="2.2.1-current"/>
      <name value="IHE_NPFS_FileManager"/>
      <title value="File Manager (server)"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2022-10-27"/>
      <publisher value="IHE IT Infrastructure Technical Committee"/>
      <contact>
        <telecom>
          <system value="url"/>
          <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
        </telecom>
      </contact>
      <contact>
        <telecom>
          <system value="email"/>
          <value value="iti@ihe.net"/>
        </telecom>
      </contact>
      <contact>
        <name value="IHE IT Infrastructure Technical Committee"/>
        <telecom>
          <system value="email"/>
          <value value="iti@ihe.net"/>
        </telecom>
      </contact>
      <description
                   value="IHE ITI Non-patient File Sharing (NPFS) - File Manager (server)"/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
        </coding>
      </jurisdiction>
      <kind value="requirements"/>
      <fhirVersion value="4.0.1"/>
      <format value="application/fhir+xml"/>
      <format value="application/fhir+json"/>
      <rest>
        <mode value="server"/>
        <documentation value="CapabilityStatement for File Manager"/>
        <security>
          <description
                       value="Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"/>
        </security>
        <resource>
          <type value="DocumentReference"/>
          <profile
                   value="https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference"/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <code value="update"/>
          </interaction>
          <interaction>
            <code value="create"/>
          </interaction>
          <searchParam>
            <name value="_id"/>
            <type value="token"/>
            <documentation value="Logical id of this artifact"/>
          </searchParam>
          <searchParam>
            <name value="identifier"/>
            <type value="token"/>
            <documentation value="Logical identifier of this artifact"/>
          </searchParam>
          <searchParam>
            <name value="patient:exists"/>
            <type value="token"/>
            <documentation
                           value="This parameter shall always be used in this transaction to find resources that do not have the patient element valued"/>
          </searchParam>
          <searchParam>
            <name value="date"/>
            <type value="date"/>
            <documentation
                           value="when the file, to which the DocumentReference refers, was submitted"/>
          </searchParam>
          <searchParam>
            <name value="author.identifier"/>
            <type value="token"/>
            <documentation value="The author that has submitted the file"/>
          </searchParam>
          <searchParam>
            <name value="format"/>
            <type value="token"/>
            <documentation value="File's format"/>
          </searchParam>
          <searchParam>
            <name value="language"/>
            <type value="token"/>
            <documentation value="The language of the file"/>
          </searchParam>
          <searchParam>
            <name value="location"/>
            <type value="uri"/>
            <documentation value="Where the file can be found"/>
          </searchParam>
          <searchParam>
            <name value="status"/>
            <type value="token"/>
            <documentation value="The status of the file"/>
          </searchParam>
          <searchParam>
            <name value="relatesto"/>
            <type value="reference"/>
            <documentation
                           value="One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource"/>
          </searchParam>
          <searchParam>
            <name value="relation"/>
            <type value="token"/>
            <documentation
                           value="The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter"/>
          </searchParam>
          <searchParam>
            <name value="relationship"/>
            <type value="composite"/>
            <documentation
                           value="The combination of the relatesTo and relation search parameter."/>
          </searchParam>
        </resource>
        <resource>
          <type value="Binary"/>
          <interaction>
            <code value="read"/>
          </interaction>
        </resource>
        <interaction>
          <code value="transaction"/>
          <documentation
                         value="https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.FileSource"/>
        </interaction>
        <interaction>
          <code value="search-system"/>
        </interaction>
      </rest>
    </CapabilityStatement>