| Source | hl7.fhir.uv.sdc.r4#3.0.0:Structured Data Capture (v4.0.1) |
| resourceType | OperationDefinition |
| id | QuestionnaireResponse-extract |
| canonical | http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract |
| version | 3.0.0 |
| status | draft |
| publisher | HL7 International - FHIR Infrastructure Work Group |
| name | SDCQuestionnaireResponseExtract |
| title | Questionnaire response extract to resource(s) |
| date | 2018-08-30 |
| description | 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. |
| jurisdictions | uv |
| code | extract |
| system | false |
| type | true |
| instance | true |
| resources | QuestionnaireResponse |
| Usages | (none) |
URL: [base]/QuestionnaireResponse/$extract
URL: [base]/QuestionnaireResponse/[id]/$extract
Input parameters Profile: Questionnaire response extract operation input parameters
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | questionnaire-response | 0..1 | Resource |
The QuestionnaireResponse to extract data from. Used when the operation is invoked at the 'type' level. |
||
| 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.)
Produced 06 Apr 2023