Da Vinci - Member Attribution (ATR) List
2.0.0-ballot - STU 2.0.0 US

This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v2.0.0-ballot: STU2 Release 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, 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="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Group/[id]/$davinci-data-export</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>memberReference</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 be exported. The references are      pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore the memberReference if it is not a valid reference.</p>
</div></td></tr><tr><td>IN</td><td>exportType</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.</p>
</div></td></tr><tr><td>IN</td><td>extractionPeriod</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Period">Period</a></td><td/><td><div><p>The period over which the data has to be exported. When omitted, the Server is free to export all data for the members.</p>
</div></td></tr><tr><td>IN</td><td>resourceTypes</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 similar to the _type parameter of the Bulk Data Export specification. This is a string of comma-delimited FHIR resource types.</p>
</div></td></tr><tr><td>IN</td><td>filterQueries</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 similar to the Bulk Data Export _typeFilter parameter. This is a string of comma delimited FHIR REST queries</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export"/>
  <version value="2.0.0-ballot"/>
  <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 Work Group"/>
  <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/us/davinci-atr/OperationDefinition/davinci-data-export"/>
  <resource value="Group"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="memberReference"/>
    <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 be exported. The references are      pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore the memberReference if it is not a valid reference."/>
    <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."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="extractionPeriod"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The period over which the data has to be exported. When omitted, the Server is free to export all data for the members."/>
    <type value="Period"/>
  </parameter>
  <parameter>
    <name value="resourceTypes"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The resources that need to be extracted for the patients. This is similar to the _type parameter of the Bulk Data Export specification. This is a string of comma-delimited FHIR resource types."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="filterQueries"/>
    <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 similar to the Bulk Data Export _typeFilter parameter. This is a string of comma delimited FHIR REST queries"/>
    <type value="string"/>
  </parameter>
</OperationDefinition>