DAF Research, Release 1 Ballot

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

Extract Data


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="daf-extract"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>Extract Data</h2><p>OPERATION: Extract Data</p><div><p>Enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes</p>
</div><p>URL: [base]/$extract-operation</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>timereference</td><td>1..1</td><td>dateTime</td><td/><td><div><p>This is the reference time based on which the extraction program will retrieve data for only those patients whose records have been created/updated after the reference time.</p>
</div></td></tr><tr><td>IN</td><td>patient</td><td>0..1</td><td>Reference</td><td/><td><div><p>When a Patient is specified, the extraction program needs to only extract the data for a specific patient.If not specified, the extraction program will evaluate all consented patient records based on the reference time to identify the ones that have changed and need to be extracted.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td>Bundle</td><td/><td><div><p>The results of the extraction would provide the data for each patient whose data has been created/updated based on the referenceTime. This data will be in the form of a Bundle which has all the resources that are pertinent for each patient whose data has been extracted.</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 extracting the data. These might be show to the user as an advisory note. Note: if the extraction 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-extract"/>
  <name value="Extract Data"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-07-24"/>
  <description
               value="Enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes"/>
  <code value="extract-operation"/>
  <comment value="Pilots underway in PCORNet"/>
  <base>
    <reference value="OperationDefinition/daf-extract-operation"/>
  </base>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="timereference"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="This is the reference time based on which the extraction program will retrieve data for only those patients whose records have been created/updated after the reference time."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="When a Patient is specified, the extraction program needs to only extract the data for a specific patient.If not specified, the extraction program will evaluate all consented patient records based on the reference time to identify the ones that have changed and need to be extracted."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The results of the extraction would provide the data for each patient whose data has been created/updated based on the referenceTime. This data will be in the form of a Bundle which has all the resources that are pertinent for each patient whose data has been extracted. "/>
    <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 extracting the data. These might be show to the user as an advisory note. Note: if the extraction 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>