Universal API Implementation Guide
1.1.20 - ci-build
Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2020-08-21 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="uapi-gne-fhir-server"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement uapi-gne-fhir-server</b></p><a name="uapi-gne-fhir-server"> </a><a name="hcuapi-gne-fhir-server"> </a><h2 id="title">UAPI CapabilityStatement - Genentech FHIR Server</h2><ul><li>Implementation Guide Version: 1.1.20 </li><li>FHIR Version: 4.3.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2020-08-21 00:00:00-0500 </li><li>Published by: null </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><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>https://fhir.developer.gene.com/ImplementationGuide/uapi</li></ul><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>UAPI Data Source <strong>SHALL</strong>:</p>
<ol>
<li>Support the Solicited - RESTful Data Source workflow defined in this guide, including all required searches and search parameters.</li>
<li>Implement the RESTful behavior according to the FHIR specification.</li>
<li>Support the JSON source format.</li>
<li>Declare a CapabilityStatement identifying the profiles supported.</li>
<li>Follow US Core search requirements and guidance when performing searches associated with this IG.</li>
</ol>
<p>UAPI Data Source <strong>SHOULD</strong>:</p>
<ol>
<li>Respond to the Patient/$match operation.</li>
<li>Support the recommended searches and parameters identified in the guide.</li>
<li>Support the XML source format.</li>
<li>Identify the UAPI profiles supported as part of the FHIR <code>meta.profile</code> attribute for each applicable instance.</li>
</ol>
<p>The UAPI Data Source MAY</p>
<ol>
<li>Support the Task / SMART application launch capability specified in the guide.</li>
</ol>
</div><div class="lead"><em>Security</em></div><blockquote><div><ol>
<li>UAPI Data Source <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>
<li>UAPI Data Source <strong>SHOULD</strong> authorize exchanges using OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Guide.</li>
<li>For general security considerations refer to <a href="https://www.hl7.org/fhir/secpriv-module.html">FHIR Security and Privacy Considerations</a>.</li>
<li>For additional security guidance, refer to the <a href="https://www.hl7.org/fhir/security.html">core FHIR Security guidance page</a>.</li>
</ol>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></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="#Questionnaire1-1">Questionnaire</a></td><td><a href="http://hl7.org/fhir/R4B/questionnaire.html">http://hl7.org/fhir/StructureDefinition/Questionnaire</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>name, version</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Questionnaire1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Questionnaire</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="http://hl7.org/fhir/R4B/questionnaire.html">Questionnaire</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/><code>resolves</code></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</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><a href="http://hl7.org/fhir/R4B/questionnaire.html#search">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4B/questionnaire.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
</text>
<url
value="https://fhir.developer.gene.com/CapabilityStatement/uapi-gne-fhir-server"/>
<version value="1.1.20"/>
<name value="UAPIgneFHIRserver"/>
<title value="UAPI CapabilityStatement - Genentech FHIR Server"/>
<status value="active"/>
<experimental value="false"/>
<date value="2020-08-21T00:00:00-05:00"/>
<contact>
<name value="Krzysztof Wilczek"/>
<telecom>
<system value="email"/>
<value value="mailto:wilczekk@gene.com"/>
</telecom>
</contact>
<description
value="This CapabilityStatement describes the capabilities of a Genentech FHIR server which receives patient enrollments, sends enrollment status updates and serves related Questionnaire resources."/>
<kind value="requirements"/>
<fhirVersion value="4.3.0"/>
<format value="xml"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="https://fhir.developer.gene.com/ImplementationGuide/uapi"/>
<rest>
<mode value="server"/>
<documentation
value="UAPI Data Source **SHALL**:
1. Support the Solicited - RESTful Data Source workflow defined in this guide, including all required searches and search parameters.
1. Implement the RESTful behavior according to the FHIR specification.
1. Support the JSON source format.
1. Declare a CapabilityStatement identifying the profiles supported.
1. Follow US Core search requirements and guidance when performing searches associated with this IG.
UAPI Data Source **SHOULD**:
1. Respond to the Patient/$match operation.
1. Support the recommended searches and parameters identified in the guide.
1. Support the XML source format.
1. Identify the UAPI profiles supported as part of the FHIR `meta.profile` attribute for each applicable instance.
The UAPI Data Source MAY
1. Support the Task / SMART application launch capability specified in the guide."/>
<security>
<description
value="1. UAPI Data Source **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code.
1. UAPI Data Source **SHOULD** authorize exchanges using OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Guide.
1. For general security considerations refer to [FHIR Security and Privacy Considerations](https://www.hl7.org/fhir/secpriv-module.html).
1. For additional security guidance, refer to the [core FHIR Security guidance page](https://www.hl7.org/fhir/security.html)."/>
</security>
<resource>
<type value="Questionnaire"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-version"/>
<type value="token"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>