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 
JSON Format: CapabilityStatement-assessmentbank
Download Raw json
{
"resourceType" : "CapabilityStatement",
"id" : "assessmentbank",
"text" : {
"status" : "generated",
"div" : "<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>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t_id, \n\t\t\t\t\t\t\turl, \n\t\t\t\t\t\t\tstatus, \n\t\t\t\t\t\t\ttitle, \n\t\t\t\t\t\t\tpublisher, \n\t\t\t\t\t\t\tversion, \n\t\t\t\t\t\t\tcontext-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\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=\"questionnaire\">Questionnaire</h4><p>Supported Profiles:\n\t\t\t<p><a href=\"http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire\">Argonaut Questionnaire Profile</a></p>\n\n\t\t\t\t</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 \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>create</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>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>, \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>update</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>delete</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>history-instance</code>.</li><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>patch</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>history-type</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\tA server <strong>SHALL</strong> be capable of returning a Questionnaire resource using:\n\t\t\t\t\t<br></br>\n\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]</code>\n\t\t\t\t</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>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\turi\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\tstring\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t</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>\n\t\t\t\t\t\t\tcomposite\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</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\n\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Questionnaire?title=[title]&version=[system]|[code]</code></td></tr></tbody></table><br></br></div>"
},
"url" : "http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/assessmentbank",
"version" : "0.0.0",
"name" : "assessmentbank",
"title" : "Argonaut Assessmentbank 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 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" : "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-questionnaire-valueset",
"display" : "Argonaut Questionnaire Contained ValueSet Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"reference" : "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaire",
"display" : "Argonaut Questionnaire Profile"
}
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Argonaut questionnaire Assessment-Bank **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 questionnaire Assessment-Bank **SHOULD**:\n\n1. Support xml resource formats for all Argonaut questionnaire interactions.",
"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"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "context-type-value"
},
{
"url" : "required",
"valueString" : "publisher"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "context-type-value"
},
{
"url" : "required",
"valueString" : "publisher"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "context-type-value"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "publisher"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "publisher"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "publisher"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "title"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "title"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "title"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Questionnaire",
"documentation" : "- 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" : "SHALL"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type" : "uri"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-status",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "title",
"definition" : "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-title",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "publisher",
"definition" : "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-publisher",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "version",
"definition" : "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-version",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "context-type-value",
"definition" : "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/Questionnaire-context-type-value",
"type" : "composite"
}
]
}
]
}
]
}
