FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/adaptive-questionnaire-service

Packagefhir.argonaut.questionnaire
TypeCapabilityStatement
Idadaptive-questionnaire-service
FHIR VersionR3
Sourcehttp://fhir.org/guides/argonaut/questionnaire/http://fhir.org/guides/argonaut/questionnaire/1.0.0/CapabilityStatement-adaptive-questionnaire-service.html
URLhttp://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/adaptive-questionnaire-service
Version0.0.0
Statusactive
Date2019-02-26
Nameadaptive_questionnaire_service
TitleArgonaut Adaptive Questionnaire Service CapabilityStatement
Realmus
Authorityhl7
DescriptionThis section outlines conformance requirements for the Argonaut Questionnaire Adaptive QuestionService. It is responsible for providing questions in response to requests and determining the next question and calculation of the score for an Adaptive Questionnaires. It supports the Argonaut Adaptive QuestionnaireResponse Profile and the transactions associated with the adaptive questionnaires. Note that the Argonaut Profile and next-question OperationDefinition identify the structural constraints, terminology bindings and invariants.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
argonaut.us.questionnaire-1.0.0Argonaut Questionnaire
OperationDefinition
next-questionArgonaut Next Question Operation

Narrative

Note: links and images are rebased to the (stated) source

Argonaut Adaptive Questionnaire Service CapabilityStatement

This section outlines conformance requirements for the Argonaut Questionnaire Adaptive QuestionService. It is responsible for providing questions in response to requests and determining the next question and calculation of the score for an Adaptive Questionnaires. It supports the Argonaut Adaptive QuestionnaireResponse Profile and the transactions associated with the adaptive questionnaires. Note that the Argonaut Profile and next-question OperationDefinition identify the structural constraints, terminology bindings and invariants.

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

FHIR RESTful Capabilities

The Argonaut Adaptive Questionnaire Service 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 Adaptive Questionnaire Service SHOULD:

  1. Support xml resource formats for all Argonaut questionnaire interactions.
  2. Provide a mechanism for discovery of the adaptive forms it offers.

Security:

For general security consideration refer to the Security and Privacy Considerations.

RESTful Capabilities by Resource/Profile:

Summary of Operations

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

    Resource TypeSupported ProfilesSupported SearchesSupported Includes
    QuestionnaireResponse

    Argonaut Adaptive QuestionnaireResponse Profile



    QuestionnaireResponse

    Supported Profiles:

    Argonaut Adaptive QuestionnaireResponse Profile

    Profile Interaction Summary:

    • MAY support search-type, read, vread.

    Fetch and Search Criteria:

    • A server MAY be capable of returning a QuestionnaireResponse resource using:

      GET [base]/QuestionnaireResponse/[id]





    Source

    {
      "resourceType": "CapabilityStatement",
      "id": "adaptive-questionnaire-service",
      "text": {
        "status": "generated",
        "div": "<!-- snip (see above) -->"
      },
      "url": "http://fhir.org/guides/argonaut/questionnaire/CapabilityStatement/adaptive-questionnaire-service",
      "version": "0.0.0",
      "name": "adaptive_questionnaire_service",
      "title": "Argonaut Adaptive Questionnaire Service 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 Adaptive QuestionService.  It is responsible for providing questions in response to requests and  determining the next question and calculation of the score for an Adaptive Questionnaires.  It supports the Argonaut Adaptive QuestionnaireResponse Profile and the transactions associated with the adaptive questionnaires.   Note that the Argonaut Profile and next-question OperationDefinition identify the structural constraints, terminology bindings and invariants.",
      "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-adap-questionnaireresponse",
          "display": "Argonaut Adaptive QuestionnaireResponse Profile"
        }
      ],
      "rest": [
        {
          "mode": "server",
          "documentation": "The Argonaut Adaptive Questionnaire Service **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 Adaptive Questionnaire Service **SHOULD**:\n\n1. Support xml resource formats for all Argonaut questionnaire interactions.\n1. Provide a mechanism for discovery of the adaptive forms it offers.",
          "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"
                }
              ],
              "type": "QuestionnaireResponse",
              "documentation": "-  The Service *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-  The Service *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": "MAY"
                    }
                  ],
                  "code": "search-type"
                },
                {
                  "extension": [
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode": "MAY"
                    }
                  ],
                  "code": "read"
                },
                {
                  "extension": [
                    {
                      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode": "MAY"
                    }
                  ],
                  "code": "vread"
                }
              ],
              "readHistory": false,
              "updateCreate": false
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "next-question",
              "definition": {
                "reference": "http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question"
              }
            }
          ]
        }
      ]
    }