Example: OperationDefinition-daf-extract

Formats: Narrative, XML, JSON, Turtle

Raw xml

<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><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-extract</pre><div><p>The purpose of this operation is to enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes. 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 extract operation. Please refer to the Implementation Guidance for further information on how to use the task and extract operation together for research work flows.</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>Period</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 based on the reference time. If only start is provided as part of the Period, then all records created/updated after the start time are extracted. If both start and end are provided, then only those records which have been created/updated between the start and end times of the Period are extracted.</p>
</div></td></tr><tr><td>IN</td><td>group</td><td>0..1</td><td>Reference</td><td/><td><div><p>When a Group is specified, the extraction program needs to only extract the data for the patients that are part of the cohort group.Either the Group or an individual patient has to be specified for data extraction.</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.Either the Group or an individual patient has to be specified for data extraction.</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"/>
  <version value="1.0.0"/>
  <name value="Extract Data"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-07-24"/>
  <description
               value="The purpose of this operation is to enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes. 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 extract operation. Please refer to the Implementation Guidance for further information on how to use the task and extract operation together for research work flows."/>
  <code value="extract-operation"/>
  <comment value="Pilots underway in PCORNet"/>
  <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 based on the reference time. If only start is provided as part of the Period, then all records created/updated after the start time are extracted. If both start and end are provided, then only those records which have been created/updated between the start and end times of the Period are extracted."/>
    <type value="Period"/>
  </parameter>
  <parameter>
    <name value="group"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="When a Group is specified, the extraction program needs to only extract the data for the patients that are part of the cohort group.Either the Group or an individual patient has to be specified for data extraction."/>
    <type value="Reference"/>
  </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.Either the Group or an individual patient has to be specified for data extraction."/>
    <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>