FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.sdc
Resource TypeOperationDefinition
IdOperationDefinition-QuestionnaireResponse-extract.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/sdc/OperationDefinition-QuestionnaireResponse-extract.html
URLhttp://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract
Version4.0.0
Statusactive
Date2018-08-30
NameSDCQuestionnaireResponseExtract
TitleQuestionnaire response extract to resource(s)
Realmuv
Authorityhl7
DescriptionThe 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.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
MyFHIRClientCapabilityStatementMy FHIR Client Capability Statement
MyFHIRServerCapabilityStatementMy FHIR Server Capability Statement
sdc-form-fillerSDC Form Filler
sdc-form-receiverSDC Form Receiver
sdc-form-response-managerSDC Form Response Manager

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition QuestionnaireResponse-extract

URL: [base]/QuestionnaireResponse/$extract

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

Input parameters Profile:Questionnaire extract operation input parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INquestionnaire-response0..1QuestionnaireResponse

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

INquestionnaire0..1Questionnaire

The Questionnaire associated with the QuestionnaireResponse. Used if the server might not have access to the Questionnaire

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


Source1

{
  "resourceType": "OperationDefinition",
  "id": "QuestionnaireResponse-extract",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/sdc/OperationDefinition/QuestionnaireResponse-extract",
  "version": "4.0.0",
  "name": "SDCQuestionnaireResponseExtract",
  "title": "Questionnaire response extract to resource(s)",
  "status": "active",
  "kind": "operation",
  "date": "2018-08-30",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "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.  \r\n  The extracted resources might include Observations, MedicationStatements and other standard FHIR resources which can then be shared and manipulated.\r\n  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)\r\n  or, more problematic, might succeed but provide incorrect output.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "code": "extract",
  "comment": "The QuestionnaireResponse must identify a Questionnaire instance containing appropriate metadata to allow extraction.  (Refer to the [Data Extraction](extraction.html) page for more details.)",
  "resource": [
    "QuestionnaireResponse"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "inputProfile": "http://hl7.org/fhir/uv/sdc/StructureDefinition/parameters-questionnaireresponse-extract-in",
  "parameter": [
    {
      "name": "questionnaire-response",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The QuestionnaireResponse to extract data from.  Used when the operation is invoked at the 'type' level.",
      "type": "QuestionnaireResponse"
    },
    {
      "name": "questionnaire",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The Questionnaire associated with the QuestionnaireResponse.  Used if the server might not have access to the Questionnaire",
      "type": "Questionnaire"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "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.",
      "type": "Resource"
    },
    {
      "name": "issues",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "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.",
      "type": "OperationOutcome"
    }
  ]
}