Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1

Publication Build: This will be filled in by the publication tooling

## : DTR Next Question Operation - XML Representation

Page standards status: Trial-use | Maturity Level: 2

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="DTR-Questionnaire-next-question"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition DTR-Questionnaire-next-question</b></p><a name="DTR-Questionnaire-next-question"> </a><a name="hcDTR-Questionnaire-next-question"> </a><a name="DTR-Questionnaire-next-question-en-US"> </a><p>URL: [base]/Questionnaire/$next-question</p><p>Input parameters Profile:<a href="StructureDefinition-dtr-next-question-input-parameters.html">DTR Next Question Input Parameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-dtr-next-question-output-parameters.html">DTR Next Question Output Parameters</a></p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>questionnaire-response-in</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></td><td/><td><div><p>The <a href="StructureDefinition-dtr-questionnaireresponse.html">DTR QuestionnaireResponse Profile</a> of the QuestionnaireResponse resource with a <em>contained</em> 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.</p>
    </div></td></tr><tr><td>OUT</td><td>questionnaire-response-out</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></td><td/><td><div><p>The <a href="StructureDefinition-dtr-questionnaireresponse.html">DTR QuestionnaireResponse Profile</a> of the QuestionnaireResponse resource with a <em>contained</em> Questionnaire.  The Server updates the QuestionnaireResponse's contained Questionnaire by appending with the next question or questions ittems 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 <code>complete</code>.</p>
    </div></td></tr></table><div><p>To return a calculated score for the questionnaire or group of items, the service may return a <code>readOnly</code> question with the score value in the corresponding QuestionnaireResponse.item.  The extension <code>questionnaire-hidden</code> can be included on the Questionnaire.item to indicate to the client that it should not be displayed to the end user</p>
    </div></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cds"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="2">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
          </extension>
        </valueInteger>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/DTR-Questionnaire-next-question"/>
      <version value="2.1.0"/>
      <name value="DTRNextQuestion"/>
      <title value="DTR Next Question Operation"/>
      <status value="active"/>
      <kind value="operation"/>
      <date value="2024-12-21T15:53:40+00:00"/>
      <publisher value="HL7 International / Clinical Decision Support"/>
      <contact>
        <name value="HL7 International / Clinical Decision Support"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/dss"/>
        </telecom>
      </contact>
      <description
                   value="The Next Question operation is used for *adaptive questionnaires*.  For specific details, see the [SDC Next Question operation](http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question)."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
        </coding>
      </jurisdiction>
      <code value="next-question"/>
      <comment
               value="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"/>
      <base
            value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question"/>
      <resource value="Questionnaire"/>
      <system value="false"/>
      <type value="true"/>
      <instance value="false"/>
      <inputProfile
                    value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-next-question-input-parameters"/>
      <outputProfile
                     value="http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-next-question-output-parameters"/>
      <parameter>
        <name value="questionnaire-response-in"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The [DTR QuestionnaireResponse Profile](StructureDefinition-dtr-questionnaireresponse.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."/>
        <type value="Resource"/>
      </parameter>
      <parameter>
        <name value="questionnaire-response-out"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The [DTR QuestionnaireResponse Profile](StructureDefinition-dtr-questionnaireresponse.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 ittems 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`."/>
        <type value="Resource"/>
      </parameter>
    </OperationDefinition>