This page is part of the Argonaut Questionnaire Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
XML Format: CapabilityStatement-answerbank
Download Raw xml
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="answerbank"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Argonaut Answerbank CapabilityStatement</h2><p>This section outlines conformance requirements for the Argonaut Questionnaire Answer Bank Server. It is responsible for storing QuestionnairesResponses and providing responses to the requests submitted by the Provider EHRs. The Argonaut QuestionnaireResponse Profile and Argonaut Adaptive QuestionnaireResponse Profiles 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-28</li><li>Published by: The Argonaut Project</li></ul><h3 id="behavior">FHIR RESTful Capabilities</h3><p>The Argonaut questionnaire Answer-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 Answer-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="#questionnaireresponse">QuestionnaireResponse</a></td><td><p><a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaireresponse">Argonaut QuestionnaireResponse Profile</a>, <a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse">Argonaut Adaptive QuestionnaireResponse Profile</a></p></td><td> _id, questionnaire, patient, context, status, author, source, author+patient, author+patient+status, author+status, context+patient, context+patient+status, context+status, patient+source, patient+source+status, patient+status, questionnaire+status, source+status </td><td> QuestionnaireResponse:questionnaire </td></tr></tbody></table><br></br><h4 class="no_toc" id="questionnaireresponse">QuestionnaireResponse</h4><p>Supported Profiles: <p><a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaireresponse">Argonaut QuestionnaireResponse Profile</a>, <a href="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse">Argonaut Adaptive QuestionnaireResponse 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"> Argonaut Questionnaire Profile</a> as a contained resource with the Argonaut Adaptive QuestionnaireResponse Profile.</li><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>history-instance</code>.</li><li><strong>MAY</strong> support <code>patch</code>, <code>delete</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 QuestionnaireResponse resource using: <br></br> <code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]</code> </li><br></br><li> A server <strong>SHOULD</strong> be capable of supporting the returning the following _includes: <br></br> QuestionnaireResponse:questionnaire - <code class="highlighter-rouge">GET [base]/QuestionnaireResponse?[parameter=value]&_include=QuestionnaireResponse:questionnaire</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]/QuestionnaireResponse?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-questionnaire">questionnaire</a></td><td> reference </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-patient">patient</a></td><td> reference </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?patient=[patient]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-context">context</a></td><td> reference </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?context=[context]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-status">status</a></td><td> token </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-author">author</a></td><td> reference </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?author=[author]</code></td></tr><tr><td><strong>SHOULD</strong></td><td><a href="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-source">source</a></td><td> reference </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?source=[source]</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>author+patient </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?author=[author]&patient=[patient]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>author+patient+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?author=[author]&patient=[patient]&status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>author+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?author=[author]&status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td>context+patient </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]</code></td></tr><tr><td><strong>SHALL</strong></td><td>context+patient+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]&status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td>context+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?context=[context]&status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>patient+source </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?patient=[patient]&source=[source]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>patient+source+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?patient=[patient]&source=[source]&status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td>patient+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?patient=[patient]&status=[status]</code></td></tr><tr><td><strong>SHALL</strong></td><td>questionnaire+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]&status=[status]</code></td></tr><tr><td><strong>SHOULD</strong></td><td>source+status </td><td><code class="highlighter-rouge">GET [base]/QuestionnaireResponse?source=[source]&status=[status]</code></td></tr></tbody></table><br></br></div> </text> <url value="http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/answerbank"/> <version value="0.0.0"/> <name value="answerbank"/> <title value="Argonaut Answerbank CapabilityStatement"/> <status value="active"/> <experimental value="false"/> <date value="2019-02-28"/> <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 Answer Bank Server. It is responsible for storing QuestionnairesResponses and providing responses to the requests submitted by the Provider EHRs. The Argonaut QuestionnaireResponse Profile and Argonaut Adaptive QuestionnaireResponse Profiles 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> <profile> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <reference value="http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaireresponse"/> <display value="Argonaut QuestionnaireResponse 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-adap-questionnaireresponse"/> <display value="Argonaut Adaptive QuestionnaireResponse Profile"/> </profile> <rest> <mode value="server"/> <documentation value="The Argonaut questionnaire Answer-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 Answer-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="author"/> </extension> <extension url="required"> <valueString value="patient"/> </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="author"/> </extension> <extension url="required"> <valueString value="patient"/> </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="author"/> </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="context"/> </extension> <extension url="required"> <valueString value="patient"/> </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="context"/> </extension> <extension url="required"> <valueString value="patient"/> </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="context"/> </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="patient"/> </extension> <extension url="required"> <valueString value="source"/> </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="patient"/> </extension> <extension url="required"> <valueString value="source"/> </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="patient"/> </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="questionnaire"/> </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="source"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <type value="QuestionnaireResponse"/> <documentation value="- A server *SHALL* be capable of supporting the[ Argonaut Questionnaire Profile](http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire) as a contained resource with the Argonaut Adaptive QuestionnaireResponse Profile. - 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="MAY"/> </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"/> <searchInclude value="QuestionnaireResponse:questionnaire"/> <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="questionnaire"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-questionnaire"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="context"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-context"/> <type value="reference"/> </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/QuestionnaireResponse-status"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="author"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-author"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="source"/> <definition value="http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-source"/> <type value="reference"/> </searchParam> </resource> </rest> </CapabilityStatement>
