Da Vinci - Member Attribution (ATR) List
2.1.0-preview - STU 2.0.0 United States of America flag

Da Vinci - Member Attribution (ATR) List, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-atr/ and changes regularly. See the Directory of published versions

: DaVinci Data Export - XML Representation

Active as of 2021-07-22

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="davinci-data-export"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition davinci-data-export</b></p><a name="davinci-data-export"> </a><a name="hcdavinci-data-export"> </a><a name="davinci-data-export-en-US"> </a><p>URL: [base]/Group/[id]/$davinci-data-export</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>patient</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>The Members whose data has to be exported, when omitted the data about all members in the Group should  be exported. The references are      pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group.     For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.</p>
</div></td></tr><tr><td>IN</td><td>exportType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export,      and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.</p>
</div></td></tr><tr><td>IN</td><td>_since</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td/><td><div><p>Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation.</p>
</div></td></tr><tr><td>IN</td><td>_until</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#instant">instant</a></td><td/><td><div><p>Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started.      This is a new parameter added to the operation that is not present in the Bulk Data Export operation.</p>
</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation.</p>
</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fm"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export"/>
  <version value="2.1.0-preview"/>
  <name value="DaVinciDataExport"/>
  <title value="DaVinci Data Export"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2021-07-22T21:48:56+10:00"/>
  <publisher value="HL7 International / Financial Management"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fm"/>
    </telecom>
  </contact>
  <description value="Exports data about members of the Group"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <code value="davinci-data-export"/>
  <base
        value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"/>
  <resource value="Group"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="The Members whose data has to be exported, when omitted the data about all members in the Group should  be exported. The references are      pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group.     For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="exportType"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export,      and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="_since"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation."/>
    <type value="instant"/>
  </parameter>
  <parameter>
    <name value="_until"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started.      This is a new parameter added to the operation that is not present in the Bulk Data Export operation."/>
    <type value="instant"/>
  </parameter>
  <parameter>
    <name value="_type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_typeFilter"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation."/>
    <type value="string"/>
  </parameter>
</OperationDefinition>