Da Vinci - Member Attribution (ATR) List
1.0.0 - STU 1 Publication

This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: DaVinci ATR Producer - XML Representation

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="atr-producer"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>AtrProducer</h2>
      <p>(Requirements Definition Capability Statement)</p>
      <p>Canonical URL: http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-producer</p>
      <p>Published by: <b>HL7 International - Financial Management</b>
      </p>
      <p>This profile defines the expected capabilities of the <i>DaVinci ATR Producer </i> actor.  
      This actor is responsible for producing the member attribution list for Risk Based Contracts. 
      Typically Payers are the producers of the member attribution list and Provider organization are consumers.</p>
      <h2>General</h2>
      <div class="table-wrapper">
        <table>
          <tbody>
            <tr>
              <th>FHIR Version:</th>
              <td>4.0.1</td>
            </tr>
            <tr>
              <th>Supported formats:</th>
              <td>json</td>
            </tr>
          </tbody>
        </table>
      </div>
      <h2>REST  behavior</h2>
      <p>The primary focus of the Producer is to create the member attribution list and publish the member attribution list so that Consumers can download the member attribution list which is necessary for the implementation of other DaVinci use cases.</p>
      <p>
        <b>Security:</b>
      </p>
      <p>Implementations must meet the general security requirements documented in FHIR <a href="http://hl7.org/fhir/security.html">Security guidance</a>.</p>
      <p>In addition the Producer needs to meet the security requirements as outlined in the <a href="spec.html#smart-on-fhir-backend-services-authorization">Formal Specification - Security Section.</a></p>
      <h3>Resource summary</h3>
      <div class="table-wrapper">
        <table class="grid">
          <thead>
            <tr>
              <th>Resource</th>
              <th>Search</th>
              <th>Read</th>
              <th>Read Version</th>
              <th>Instance History</th>
              <th>Resource History</th>
              <th>Create</th>
              <th>Update</th>
              <th>Delete</th>
            </tr>
          </thead>
          <tbody>
           <tr>
              <th>Coverage (<a href="StructureDefinition-atr-coverage.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#Coverage-read" title="Allows retrieval of a specific Coverage Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
            <tr>
              <th>Group (<a href="StructureDefinition-atr-group.html">Profile</a>)</th>
              <td>
                <a href="#Group-search-type" title="Allows a user to search for existing Groups">SHALL</a>
              </td>
              <td>
                <a href="#Group-read" title="Allows retrieval of a specific Group">SHALL</a>
              </td>
              <td>
                <a href="#Group-vread" title="Allows retrieval of a specific version of a Group">SHOULD</a>
              </td>
              <td>
                <a href="#Group-history-instance" title="Allows review of changes to a Group over time">SHOULD</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>  
            <tr>
              <th>Location (<a href="StructureDefinition-atr-location.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#Location-read" title="Allows retrieval of a specific Location Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>  
            <tr>
              <th>Organization (<a href="StructureDefinition-atr-organization.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#Organization-read" title="Allows retrieval of a specific Organization Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>    
            <tr>
            <th>Patient (<a href="StructureDefinition-atr-patient.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#Patient-read" title="Allows retrieval of a specific Patient Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
            <tr>
            <th>Practitioner (<a href="StructureDefinition-atr-practitioner.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#Practitioner-read" title="Allows retrieval of a specific Practitioner Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
            <tr>
            <th>PractitionerRole (<a href="StructureDefinition-atr-practitionerrole.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#PractitionerRole-read" title="Allows retrieval of a specific PractitionerRole Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
            <tr>
            <th>RelatedPerson (<a href="StructureDefinition-atr-relatedperson.html">Profile</a>)</th>
              <td/>
              <td>
                <a href="#RelatedPerson-read" title="Allows retrieval of a specific RelatedPerson Resource">SHALL</a>
              </td>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
              <td/>
            </tr>
          </tbody>
        </table>
      </div>
      
        <h3>FHIR Operations summary</h3>
        <p>The following FHIR operations SHALL be supported by the Producer.</p>
      
      <ul>
        <li>
          <a href="http://hl7.org/fhir/uv/bulkdata/OperationDefinition-group-export.html">Group Export</a>
        </li>
      </ul>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/coverage.html">Coverage</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-coverage.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Coverage-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known Coverage Resource</p>
              </td>
            </tr>    
          </tbody>
        </table>
      </div>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/group.html">Group</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-group.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Group-search-type"> </a>
                <span>search-type</span>
              </th>
              <td>
                <p>Allows discovery of existing Groups corresponding to a Consumer using their own TAX and NPI Identifiers.</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Group-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific Group resource.</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Group-vread"> </a>
                <span>vread</span>
              </th>
              <td>
                <p>Allows retrieval of a historical version of a Group resource.</p>
              </td>
            </tr>
            <tr>
              <th>
                <a name="Group-history-instance"> </a>
                <span>history-instance</span>
              </th>
              <td>
                <p>Allows review of changes to a Group over time</p>
              </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4>Search</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Parameter</th>
              <th>Type</th>
              <th>Definition &amp; Chaining</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>identifier</th>
              <td>token</td>
              <td>Search using identifiers which can be Consumer NPI, Consumer TIN, Settlement Entity Identifier, Contract Identifier. Combinations of AND/OR logic for the different identifiers are allowed according to the FHIR specification.</td>
            </tr>
            <tr>
              <th>name</th>
              <td>string</td>
              <td>Search using Group name.</td>
            </tr>
            <tr>
              <th>period</th>
              <td>date</td>
              <td>Search using contract validity period.</td>
            </tr>
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/location.html">Location</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-location.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-location</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Location-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known Location Resource</p>
              </td>
            </tr>
                 
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/organization.html">Organization</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-organization.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-organization</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Organization-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known Organization Resource</p>
              </td>
            </tr>
             
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/patient.html">Patient</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-patient.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Patient-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known Patient Resource</p>
              </td>
            </tr>
              
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-practitioner.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="Practitioner-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known Practitioner Resource</p>
              </td>
            </tr>
              
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/practitionerrole.html">PractitionerRole</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-practitionerrole.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitionerrole</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="PractitionerRole-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known PractitionerRole Resource</p>
              </td>
            </tr>
               
          </tbody>
        </table>
      </div>
      
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/R4/relatedperson.html">RelatedPerson</a>
      </h3>
      <p>Profile: <a href="StructureDefinition-atr-relatedperson.html">http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-relatedperson</a>
      </p>
      <h4>Interactions</h4>
      <div class="table-wrapper">
        <table class="list">
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>
                <a name="RelatedPerson-read"> </a>
                <span>read</span>
              </th>
              <td>
                <p>Allows retrieval of a specific known RelatedPerson Resource</p>
              </td>
            </tr>
             
          </tbody>
        </table>
      </div>
      
    </div>
  </text>
  <url
       value="http://hl7.org/fhir/us/davinci-atr/CapabilityStatement/atr-producer"/>
  <version value="1.0.0"/>
  <name value="DaVinciAtrProducer"/>
  <title value="DaVinci ATR Producer"/>
  <status value="draft"/>
  <date value="2014-07-06"/>
  <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="This profile defines the expected capabilities of the &#39;&#39;Producer&#39;&#39; role when conforming to the DaVinci Risk Based Contracts Member Attribution List Implementation Guide.     This role is responsible for creating and publishing the Member Attribution List for usage by Consumers based on specific Risk Based Contracts."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The focus of the Producer is to create the Member Attribution List and publish it using FHIR APIs for usage by Consumers. Typically Payers are Producers and Provider Organizations/ACOs/HIEs etc act as Consumers. "/>
    <security>
      <description
                   value="Implementations must meet the general security requirements documented in the security section of the implementation guide."/>
    </security>
    <resource>
      <type value="Coverage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-coverage"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific Coverage Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Coverage Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="Group"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation value="Allows discovery of existing Groups."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific Group Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation
                       value="Allows retrieval of a historical version of a Group Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Group Resource over time"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Group-identifier"/>
        <type value="token"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Location"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-location"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific Location Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Location Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="Organization"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-organization"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific Organization Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Organization Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="Patient"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation value="Allows retrieval of a specific Patient Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Patient Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="Practitioner"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific Practitioner Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a Practitioner Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="PractitionerRole"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitionerrole"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific PractitionerRole Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a PractitionerRole Instance over time"/>
      </interaction>
    </resource>
    <resource>
      <type value="RelatedPerson"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-relatedperson"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific RelatedPerson Resource"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a RelatedPerson Instance over time"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>