$extract

Questionnaire response extract to resource(s)

activeStructured Data Capture4.0.0operation2 inputs2 outputs

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.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract
Code
$extract
Kind
operation
Affects State
No
Publisher
HL7 International / FHIR Infrastructure

Invocation Context

Can be invoked at:
Type LevelInstance Level
Target Resources:

Implementation Notes

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

Input Parameters (2)

NameTypeCard.Description
questionnaire-responseQuestionnaireResponse0..1The QuestionnaireResponse to extract data from. Used when the operation is invoked at the 'type' level.
questionnaireQuestionnaire0..1The Questionnaire associated with the QuestionnaireResponse. Used if the server might not have access to the Questionnaire

Output Parameters (2)

NameTypeCard.Description
returnResource0..1The 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.
issuesOperationOutcome0..1A 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.

Additional Information

Version
4.0.0
Date
2018-08-30