$next-question

Adaptive Questionnaire - Next Question Operation

activeStructured Data Capture4.0.0operation1 input1 output

The Next Question operation is used for *adaptive questionnaires* - forms where the next question (or set of questions) is based on previous answers. The result of this operation is to return an updated QuestionnaireResponse with a contained Questionnaire that includes the next question (or set of questions). It might also include display items with instructions and/or read-only questions containing calculated scores. 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 by including the answers to all required questions in the questionnaire to that point. The Server updates the contained Questionnaire in the QuestionnaireResponse in the with the next question or set of questions and any needed instruction or score items. When the questionnaire is complete, the Server updates the `QuestionnaireResponse.status` resource parameter to `complete`. If completion of the questionnaire has exceeded any time limit, the Server may return an OperationOutcome with an error.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question
Code
$next-question
Kind
operation
Affects State
No
Publisher
HL7 International / FHIR Infrastructure

Invocation Context

Can be invoked at:
Type Level
Target Resources:

Implementation Notes

To return a calculated score for the questionnaire or group of items, the service may return a `readOnly` question with the score value in the corresponding QuestionnaireResponse.item. The extension `questionnaire-hidden` can be included on the Questionnaire.item to indicate to the client that it should not be displayed to the end user

Input Parameters (1)

NameTypeCard.Description
questionnaire-response*QuestionnaireResponse1..1The [Adaptive QuestionnaireResponse Profile](StructureDefinition-sdc-questionnaireresponse-adapt.html) of the QuestionnaireResponse resource with a *contained* Questionnaire. When invoking the operation for the first time, neither the QuestionnaireResponse nor the contained Questionnaire will have any items, as no questions are yet known. In subsequent calls, the QuestionnaireResponse will include answers to all required questions asked so far and the contained QuestionnaireResponse will remain the same as provided back from the operation in the preceding response.

Output Parameters (1)

NameTypeCard.Description
returnQuestionnaireResponse1..1The [Adaptive QuestionnaireResponse Profile](StructureDefinition-sdc-questionnaireresponse-adapt.html) of the QuestionnaireResponse resource with a *contained* Questionnaire. The Server updates the QuestionnaireResponse's contained Questionnaire by appending with the next question or questions items and any score or instruction items and returns the QuestionnaireResponse (with all answers completed thus far plus any calculated scores) as this parameter. When the questionnaire is complete, the Server updates the status of the QuestionnaireResponse resource parameter to `complete`.

Additional Information

Version
4.0.0
Date
2018-08-29