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

Argonaut Answerbank CapabilityStatement

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.

  • FHIR Version: 3.0.1
  • Supported formats: xml, json
  • Published: 2019-02-28
  • Published by: The Argonaut Project

FHIR RESTful Capabilities

The Argonaut questionnaire Answer-Bank 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.
  2. Support json resource formats for all Argonaut Questionnaire interactions.
  3. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.

The Argonaut questionnaire Answer-Bank SHOULD:

  1. 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 Search Criteria

Resource TypeSupported ProfilesSupported SearchesSupported 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

QuestionnaireResponse

Supported Profiles:

Argonaut QuestionnaireResponse Profile, Argonaut Adaptive QuestionnaireResponse Profile

Reference Policy: resolves

Versioning Policy: versioned

Profile Interaction Summary:

  • SHALL support create, search-type, read, vread, update, history-instance.
  • MAY support patch, delete, history-type.

Fetch and Search Criteria:

  • A server SHALL 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:

ConformanceParameterTypeExample
SHALL_id token GET [base]/QuestionnaireResponse?_id=[id]
SHALLquestionnaire reference GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]
SHALLpatient reference GET [base]/QuestionnaireResponse?patient=[patient]
SHALLcontext reference GET [base]/QuestionnaireResponse?context=[context]
SHALLstatus token GET [base]/QuestionnaireResponse?status=[status]
SHOULDauthor reference GET [base]/QuestionnaireResponse?author=[author]
SHOULDsource reference GET [base]/QuestionnaireResponse?source=[source]

Search Parameter Combination Summary:

ConformanceParameter CombinationExample
SHOULDauthor+patient GET [base]/QuestionnaireResponse?author=[author]&patient=[patient]
SHOULDauthor+patient+status GET [base]/QuestionnaireResponse?author=[author]&patient=[patient]&status=[status]
SHOULDauthor+status GET [base]/QuestionnaireResponse?author=[author]&status=[status]
SHALLcontext+patient GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]
SHALLcontext+patient+status GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]&status=[status]
SHALLcontext+status GET [base]/QuestionnaireResponse?context=[context]&status=[status]
SHOULDpatient+source GET [base]/QuestionnaireResponse?patient=[patient]&source=[source]
SHOULDpatient+source+status GET [base]/QuestionnaireResponse?patient=[patient]&source=[source]&status=[status]
SHALLpatient+status GET [base]/QuestionnaireResponse?patient=[patient]&status=[status]
SHALLquestionnaire+status GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]&status=[status]
SHOULDsource+status GET [base]/QuestionnaireResponse?source=[source]&status=[status]