<status value="active"/> <kind value="operation"/> <date value="2018-08-30"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <name value="HL7 International / FHIR Infrastructure"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.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"/> <display value="World"/> </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 'type' level."/> <type value="QuestionnaireResponse"/> </parameter> <parameter> <name value="questionnaire"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The Questionnaire associated with the QuestionnaireResponse. Used if the server might not have access to the Questionnaire"/> <type value="Questionnaire"/> </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 '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."/> <type value="OperationOutcome"/> </parameter> </OperationDefinition>

Generated Narrative: OperationDefinition QuestionnaireResponse-extract

URL: [base]/QuestionnaireResponse/$extract

URL: [base]/QuestionnaireResponse/[id]/$extract

Input parameters Profile:Questionnaire extract operation input parameters

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

questionnaire-response

0..1

QuestionnaireResponse

The QuestionnaireResponse to extract data from. Used when the operation is invoked at the 'type' level.

questionnaire

0..1

Questionnaire

The Questionnaire associated with the QuestionnaireResponse. Used if the server might not have access to the Questionnaire

OUT

return

0..1

Resource

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.

OUT

issues

0..1

OperationOutcome

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.

The QuestionnaireResponse must identify a Questionnaire instance containing appropriate metadata to allow extraction. (Refer to the Data Extraction page for more details.)