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

{
  "resourceType" : "OperationDefinition",
  "id" : "daf-extract",
  "text" : {
    "status" : "generated",
    "div" : "<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>"
  },
  "url" : "http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-extract",
  "name" : "Extract Data",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2016-07-24",
  "description" : "Enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes",
  "code" : "extract-operation",
  "comment" : "Pilots underway in PCORNet",
  "base" : {
    "reference" : "OperationDefinition/daf-extract-operation"
  },
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "timereference",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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" : "dateTime"
    },
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "Bundle"
    },
    {
      "name" : "issues",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "OperationOutcome"
    }
  ]
}