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

JSON Format: CapabilityStatement-adaptive-questionnaire-service

Download Raw json

{
  "resourceType" : "CapabilityStatement",
  "id" : "adaptive-questionnaire-service",
  "text" : {
    "status" : "generated",
    "div" : "<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\t<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>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td><td>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t</td></tr></tbody></table><br></br><h4 class=\"no_toc\" id=\"questionnaireresponse\">QuestionnaireResponse</h4><p>Supported Profiles:\n\t\t\t<p><a href=\"http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse\">Argonaut Adaptive QuestionnaireResponse Profile</a></p>\n\n\t\t\t\t</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 \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>read</code>, \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA server <strong>MAY</strong> be capable of returning a QuestionnaireResponse resource using:\n\t\t\t\t\t<br></br>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code>\n\t\t\t\t</li><br></br></ul><br></br></div>"
  },
  "url" : "http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/adaptive-questionnaire-service",
  "version" : "0.0.0",
  "name" : "adaptive_questionnaire_service",
  "title" : "Argonaut Adaptive Questionnaire Service CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2019-02-26",
  "publisher" : "The Argonaut Project",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://github.com/argonautproject/questionnaire/issues"
        }
      ]
    }
  ],
  "description" : "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" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "3.0.1",
  "acceptUnknown" : "both",
  "format" : [
    "xml",
    "json"
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "implementationGuide" : [
    "http://fhir.org/guides/argonaut/questionnaire/ImplementationGuide/fhir.argonaut.questionnaire-1.0.0",
    "http://hl7.org/fhir/us/core/STU2/ImplementationGuide/us-core-ig"
  ],
  "profile" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ],
      "reference" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse",
      "display" : "Argonaut Adaptive QuestionnaireResponse Profile"
    }
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The Argonaut Adaptive Questionnaire Service **SHALL**:\n\n1. 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).\n1. Support json resource formats for all Argonaut Questionnaire interactions.\n1. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.\n\nThe Argonaut Adaptive Questionnaire Service **SHOULD**:\n\n1. Support xml resource formats for all Argonaut questionnaire interactions.\n1. Provide a mechanism for discovery of the adaptive forms it offers.",
      "security" : {
        "description" : "For general security consideration refer to the [Security and Privacy Considerations](https://argonautproject.github.io/questionnaire/index.html#security-and-privacy-considerations)."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "QuestionnaireResponse",
          "documentation" : "-  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.\n-  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" : "MAY"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "vread"
            }
          ],
          "readHistory" : false,
          "updateCreate" : false
        }
      ],
      "operation" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "name" : "next-question",
          "definition" : {
            "reference" : "http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question"
          }
        }
      ]
    }
  ]
}