| Package | fhir.argonaut.questionnaire |
| Type | CapabilityStatement |
| Id | answerbank |
| FHIR Version | R3 |
| Source | http://fhir.org/guides/argonaut/questionnaire/http://fhir.org/guides/argonaut/questionnaire/1.0.0/CapabilityStatement-answerbank.html |
| URL | http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/answerbank |
| Version | 0.0.0 |
| Status | active |
| Date | 2019-02-28 |
| Name | answerbank |
| Title | Argonaut Answerbank CapabilityStatement |
| Realm | us |
| Authority | hl7 |
| Description | 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. |
| Kind | requirements |
No resources found
| ImplementationGuide | |
| argonaut.us.questionnaire-1.0.0 | Argonaut Questionnaire |
| SearchParameter | |
| QuestionnaireResponse-author | questionnaireresponse_author |
| QuestionnaireResponse-context | questionnaireresponse_context |
| QuestionnaireResponse-patient | questionnaireresponse_patient |
| QuestionnaireResponse-questionnaire | questionnaireresponse_questionnaire |
| QuestionnaireResponse-source | questionnaireresponse_source |
| QuestionnaireResponse-status | questionnaireresponse_status |
Note: links and images are rebased to the (stated) source
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.
The Argonaut questionnaire Answer-Bank SHALL:
The Argonaut questionnaire Answer-Bank SHOULD:
Security:
For general security consideration refer to the Security and Privacy Considerations.
Summary of Search Criteria
| Resource Type | Supported Profiles | Supported Searches | Supported Includes |
|---|---|---|---|
| QuestionnaireResponse | Argonaut QuestionnaireResponse Profile, Argonaut Adaptive QuestionnaireResponse Profile | _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 | QuestionnaireResponse:questionnaire |
Supported Profiles:
Argonaut QuestionnaireResponse Profile, Argonaut Adaptive QuestionnaireResponse Profile
Reference Policy: resolves
Versioning Policy: versioned
Profile Interaction Summary:
FHIRcreate,
search-type,
read,
vread,
update,
history-instance.patch,
delete,
history-type.Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id]
GET [base]/QuestionnaireResponse?[parameter=value]&_include=QuestionnaireResponse:questionnaire
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | token | GET [base]/QuestionnaireResponse?_id=[id] |
| SHALL | questionnaire | reference | GET [base]/QuestionnaireResponse?questionnaire=[questionnaire] |
| SHALL | patient | reference | GET [base]/QuestionnaireResponse?patient=[patient] |
| SHALL | context | reference | GET [base]/QuestionnaireResponse?context=[context] |
| SHALL | status | token | GET [base]/QuestionnaireResponse?status=[status] |
| SHOULD | author | reference | GET [base]/QuestionnaireResponse?author=[author] |
| SHOULD | source | reference | GET [base]/QuestionnaireResponse?source=[source] |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Example |
|---|---|---|
| SHOULD | author+patient | GET [base]/QuestionnaireResponse?author=[author]&patient=[patient] |
| SHOULD | author+patient+status | GET [base]/QuestionnaireResponse?author=[author]&patient=[patient]&status=[status] |
| SHOULD | author+status | GET [base]/QuestionnaireResponse?author=[author]&status=[status] |
| SHALL | context+patient | GET [base]/QuestionnaireResponse?context=[context]&patient=[patient] |
| SHALL | context+patient+status | GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]&status=[status] |
| SHALL | context+status | GET [base]/QuestionnaireResponse?context=[context]&status=[status] |
| SHOULD | patient+source | GET [base]/QuestionnaireResponse?patient=[patient]&source=[source] |
| SHOULD | patient+source+status | GET [base]/QuestionnaireResponse?patient=[patient]&source=[source]&status=[status] |
| SHALL | patient+status | GET [base]/QuestionnaireResponse?patient=[patient]&status=[status] |
| SHALL | questionnaire+status | GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]&status=[status] |
| SHOULD | source+status | GET [base]/QuestionnaireResponse?source=[source]&status=[status] |
{
"resourceType": "CapabilityStatement",
"id": "answerbank",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/answerbank",
"version": "0.0.0",
"name": "answerbank",
"title": "Argonaut Answerbank CapabilityStatement",
"status": "active",
"experimental": false,
"date": "2019-02-28",
"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 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": "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/argonaut.us.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"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"reference": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-questionnaireresponse",
"display": "Argonaut QuestionnaireResponse 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 questionnaire Answer-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 Answer-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": "author"
},
{
"url": "required",
"valueString": "patient"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "author"
},
{
"url": "required",
"valueString": "patient"
},
{
"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": "author"
},
{
"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": "context"
},
{
"url": "required",
"valueString": "patient"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"url": "required",
"valueString": "context"
},
{
"url": "required",
"valueString": "patient"
},
{
"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": "context"
},
{
"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": "patient"
},
{
"url": "required",
"valueString": "source"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
},
{
"url": "required",
"valueString": "patient"
},
{
"url": "required",
"valueString": "source"
},
{
"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": "patient"
},
{
"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": "questionnaire"
},
{
"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": "source"
},
{
"url": "required",
"valueString": "status"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "QuestionnaireResponse",
"documentation": "- 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.\n- 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": "MAY"
}
],
"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"
],
"searchInclude": [
"QuestionnaireResponse:questionnaire"
],
"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": "questionnaire",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-questionnaire",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-patient",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "context",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-context",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "status",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-status",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "author",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-author",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "source",
"definition": "http://fhir.org/guides/argonaut/questionnaire/SearchParameter/QuestionnaireResponse-source",
"type": "reference"
}
]
}
]
}
]
}