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

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<OperationDefinition/daf-extract> a fhir:OperationDefinition;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "daf-extract"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table><div><p>Pilots underway in PCORNet</p>\n</div></div>"
  ];
  fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/us/daf-research/OperationDefinition/daf-extract"];
  fhir:OperationDefinition.name [ fhir:value "Extract Data"];
  fhir:OperationDefinition.status [ fhir:value "draft"];
  fhir:OperationDefinition.kind [ fhir:value "operation"];
  fhir:OperationDefinition.date [ fhir:value "2016-07-24"^^xsd:date];
  fhir:OperationDefinition.description [ fhir:value "Enable data extraction from Clinical Data Sources (e.g EMRs) for Research Purposes"];
  fhir:OperationDefinition.code [ fhir:value "extract-operation"];
  fhir:OperationDefinition.comment [ fhir:value "Pilots underway in PCORNet"];
  fhir:OperationDefinition.base [
     fhir:Reference.reference [ fhir:value "OperationDefinition/daf-extract-operation" ]
  ];
  fhir:OperationDefinition.system [ fhir:value "true"^^xsd:boolean];
  fhir:OperationDefinition.type [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.instance [ fhir:value "false"^^xsd:boolean];
  fhir:OperationDefinition.parameter [
     fhir:index 0;
     fhir:OperationDefinition.parameter.name [ fhir:value "timereference" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "1"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir: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." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "dateTime" ]
  ], [
     fhir:index 1;
     fhir:OperationDefinition.parameter.name [ fhir:value "patient" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "in" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir: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." ];
     fhir:OperationDefinition.parameter.type [ fhir:value "Reference" ]
  ], [
     fhir:index 2;
     fhir:OperationDefinition.parameter.name [ fhir:value "return" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir: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. " ];
     fhir:OperationDefinition.parameter.type [ fhir:value "Bundle" ]
  ], [
     fhir:index 3;
     fhir:OperationDefinition.parameter.name [ fhir:value "issues" ];
     fhir:OperationDefinition.parameter.use [ fhir:value "out" ];
     fhir:OperationDefinition.parameter.min [ fhir:value "0"^^xsd:int ];
     fhir:OperationDefinition.parameter.max [ fhir:value "1" ];
     fhir:OperationDefinition.parameter.documentation [ fhir: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. " ];
     fhir:OperationDefinition.parameter.type [ fhir:value "OperationOutcome" ]
  ].