Structured Data Capture 2.5.0 - Edition 3(STU), For Comment 2018Sep Ballot

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)

Format(s):

Narrative view

QuestionnaireExtract

OPERATION: QuestionnaireExtract

The official URL for this operation definition is: 

http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-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 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.

URL: [base]/Questionnaire/$extract

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

Parameters

UseNameCardinalityTypeBindingDocumentation
INquestionnaire-response1..1Resource

The QuestionnaireResponse to extract data from. The QuestionnaireResponse must either reference a Questionnaire that complies with a the Questionnaire Extract Profile 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.

OUTreturn1..1Resource

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.

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.