Argonaut Questionnaire Implementation Guide (Release 1.0.0 )

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-adaptive-questionnaire-service

Download Raw xml


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="adaptive-questionnaire-service"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Argonaut Adaptive Questionnaire Service CapabilityStatement</h2><p>This section outlines conformance requirements for the Argonaut Questionnaire Adaptive QuestionService.  It is responsible for providing questions in response to requests and  determining the next question and calculation of the score for an Adaptive Questionnaires.  It supports the Argonaut Adaptive QuestionnaireResponse Profile and the transactions associated with the adaptive questionnaires.   Note that the Argonaut Profile and next-question OperationDefinition identify the structural constraints, terminology bindings and invariants.</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 Adaptive Questionnaire Service <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 Adaptive Questionnaire Service <strong>SHOULD</strong>:</p><ol><li>Support xml resource formats for all Argonaut questionnaire interactions.</li><li>Provide a mechanism for discovery of the adaptive forms it offers.</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 Operations</strong></p><li><strong>SHALL</strong> support the	<a href="http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question"><code>$next-question</code></a> operation.</li><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-adap-questionnaireresponse">Argonaut Adaptive QuestionnaireResponse Profile</a></p></td><td>
							
						</td><td>
							
						</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-adap-questionnaireresponse">Argonaut Adaptive QuestionnaireResponse Profile</a></p>

				</p><ul><li>The Service <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>The Service <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>Profile Interaction Summary:</p><ul><li><strong>MAY</strong> support 
																							<code>search-type</code>, 
																							<code>read</code>, 
																							<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>
					A server <strong>MAY</strong> be capable of returning a QuestionnaireResponse resource using:
					<br></br>
						<code class="highlighter-rouge">GET [base]/QuestionnaireResponse/[id]</code>
				</li><br></br></ul><br></br></div>
  </text>
  <url
       value="http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/adaptive-questionnaire-service"/>
  <version value="0.0.0"/>
  <name value="adaptive_questionnaire_service"/>
  <title value="Argonaut Adaptive Questionnaire Service 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 Adaptive QuestionService.  It is responsible for providing questions in response to requests and  determining the next question and calculation of the score for an Adaptive Questionnaires.  It supports the Argonaut Adaptive QuestionnaireResponse Profile and the transactions associated with the adaptive questionnaires.   Note that the Argonaut Profile and next-question OperationDefinition identify the structural constraints, terminology bindings and invariants."/>
  <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-adap-questionnaireresponse"/>
    <display value="Argonaut Adaptive QuestionnaireResponse Profile"/>
  </profile>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The Argonaut Adaptive Questionnaire Service **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 Adaptive Questionnaire Service **SHOULD**:

1. Support xml resource formats for all Argonaut questionnaire interactions.
1. Provide a mechanism for discovery of the adaptive forms it offers."/>
    <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>
      <type value="QuestionnaireResponse"/>
      <documentation
                     value="-  The Service *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.
-  The Service *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="MAY"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <readHistory value="false"/>
      <updateCreate value="false"/>
    </resource>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="next-question"/>
      <definition>
        <reference
                   value="http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question"/>
      </definition>
    </operation>
  </rest>
</CapabilityStatement>