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

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

(back to narrative)

Raw xml

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Questionnaire-extract"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>QuestionnaireExtract</h2><p>OPERATION: QuestionnaireExtract</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-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 Questionnaire is based on or that the operation is invoked 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>1..1</td><td><a href="http://hl7.org/fhir/2018Sep/resource.html">Resource</a></td><td/><td><div><p>The QuestionnaireResponse to extract data from.  The QuestionnaireResponse must either reference a Questionnaire that complies with a the <a href="sdc-questionnaire-extract.html">Questionnaire Extract Profile</a> or the operation must be invoked on a Questionnaire that complies with the profile.  This is necessary to ensure appropriate metadata is available to support extraction.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href="http://hl7.org/fhir/2018Sep/resource.html">Resource</a></td><td/><td><div><p>The resulting FHIR resource produced after extracting data.  This might be a single clinical administrative resource or could be a Transaction Bundle that contains multiple resources.</p>
</div></td></tr></table><div><p>If the operation is invoked on a Questionnaire instance rather than the Questionnaire type, the instance SHALL either have the same canonical URL as the <code>QuestionnaireResponse.questionnaire</code> element or must have a <code>Questionnaire.derivedFrom</code> element with that canonical URL.</p>
</div></div>
  </text>
  <url
       value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-extract"/>
  <version value="2.5.0"/>
  <name value="QuestionnaireExtract"/>
  <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"/>
  <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 Questionnaire is based on or that the operation is invoked 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="If the operation is invoked on a Questionnaire instance rather than the Questionnaire type, the instance SHALL either have the same canonical URL as the `QuestionnaireResponse.questionnaire` element or must have a `Questionnaire.derivedFrom` element with that canonical URL."/>
  <resource value="Questionnaire"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="questionnaire-response"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The QuestionnaireResponse to extract data from.  The QuestionnaireResponse must either reference a Questionnaire that complies with a the [Questionnaire Extract Profile](sdc-questionnaire-extract.html) or the operation must be invoked on a Questionnaire that complies with the profile.  This is necessary to ensure appropriate metadata is available to support extraction."/>
    <type value="Resource"/>
    <targetProfile
                   value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"/>
  </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 might be a single clinical administrative resource or could be a Transaction Bundle that contains multiple resources."/>
    <type value="Resource"/>
  </parameter>
</OperationDefinition>