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

FHIR IG Statistics: OperationDefinition/next-question

Packagefhir.argonaut.questionnaire
TypeOperationDefinition
Idnext-question
FHIR VersionR3
Sourcehttp://fhir.org/guides/argonaut/questionnaire/http://fhir.org/guides/argonaut/questionnaire/1.0.0/OperationDefinition-next-question.html
URLhttp://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question
Version1.0.0
Statusdraft
Date2018-08-09T07:35:53+10:00
NameArgonaut Next Question Operation
Realmus
Authorityhl7
DescriptionThe Argonaut Next Question Operation is used for *adaptive questionnaires* forms where the next question is based on previous answers. The result of this operation is to return the next question and optionally the questionnaire scoring for an adaptive questionnaire. This operation uses the [QuestionnaireResponse](http://hl7.org/fhir/STU3/questionnaireresponse.html) resource with a [*contained*](http://hl7.org/fhir/STU3/references.html#contained) [Questionnaire](http://hl7.org/fhir/STU3/questionnaire.html) as both the input and output parameter. The Client initiates and queries for the next question supplying the answer to the previous question. The Server updates the contained Questionnaire in the QuestionnaireResponse in the with the next question. When the questionnaire is complete, the Server updates the status element of the QuestionnaireResponse resource to `completed`. If the questionnaire has exceeded the time limit, the Client or Server may return an [OperationOutcome](http://hl7.org/fhir/STU3/operationoutcome.html) with an error.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
adaptive-questionnaire-serviceArgonaut Adaptive Questionnaire Service CapabilityStatement
argo-questionnaire-provider-ehrArgonaut Argo Questionnaire Provider Ehr CapabilityStatement

Resources that this resource uses

No resources found


Narrative

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

Argonaut Next Question Operation

OPERATION: Argonaut Next Question Operation

The official URL for this operation definition is:

http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question

The Argonaut Next Question Operation is used for adaptive questionnaires forms where the next question is based on previous answers. The result of this operation is to return the next question and optionally the questionnaire scoring for an adaptive questionnaire. This operation uses the QuestionnaireResponse resource with a contained Questionnaire as both the input and output parameter. The Client initiates and queries for the next question supplying the answer to the previous question. The Server updates the contained Questionnaire in the QuestionnaireResponse in the with the next question. When the questionnaire is complete, the Server updates the status element of the QuestionnaireResponse resource to completed. If the questionnaire has exceeded the time limit, the Client or Server may return an OperationOutcome with an error.

URL: [base]/Questionnaire/$next-question

Parameters

UseNameCardinalityTypeBindingDocumentation
INquestionnaire-response1..1Resource

The Argo Adaptive QuestionnaireResponse Profile of the QuestionnaireResponse resource with a contained Questionnaire. The url element in the contained Questionnaire identifies which set of questions are being requested. When initiating an adaptive questionnaire, the resource represents only metadata, because it precedes the first question. For subsequent transactions the Client updates the QuestionnaireResponse with the previous question-answer pair and posts it to the Server.

OUTreturn1..1Resource

The Argo Adaptive QuestionnaireResponse Profile of the QuestionnaireResponse resource with a contained Questionnaire. The Server updates the QuestionnaireResponse's contained Questionnaire with the next question and optionally scoring or other data and returns it as this parameter. When the questionnaire is complete, the Server updates the status element of the QuestionnaireResponse to completed.


Source

{
  "resourceType": "OperationDefinition",
  "id": "next-question",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.org/guides/argonaut/questionnaire/OperationDefinition/next-question",
  "version": "1.0.0",
  "name": "Argonaut Next Question Operation",
  "status": "draft",
  "kind": "operation",
  "date": "2018-08-09T07:35:53+10:00",
  "publisher": "The Argonaut Project",
  "description": "The Argonaut Next Question Operation is used for *adaptive questionnaires* forms where the next question is based on previous answers.  The result of this operation is to return the next question and optionally the questionnaire scoring for an adaptive questionnaire.  This operation uses the [QuestionnaireResponse](http://hl7.org/fhir/STU3/questionnaireresponse.html) resource with a [*contained*](http://hl7.org/fhir/STU3/references.html#contained) [Questionnaire](http://hl7.org/fhir/STU3/questionnaire.html) as both the input and output parameter. The Client initiates and queries for the next question supplying the answer to the previous question.  The Server updates the contained Questionnaire in the  QuestionnaireResponse in the with the next question.  When the questionnaire is complete, the Server updates the status element of the QuestionnaireResponse resource to `completed`.  If the questionnaire has exceeded the time limit, the  Client or Server may return an [OperationOutcome](http://hl7.org/fhir/STU3/operationoutcome.html) with an error.",
  "code": "next-question",
  "resource": [
    "Questionnaire"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "questionnaire-response",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The [Argo Adaptive QuestionnaireResponse Profile](StructureDefinition-argo-adap-questionnaireresponse.html) of the QuestionnaireResponse resource with a *contained* Questionnaire.  The `url` element in the *contained* Questionnaire identifies which set of questions are being requested.  When initiating an adaptive questionnaire, the resource represents only metadata, because it precedes the first question.  For subsequent transactions the Client updates the QuestionnaireResponse with the previous question-answer pair and posts it to the Server.",
      "type": "Resource",
      "profile": {
        "reference": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse"
      }
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The [Argo Adaptive QuestionnaireResponse Profile](StructureDefinition-argo-adap-questionnaireresponse.html) of the QuestionnaireResponse resource with a *contained* Questionnaire.  The Server updates the QuestionnaireResponse's contained Questionnaire with the next question and optionally scoring or other data and returns it as this parameter.  When the questionnaire is complete, the Server updates the status element of the QuestionnaireResponse to `completed`.",
      "type": "Resource",
      "profile": {
        "reference": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/argo-adap-questionnaireresponse"
      }
    }
  ]
}