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

OperationDefinition: Questionnaire response extract to resource(s)

Official URL: http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract Version: 3.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SDCQuestionnaireResponseExtract

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.

SDCQuestionnaireResponseExtract

OPERATION: SDCQuestionnaireResponseExtract

The official URL for this operation definition is: 

http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract

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.

URL: [base]/QuestionnaireResponse/$extract

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

Input parameters Profile: Questionnaire response extract operation input parameters

Parameters

UseNameCardinalityTypeBindingDocumentation
INquestionnaire-response0..1Resource

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

OUTreturn0..1Resource

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.

OUTissues0..1OperationOutcome

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.)