This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions 
XML Format: CapabilityStatement-assessmentbank
Download Raw xml
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="assessmentbank"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Argonaut Assessmentbank CapabilityStatement</h2><p>This section outlines conformance requirements for the Argonaut Questionnaire Assessment-Bank Server. It is responsible for storing Questionnaires and providing responses to the requests submitted by the Form Author/Editor and Provider EHRs. The Argonaut Questionnaire Profile and the various interactions outlined in this guide are the RESTful artifacts and interactions that it supports. Note that the Argonaut Profiles identify the structural constraints, terminology bindings and invariants and the individual Argonaut SearchParameter resources define the definitions, comparators, modifiers and usage constraints.</p><ul><li>FHIR Version: 3.0.1</li><li>Supported formats: xml, json</li><li>Published: 2019-02-26</li><li>Published by: The Argonaut Project</li></ul><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Argonaut questionnaire Assessment-Bank <strong>SHALL</strong>:</p><ol><li>Implement the RESTful behavior according to the FHIR specification including returning the appropriate response classes as described in the FHIR specification for <a href="http://hl7.org/fhir/STU3/http.html">FHIR RESTful API</a>.</li><li>Support json resource formats for all Argonaut Questionnaire interactions.</li><li>Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.</li></ol><p>The Argonaut questionnaire Assessment-Bank <strong>SHOULD</strong>:</p><ol><li>Support xml resource formats for all Argonaut questionnaire interactions.</li></ol><p id="security"><strong>Security:</strong></p><p>For general security consideration refer to the <a href="https://argonautproject.github.io/questionnaire/index.html#security-and-privacy-considerations">Security and Privacy Considerations</a>.</p><h3 class="no_toc" id="resource--details">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary of Search Criteria</strong></p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported Includes</th></tr></thead><tbody><tr><td><a href="#questionnaire">Questionnaire</a></td><td><p><a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire">Argonaut Questionnaire Profile</a></p></td><td> _id, url, status, title, publisher, version, context-type-value, context-type-value+publisher, context-type-value+publisher+status, context-type-value+status, publisher+status, publisher+status+version, publisher+version, status+title, status+title+version, status+version, title+version </td><td> </td></tr></tbody></table><br></br><h4 class="no_toc" id="questionnaire">Questionnaire</h4><p>Supported Profiles: <p><a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire">Argonaut Questionnaire Profile</a></p> </p><ul><li>A server <em>SHALL</em> be capable of supporting the<a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire-valueset"> Argonaut Questionnaire ValueSet Profile</a> as a contained resource with the Argonaut Questionnaire Profile.</li></ul><p>Reference Policy: <code>resolves</code></p><p>Versioning Policy: <code>versioned</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>, <code>vread</code>, <code>update</code>, <code>delete</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li> A server <strong>SHALL</strong> be capable of returning a Questionnaire resource using: <br></br> <code class="highlighter-rouge">GET [base]/Questionnaire/[id]</code> </li><br></br></ul><p>Search Parameter Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/SearchParameter/Resource-id">_id</a></td><td> token </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://hl7.org/fhir/SearchParameter/Questionnaire-url">url</a></td><td> uri </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?url=[uri]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-status">status</a></td><td> token </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-title">title</a></td><td> string </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?title=[title]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-publisher">publisher</a></td><td> string </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?publisher=[publisher]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-version">version</a></td><td> token </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?version=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-context-type-value">context-type-value</a></td><td> composite </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?context-type-value=[code]&[value]</code></td></tr></tbody></table><p>Search Parameter Combination Summary:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter Combination</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHOULD</strong></td><td>context-type-value+publisher </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>context-type-value+publisher+status </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]&status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>context-type-value+status </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?context-type-value=[code]&[value]&status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td>publisher+status </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?publisher=[publisher]&status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>publisher+status+version </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?publisher=[publisher]&status=[status]&version=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>publisher+version </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?publisher=[publisher]&version=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td>status+title </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?status=[status]&title=[title]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>status+title+version </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?status=[status]&title=[title]&version=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>status+version </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?status=[status]&version=[system]|[code]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>title+version </td><td><code class="highlighter-rouge">GET [base]/Questionnaire?title=[title]&version=[system]|[code]</code></td></tr></tbody></table><br></br></div> </text> <url value="http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/assessmentbank"/> <version value="0.0.0"/> <name value="assessmentbank"/> <title value="Argonaut Assessmentbank CapabilityStatement"/> <status value="active"/> <experimental value="false"/> <date value="2019-02-26"/> <publisher value="The Argonaut Project"/> <contact> <telecom> <system value="url"/> <value value="https://github.com/argonautproject/questionnaire/issues"/> </telecom> </contact> <description value="This section outlines conformance requirements for the Argonaut Questionnaire Assessment-Bank Server. It is responsible for storing Questionnaires and providing responses to the requests submitted by the Form Author/Editor and Provider EHRs. The Argonaut Questionnaire Profile and the various interactions outlined in this guide are the RESTful artifacts and interactions that it supports. Note that the Argonaut Profiles identify the structural constraints, terminology bindings and invariants and the individual Argonaut SearchParameter resources define the definitions, comparators, modifiers and usage constraints."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> </coding> </jurisdiction> <kind value="requirements"/> <fhirVersion value="3.0.1"/> <acceptUnknown value="both"/> <format value="xml"/> <format value="json"/> <patchFormat value="application/json-patch+json"/> <implementationGuide value="http://fhir.org/guides/argonaut/questionnaire/ImplementationGuide/fhir.argonaut.questionnaire-1.0.0"/> <implementationGuide value="http://hl7.org/fhir/us/core/STU2/ImplementationGuide/us-core-ig"/> <profile> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <reference value="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire-valueset"/> <display value="Argonaut Questionnaire Contained ValueSet Profile"/> </profile> <profile> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <reference value="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire"/> <display value="Argonaut Questionnaire Profile"/> </profile> <rest> <mode value="server"/> <documentation value="The Argonaut questionnaire Assessment-Bank **SHALL**: 1. Implement the RESTful behavior according to the FHIR specification including returning the appropriate response classes as described in the FHIR specification for [FHIR RESTful API](http://hl7.org/fhir/STU3/http.html). 1. Support json resource formats for all Argonaut Questionnaire interactions. 1. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported. The Argonaut questionnaire Assessment-Bank **SHOULD**: 1. Support xml resource formats for all Argonaut questionnaire interactions."/> <security> <description value="For general security consideration refer to the [Security and Privacy Considerations](https://argonautproject.github.io/questionnaire/index.html#security-and-privacy-considerations)."/> </security> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="context-type-value"/> </extension> <extension url="required"> <valueString value="publisher"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="context-type-value"/> </extension> <extension url="required"> <valueString value="publisher"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="context-type-value"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <extension url="required"> <valueString value="publisher"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="publisher"/> </extension> <extension url="required"> <valueString value="status"/> </extension> <extension url="required"> <valueString value="version"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="publisher"/> </extension> <extension url="required"> <valueString value="version"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <extension url="required"> <valueString value="status"/> </extension> <extension url="required"> <valueString value="title"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="status"/> </extension> <extension url="required"> <valueString value="title"/> </extension> <extension url="required"> <valueString value="version"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="status"/> </extension> <extension url="required"> <valueString value="version"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <extension url="required"> <valueString value="title"/> </extension> <extension url="required"> <valueString value="version"/> </extension> </extension> <type value="Questionnaire"/> <documentation value="- A server *SHALL* be capable of supporting the[ Argonaut Questionnaire ValueSet Profile](http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire-valueset) as a contained resource with the Argonaut Questionnaire Profile."/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="create"/> </interaction> <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> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="vread"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="update"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="patch"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="delete"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="history-instance"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="history-type"/> </interaction> <versioning value="versioned"/> <readHistory value="false"/> <updateCreate value="false"/> <referencePolicy value="resolves"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="_id"/> <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="url"/> <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-url"/> <type value="uri"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="status"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-status"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="title"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-title"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="publisher"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-publisher"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="version"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-version"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="context-type-value"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-context-type-value"/> <type value="composite"/> </searchParam> </resource> </rest> </CapabilityStatement>
