DAF Research Implementation Guide v2.0.0 (STU2)

This page is part of the Data Access Framework (v2.0.0: STU 2) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

Example: OperationDefinition-daf-load

Formats: Narrative, XML, JSON, Turtle

Raw xml


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="daf-load"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Load Data</h2><p>OPERATION: Load Data</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-load</pre><div><p>The purpose of this operation is to enable loading of extracted data from data sources into data marts.   The extracted data will be de-identified and mapped from FHIR to the destination data model and then loaded into the data mart according to the local work flows. The work flow information is captured as part of the task which executes the load-data operation. Please refer to the Implementation Guidance for further information on how to use the task and load-data operation together for research work flows.</p>
</div><p>URL: [base]/$load-data</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>input</td><td>1..1</td><td>Bundle</td><td/><td><div><p>The Bundle resource that contains the extracted data from the extract-data operation is used as input to the load-data operation.</p>
</div></td></tr><tr><td>OUT</td><td>issues</td><td>0..1</td><td>OperationOutcome</td><td/><td><div><p>A list of hints and warnings about problems encountered while loading the data. These might be show to the user as an advisory note. Note: if the loading cannot be performed at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter.</p>
</div></td></tr></table><div><p>Pilots underway in PCORNet</p>
</div></div>
  </text>
  <url value="http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-load"/>
  <version value="1.0.0"/>
  <name value="Load Data"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-07-24"/>
  <description
               value="The purpose of this operation is to enable loading of extracted data from data sources into data marts.   The extracted data will be de-identified and mapped from FHIR to the destination data model and then loaded into the data mart according to the local work flows. The work flow information is captured as part of the task which executes the load-data operation. Please refer to the Implementation Guidance for further information on how to use the task and load-data operation together for research work flows."/>
  <code value="load-data"/>
  <comment value="Pilots underway in PCORNet"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="input"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The Bundle resource that contains the extracted data from the extract-data operation is used as input to the load-data operation."/>
    <type value="Bundle"/>
  </parameter>
  <parameter>
    <name value="issues"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A list of hints and warnings about problems encountered while loading the data. These might be show to the user as an advisory note. Note: if the loading cannot be performed at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>