Structured Data Capture
3.0.0 - STU 3 International flag

This page is part of the Structured Data Capture FHIR IG (v3.0.0: STU 3) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Questionnaire response extract to resource(s) - XML Representation

Page standards status: Trial-use Maturity Level: 3

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="QuestionnaireResponse-extract"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>SDCQuestionnaireResponseExtract</h2><p>OPERATION: SDCQuestionnaireResponseExtract</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract</pre><div><p>The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on.     The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.   When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid.  If not, the extract operation could fail (with appropriate OperationOutcomes)   or, more problematic, might succeed but provide incorrect output.</p>
</div><p>URL: [base]/QuestionnaireResponse/$extract</p><p>URL: [base]/QuestionnaireResponse/[id]/$extract</p><p>Input parameters Profile: <a href="StructureDefinition-parameters-questionnaireresponse-extract-in.html">Questionnaire response extract operation input parameters</a></p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</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</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></td><td/><td><div><p>The QuestionnaireResponse to extract data from.  Used when the operation is invoked at the 'type' level.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></td><td/><td><div><p>The resulting FHIR resource produced after extracting data.  This will either be a single resource or a Transaction Bundle that contains multiple resources.  The operations in the Bundle might be creates, updates and/or conditional versions of both depending on the nature of the extraction mappings.</p>
</div></td></tr><tr><td>OUT</td><td>issues</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>A list of hints and warnings about problems encountered while extracting the resource(s) from the QuestionnaireResponse. If there was nothing to extract, a 'success' OperationOutcome is returned with a warning and/or information messages. In situations where the input is invalid or the operation otherwise fails to complete successfully, a normal 'erroneous' OperationOutcome would be returned (as happens with all operations) indicating what the issue was.</p>
</div></td></tr></table><div><p>The QuestionnaireResponse must identify a Questionnaire instance containing appropriate metadata to allow extraction.  (Refer to the <a href="extraction.html">Data Extraction</a> page for more details.)</p>
</div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"/>
      </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/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract"/>
  <version value="3.0.0"/>
  <name value="SDCQuestionnaireResponseExtract"/>
  <title value="Questionnaire response extract to resource(s)"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2018-08-30"/>
  <publisher value="HL7 International - FHIR Infrastructure Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="The Extract operation takes a completed QuestionnaireResponse and converts it to a FHIR resource or Bundle of resources by using metadata embedded in the Questionnaire the QuestionnaireResponse is based on.     The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.   When invoking the $extract operation, care should be taken that the submitted QuestionnaireResponse is itself valid.  If not, the extract operation could fail (with appropriate OperationOutcomes)   or, more problematic, might succeed but provide incorrect output."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <code value="extract"/>
  <comment
           value="The QuestionnaireResponse must identify a Questionnaire instance containing appropriate metadata to allow extraction.  (Refer to the [Data Extraction](extraction.html) page for more details.)"/>
  <resource value="QuestionnaireResponse"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <inputProfile
                value="http://hl7.org/fhir/uv/sdc/StructureDefinition/parameters-questionnaireresponse-extract-in"/>
  <parameter>
    <name value="questionnaire-response"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The QuestionnaireResponse to extract data from.  Used when the operation is invoked at the &#39;type&#39; level."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The resulting FHIR resource produced after extracting data.  This will either be a single resource or a Transaction Bundle that contains multiple resources.  The operations in the Bundle might be creates, updates and/or conditional versions of both depending on the nature of the extraction mappings."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="issues"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A list of hints and warnings about problems encountered while extracting the resource(s) from the QuestionnaireResponse. If there was nothing to extract, a &#39;success&#39; OperationOutcome is returned with a warning and/or information messages. In situations where the input is invalid or the operation otherwise fails to complete successfully, a normal &#39;erroneous&#39; OperationOutcome would be returned (as happens with all operations) indicating what the issue was."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>