This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Questionnaire response extract to resource(s) - XML Representation

(back to narrative)

Raw xml

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="QuestionnaireResponse-extract"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>QuestionnaireResponseExtract</h2><p>OPERATION: QuestionnaireResponseExtract</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 QuestionnaireRespponse 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.</p>
</div><p>URL: [base]/Questionnaire/$extract</p><p>URL: [base]/Questionnaire/[id]/$extract</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>1..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></table><div><p>The QuestionnaireResponse must identify a QuestionnaireResponse 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>
  <url
       value="http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract"/>
  <version value="0.0.0"/>
  <name value="QuestionnaireResponseExtract"/>
  <title value="Questionnaire response extract to resource(s)"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2018-08-30T00:00:00+10:00"/>
  <publisher value="HL7 International - FHIR Infrastructure"/>
  <description
               value="The Extract operation takes a completed QuestionnaireRespponse 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."/>
  <code value="extract"/>
  <comment
           value="The QuestionnaireResponse must identify a QuestionnaireResponse instance containing appropriate metadata to allow extraction.  (Refer to the [Data Extraction](extraction.html) page for more details."/>
  <resource value="Questionnaire"/>
  <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="1"/>
    <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>
</OperationDefinition>