Da Vinci Postable Remittance
1.0.0-ballot - STU 1 Ballot United States of America flag

This page is part of the DaVinci Postable Remittance FHIR Implementation Guide (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: Postable Remittance Client Capabilities - XML Representation

Page standards status: Trial-use Maturity Level: 1

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="PostableRemittanceClientCapabilities"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement PostableRemittanceClientCapabilities</b></p><a name="PostableRemittanceClientCapabilities"> </a><a name="hcPostableRemittanceClientCapabilities"> </a><a name="PostableRemittanceClientCapabilities-en-US"> </a><h2 id="title">Postable Remittance Client Capabilities</h2><ul><li>Implementation Guide Version: 1.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Supported Patch Formats: </li><li>Published on: 2025-01-01 </li><li>Published by: HL7 International / Payer/Provider Information Exchange Work Group </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>client</code></h3></div><div class="panel-body"><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Parameters1-1">Parameters</a></td><td> </td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td><code>$PR Search By Patients Query</code>, <code>$PR Search By Claim Query</code>, <code>$PR Search By Payment Query</code>, <code>$PR Download Remittance</code></td></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Parameters1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Parameters</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/parameters.html">Parameters</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-SearchByPatient.html">$PR Search By Patients Query</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-SearchByClaim.html">$PR Search By Claim Query</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-SearchByPayment.html">$PR Search By Payment Query</a></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="OperationDefinition-DownloadRemittance.html">$PR Download Remittance</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="claims"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-pr/CapabilityStatement/PostableRemittanceClientCapabilities"/>
  <version value="1.0.0-ballot"/>
  <name value="PRClient"/>
  <title value="Postable Remittance Client Capabilities"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2025-01-01"/>
  <publisher
             value="HL7 International / Payer/Provider Information Exchange Work Group"/>
  <contact>
    <name
          value="HL7 International / Payer/Provider Information Exchange Work Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/claims"/>
    </telecom>
  </contact>
  <description
               value="Capabilities required for a client system making Postable Remittance queries."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <format value="xml"/>
  <rest>
    <mode value="client"/>
    <resource>
      <type value="Parameters"/>
      <operation>
        <name value="PR Search By Patients Query"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPatient"/>
      </operation>
      <operation>
        <name value="PR Search By Claim Query"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByClaim"/>
      </operation>
      <operation>
        <name value="PR Search By Payment Query"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment"/>
      </operation>
      <operation>
        <name value="PR Download Remittance"/>
        <definition
                    value="http://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance"/>
      </operation>
    </resource>
  </rest>
</CapabilityStatement>