Da Vinci Postable Remittance
1.0.0 - STU 1

Da Vinci Postable Remittance, published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pr/ and changes regularly. See the Directory of published versions

## : Search for Postable Remittance By Payment - XML Representation

Page standards status: Trial-use | Maturity Level: 1

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="SearchByPayment"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition SearchByPayment</b></p><a name="SearchByPayment"> </a><a name="hcSearchByPayment"> </a><a name="SearchByPayment-en-US"> </a><p>URL: [base]/$searchByPayment</p><p>Input parameters Profile:<a href="StructureDefinition-searchByPaymentParameters.html">Search By Payment Incoming Parameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-searchByPaymentResultParameters.html">Search By Payment Result Outgoing Parameters</a></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>TIN</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Medical Group / Billing Provider / Payee TIN</p>
    </div></td></tr><tr><td>IN</td><td>PayerID</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payer Identifer</p>
    </div></td></tr><tr><td>IN</td><td>PayerName</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payer Name</p>
    </div></td></tr><tr><td>IN</td><td>ServiceStartDate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>Start Date of Service</p>
    </div></td></tr><tr><td>IN</td><td>ServiceEndDate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>End Date of Service</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo</td><td/><td>1..1</td><td></td><td/><td><div><p>Information about the payment being searched for.</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentIssueDate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Period">Period</a></td><td/><td><div><p>Payment Issue Date</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange</td><td/><td>0..1</td><td></td><td/><td><div><p>Payment Amount Range</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange.PaymentAmountLow</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Money">Money</a></td><td/><td><div><p>Payment Number Low</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentAmountRange.PaymentAmountHigh</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Money">Money</a></td><td/><td><div><p>Payment Number High</p>
    </div></td></tr><tr><td>IN</td><td>PaymentInfo.PaymentNumber</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payment Number - EFT/Cheque/Unique Remit Number</p>
    </div></td></tr><tr><td>OUT</td><td>TIN</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Medical Group / Billing Provider / Payee TIN</p>
    </div></td></tr><tr><td>OUT</td><td>Payer</td><td/><td>1..1</td><td></td><td/><td><div><p>Details of payer information.</p>
    </div></td></tr><tr><td>OUT</td><td>Payer.PayerID</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payer Identifier</p>
    </div></td></tr><tr><td>OUT</td><td>Payer.PayerName</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payer Name</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo</td><td/><td>1..*</td><td></td><td/><td><div><p>Details of adjudicated payment.</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentDate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>Payment Date</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentNumber</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Payment Number</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.PaymentAmount</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Money">Money</a></td><td/><td><div><p>Payment Amount</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance</td><td/><td>1..*</td><td></td><td/><td><div><p>Details of remittance advice.</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceIdentifier</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Remittance Advice Identifier</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceType</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-RemittanceAdviceType.html">Remittance Advice Value Set</a> (Required)</td><td><div><p>Remittance Advice Type</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceDate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>Remittance Advice Date</p>
    </div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance.RemittanceAdviceFileSize</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Remittance Advice File Size</p>
    </div></td></tr></table></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/OperationDefinition/SearchByPayment"/>
      <version value="1.0.0"/>
      <name value="SearchByPayment"/>
      <title value="Search for Postable Remittance By Payment"/>
      <status value="active"/>
      <kind value="operation"/>
      <date value="2025-04-07T20:24:22+00:00"/>
      <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="This operation is used to search for a postable remittance by providing payment information."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="United States of America"/>
        </coding>
      </jurisdiction>
      <code value="searchByPayment"/>
      <system value="true"/>
      <type value="false"/>
      <instance value="false"/>
      <inputProfile
                    value="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters"/>
      <outputProfile
                     value="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters"/>
      <parameter>
        <name value="TIN"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="Medical Group / Billing Provider / Payee TIN"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="PayerID"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="Payer Identifer"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="PayerName"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="Payer Name"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="ServiceStartDate"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="Start Date of Service"/>
        <type value="date"/>
      </parameter>
      <parameter>
        <name value="ServiceEndDate"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="End Date of Service"/>
        <type value="date"/>
      </parameter>
      <parameter>
        <name value="PaymentInfo"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="Information about the payment being searched for."/>
        <part>
          <name value="PaymentIssueDate"/>
          <use value="in"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payment Issue Date"/>
          <type value="Period"/>
        </part>
        <part>
          <name value="PaymentAmountRange"/>
          <use value="in"/>
          <min value="0"/>
          <max value="1"/>
          <documentation value="Payment Amount Range"/>
          <part>
            <name value="PaymentAmountLow"/>
            <use value="in"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Payment Number Low"/>
            <type value="Money"/>
          </part>
          <part>
            <name value="PaymentAmountHigh"/>
            <use value="in"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Payment Number High"/>
            <type value="Money"/>
          </part>
        </part>
        <part>
          <name value="PaymentNumber"/>
          <use value="in"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payment Number - EFT/Cheque/Unique Remit Number"/>
          <type value="string"/>
        </part>
      </parameter>
      <parameter>
        <name value="TIN"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="Medical Group / Billing Provider / Payee TIN"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="Payer"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="Details of payer information."/>
        <part>
          <name value="PayerID"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payer Identifier"/>
          <type value="string"/>
        </part>
        <part>
          <name value="PayerName"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payer Name"/>
          <type value="string"/>
        </part>
      </parameter>
      <parameter>
        <name value="PaymentInfo"/>
        <use value="out"/>
        <min value="1"/>
        <max value="*"/>
        <documentation value="Details of adjudicated payment."/>
        <part>
          <name value="PaymentDate"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payment Date"/>
          <type value="date"/>
        </part>
        <part>
          <name value="PaymentNumber"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payment Number"/>
          <type value="string"/>
        </part>
        <part>
          <name value="PaymentAmount"/>
          <use value="out"/>
          <min value="1"/>
          <max value="1"/>
          <documentation value="Payment Amount"/>
          <type value="Money"/>
        </part>
        <part>
          <name value="Remittance"/>
          <use value="out"/>
          <min value="1"/>
          <max value="*"/>
          <documentation value="Details of remittance advice."/>
          <part>
            <name value="RemittanceAdviceIdentifier"/>
            <use value="out"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Remittance Advice Identifier"/>
            <type value="string"/>
          </part>
          <part>
            <name value="RemittanceAdviceType"/>
            <use value="out"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Remittance Advice Type"/>
            <type value="code"/>
            <binding>
              <strength value="required"/>
              <valueSet
                        value="http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"/>
            </binding>
          </part>
          <part>
            <name value="RemittanceAdviceDate"/>
            <use value="out"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Remittance Advice Date"/>
            <type value="date"/>
          </part>
          <part>
            <name value="RemittanceAdviceFileSize"/>
            <use value="out"/>
            <min value="1"/>
            <max value="1"/>
            <documentation value="Remittance Advice File Size"/>
            <type value="integer"/>
          </part>
        </part>
      </parameter>
    </OperationDefinition>