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. 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

  1. Implement the RESTful behavior according to the FHIR specification as described in the FHIR specification for FHIR RESTful API.
  2. Support the 'next-question' operation for filling out adaptive questionnaires
  3. Support json resource formats for all Argonaut Questionnaire interactions.

The Argonaut Questionnaire Provider EHR MAY:

  1. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter is supported.

  2. 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

  • SHOULD support the $next-question operation.
  • Summary of Search Criteria

    Resource TypeSupported ProfilesSupported SearchesSupported Includes
    Questionnaire

    Argonaut Questionnaire Profile

    _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

    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:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/Questionnaire?_id=[id]
    SHOULDurl uri GET [base]/Questionnaire?url=[uri]
    SHOULDstatus token GET [base]/Questionnaire?status=[status]
    SHOULDtitle string GET [base]/Questionnaire?title=[title]
    SHOULDpublisher string GET [base]/Questionnaire?publisher=[publisher]
    SHOULDversion token GET [base]/Questionnaire?version=[system]|[code]
    SHOULDcontext-type-value composite GET [base]/Questionnaire?context-type-value=[code]&[value]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationExample
    SHOULDcontext-type-value+publisher GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]
    SHOULDcontext-type-value+publisher+status GET [base]/Questionnaire?context-type-value=[code]&[value]&publisher=[publisher]&status=[status]
    SHOULDcontext-type-value+status GET [base]/Questionnaire?context-type-value=[code]&[value]&status=[status]
    SHOULDpublisher+status GET [base]/Questionnaire?publisher=[publisher]&status=[status]
    SHOULDpublisher+status+version GET [base]/Questionnaire?publisher=[publisher]&status=[status]&version=[system]|[code]
    SHOULDpublisher+version GET [base]/Questionnaire?publisher=[publisher]&version=[system]|[code]
    SHOULDstatus+title GET [base]/Questionnaire?status=[status]&title=[title]
    SHOULDstatus+title+version GET [base]/Questionnaire?status=[status]&title=[title]&version=[system]|[code]
    SHOULDstatus+version GET [base]/Questionnaire?status=[status]&version=[system]|[code]
    SHOULDtitle+version GET [base]/Questionnaire?title=[title]&version=[system]|[code]

    QuestionnaireResponse

    Supported Profiles:

    Argonaut QuestionnaireResponse Profile, Argonaut Adaptive QuestionnaireResponse 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:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/QuestionnaireResponse?_id=[id]
    SHOULDquestionnaire reference GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]
    SHOULDpatient reference GET [base]/QuestionnaireResponse?patient=[patient]
    SHOULDcontext reference GET [base]/QuestionnaireResponse?context=[context]
    SHOULDstatus 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]
    SHOULDcontext+patient GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]
    SHOULDcontext+patient+status GET [base]/QuestionnaireResponse?context=[context]&patient=[patient]&status=[status]
    SHOULDcontext+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]
    SHOULDpatient+status GET [base]/QuestionnaireResponse?patient=[patient]&status=[status]
    SHOULDquestionnaire+status GET [base]/QuestionnaireResponse?questionnaire=[questionnaire]&status=[status]
    SHOULDsource+status GET [base]/QuestionnaireResponse?source=[source]&status=[status]