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-ballot 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
Official URL: http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: SearchByPayment |
This operation is used to search for a postable remittance by providing payment information.
Generated Narrative: OperationDefinition SearchByPayment
URL: [base]/$searchByPayment
Input parameters Profile:Search By Payment Incoming Parameters
Output parameters Profile:Search By Payment Result Outgoing Parameters
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | TIN | 1..1 | string | Medical Group / Billing Provider / Payee TIN | ||
IN | DateOfService | 0..1 | Period | Date of Service | ||
IN | PayerID | 0..1 | string | Payer Identifer | ||
IN | PayerName | 0..1 | string | Payer Name | ||
IN | PaymentInfo | 1..1 | Information about the payment being searched for. | |||
IN | PaymentInfo.PaymentIssueDate | 1..1 | Period | Payment Issue Date | ||
IN | PaymentInfo.PaymentAmountRange | 0..1 | Payment Amount Range | |||
IN | PaymentInfo.PaymentAmountRange.PaymentAmountLow | 1..1 | Money | Payment Number Low | ||
IN | PaymentInfo.PaymentAmountRange.PaymentAmountHigh | 1..1 | Money | Payment Number High | ||
IN | PaymentInfo.PaymentNumber | 1..1 | string | Payment Number - EFT/Cheque/Unique Remit Number | ||
OUT | TIN | 0..1 | string | Medical Group / Billing Provider / Payee TIN | ||
OUT | Payer | 0..1 | Details of payer information. | |||
OUT | Payer.PayerID | 1..1 | string | Payer Identifier | ||
OUT | Payer.PayerName | 1..1 | string | Payer Name | ||
OUT | PaymentInfo | 0..* | Details of adjudicated payment. | |||
OUT | PaymentInfo.PaymentDate | 1..1 | date | Payment Date | ||
OUT | PaymentInfo.PaymentNumber | 1..1 | string | Payment Number | ||
OUT | PaymentInfo.PaymentAmount | 1..1 | Money | Payment Amount | ||
OUT | PaymentInfo.Remittance | 0..* | Details of remittance advice. | |||
OUT | PaymentInfo.Remittance.RemittanceAdviceIdentifier | 1..1 | string | Remittance Advice Identifier | ||
OUT | PaymentInfo.Remittance.RemittanceAdviceType | 1..1 | code | Remittance Advice Value Set (Required) | Remittance Advice Type | |
OUT | PaymentInfo.Remittance.RemittanceAdviceDate | 1..1 | date | Remittance Advice Date | ||
OUT | PaymentInfo.Remittance.RemittanceAdviceFileSize | 1..1 | integer | Remittance Advice File Size |