Universal API Implementation Guide
1.1.19 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

: UAPI CapabilityStatement - Genentech FHIR Server - XML Representation

Active as of 2020-08-21

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="uapi-gne-fhir-server"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>UAPIgneFHIRserver</h2><div><p>This CapabilityStatement describes the capabilities of a Genentech FHIR server which receives patient enrollments, sends enrollment status updates and serves related Questionnaire resources.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><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></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>Questionnaire</td><td><a href="http://hl7.org/fhir/StructureDefinition/Questionnaire">http://hl7.org/fhir/StructureDefinition/Questionnaire</a></td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="https://fhir.developer.gene.com/CapabilityStatement/uapi-gne-fhir-server"/>
  <version value="1.1.19"/>
  <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"/>
  <publisher value="Genentech USIX PE"/>
  <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."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <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>