2.7.0 - STU 3 (2nd ballot)

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)

Format(s):

Narrative view

QuestionnaireResponseExtract

OPERATION: QuestionnaireResponseExtract

The official URL for this operation definition is: 

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

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.

URL: [base]/Questionnaire/$extract

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INquestionnaire-response0..1Resource

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

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

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