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 
Argonaut Argo Questionnaire Provider Ehr CapabilityStatement
This section outlines conformance requirements for the Argonaut Questionnaire Provider EHR. It may be responsible for retrieving, rendering and displaying both static and adaptive Questionnaires and QuestionnairesResponses. The Argonaut Questionnaire Profile, Argonaut QuestionnaireResponse Profile and Argonaut Adaptive QuestionnaireResponse Profiles and all the 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.
- FHIR Version: 3.0.1
- Supported formats: xml, json
- Published: 2019-02-26
- Published by: The Argonaut Project
FHIR RESTful Capabilities
The Argonaut Questionnaire Provider EHR SHOULD
- Implement the RESTful behavior according to the FHIR specification as described in the FHIR specification for FHIR RESTful API.
- Support the 'next-question' operation for filling out adaptive questionnaires
- Support json resource formats for all Argonaut Questionnaire interactions.
The Argonaut Questionnaire Provider EHR MAY:
Declare a CapabilityStatement identifying the list of profiles, operations, search parameter is supported.
Support xml resource formats for all Argonaut questionnaire interactions.
Security:
For general security consideration refer to the Security and Privacy Considerations.
RESTful Capabilities by Resource/Profile:
Summary of Operations
$next-question operation.Summary of Search Criteria
| Resource Type | Supported Profiles | Supported Searches | Supported Includes |
|---|---|---|---|
| Questionnaire | _id, url, status, title, publisher, version, context-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 | ||
| 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 |
Questionnaire
Supported Profiles:
Argonaut Questionnaire Profile
- Provider EHR SHOULD be capable of supporting the Argonaut Questionnaire ValueSet Profile as a contained resource with the Argonaut Questionnaire Profile.
Profile Interaction Summary:
- SHOULD support
search-type,read,vread,history-instance. - MAY support
history-type.
Fetch and Search Criteria:
-
A server SHOULD be capable of returning a Questionnaire resource using:
GET [base]/Questionnaire/[id]
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | _id | token | GET [base]/Questionnaire?_id=[id] |
| SHOULD | url | uri | GET [base]/Questionnaire?url=[uri] |
| SHOULD | status | token | GET [base]/Questionnaire?status=[status] |
| SHOULD | title | string | GET [base]/Questionnaire?title=[title] |
| SHOULD | publisher | string | GET [base]/Questionnaire?publisher=[publisher] |
| SHOULD | version | token | GET [base]/Questionnaire?version=[system]|[code] |
| SHOULD | context-type-value | composite | GET [base]/Questionnaire?context-type-value=[code]&[value] |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Example |
|---|---|---|
| SHOULD | context-type-value+publisher | GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher] |
| SHOULD | context-type-value+publisher+status | GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]&status=[status] |
| SHOULD | context-type-value+status | GET [base]/Questionnaire?context-type-value=[code]&[value]&status=[status] |
| SHOULD | publisher+status | GET [base]/Questionnaire?publisher=[publisher]&status=[status] |
| SHOULD | publisher+status+version | GET [base]/Questionnaire?publisher=[publisher]&status=[status]&version=[system]|[code] |
| SHOULD | publisher+version | GET [base]/Questionnaire?publisher=[publisher]&version=[system]|[code] |
| SHOULD | status+title | GET [base]/Questionnaire?status=[status]&title=[title] |
| SHOULD | status+title+version | GET [base]/Questionnaire?status=[status]&title=[title]&version=[system]|[code] |
| SHOULD | status+version | GET [base]/Questionnaire?status=[status]&version=[system]|[code] |
| SHOULD | title+version | GET [base]/Questionnaire?title=[title]&version=[system]|[code] |
QuestionnaireResponse
Supported Profiles:
Argonaut QuestionnaireResponse Profile, Argonaut Adaptive QuestionnaireResponse Profile
- Provider EHR SHOULD be capable of supporting the Argonaut Questionnaire Profile as a contained resource with the Argonaut Adaptive QuestionnaireResponse Profile.
- Provider EHR SHOULD be capable of supporting the Argonaut Questionnaire ValueSet Profile as a contained resource with the Argonaut Questionnaire Profile.
Profile Interaction Summary:
- SHOULD support
create,search-type,read,vread,update,history-instance. - MAY support
patch,delete,history-type.
Fetch and Search Criteria:
-
A server SHOULD be capable of returning a QuestionnaireResponse resource using:
GET [base]/QuestionnaireResponse/[id] -
A server SHOULD be capable of supporting the returning the following _includes:
QuestionnaireResponse:questionnaire -GET [base]/QuestionnaireResponse?[parameter=value]&_include=QuestionnaireResponse:questionnaire
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHOULD | _id | token | GET [base]/QuestionnaireResponse?_id=[id] |
| SHOULD | questionnaire | reference | GET [base]/QuestionnaireResponse?questionnaire=[questionnaire] |
| SHOULD | patient | reference | GET [base]/QuestionnaireResponse?patient=[patient] |
| SHOULD | context | reference | GET [base]/QuestionnaireResponse?context=[context] |
| SHOULD | 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] |
| SHOULD | context+patient | GET [base]/QuestionnaireResponse?context=[context]&patient=[patient] |
| SHOULD | context+patient+status | GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]&status=[status] |
| SHOULD | 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] |
| SHOULD | patient+status | GET [base]/QuestionnaireResponse?patient=[patient]&status=[status] |
| SHOULD | questionnaire+status | GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]&status=[status] |
| SHOULD | source+status | GET [base]/QuestionnaireResponse?source=[source]&status=[status] |
