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

: Search for Postable Remittance By Payment - TTL Representation

Page standards status: Trial-use Maturity Level: 1

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "SearchByPayment"] ; # 
  fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div "<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>\n</div></td></tr><tr><td>IN</td><td>DateOfService</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td><div><p>Date of Service</p>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td>OUT</td><td>TIN</td><td/><td>0..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>\n</div></td></tr><tr><td>OUT</td><td>Payer</td><td/><td>0..1</td><td></td><td/><td><div><p>Details of payer information.</p>\n</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>\n</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>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo</td><td/><td>0..*</td><td></td><td/><td><div><p>Details of adjudicated payment.</p>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td>OUT</td><td>PaymentInfo.Remittance</td><td/><td>0..*</td><td></td><td/><td><div><p>Details of remittance advice.</p>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
  ] ; # 
  fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "claims" ]
  ] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
fhir:value [
fhir:v "1"^^xsd:integer ;
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
fhir:v "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr>         ]       ] )     ]
  ] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
fhir:value [
fhir:v "trial-use" ;
      ( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
fhir:v "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr>         ]       ] )     ]
  ] ) ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.0.0-ballot"] ; # 
  fhir:name [ fhir:v "SearchByPayment"] ; # 
  fhir:title [ fhir:v "Search for Postable Remittance By Payment"] ; # 
  fhir:status [ fhir:v "active"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:date [ fhir:v "2024-12-16T18:43:35+00:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "HL7 International / Payer/Provider Information Exchange Work Group"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "HL7 International / Payer/Provider Information Exchange Work Group" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/claims" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "This operation is used to search for a postable remittance by providing payment information."] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ]     ] )
  ] ) ; # 
  fhir:code [ fhir:v "searchByPayment"] ; # 
  fhir:system [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:type [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:instance [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:inputProfile [
fhir:v "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters>
  ] ; # 
  fhir:outputProfile [
fhir:v "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters>
  ] ; # 
  fhir:parameter ( [
fhir:name [ fhir:v "TIN" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Medical Group / Billing Provider / Payee TIN" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "DateOfService" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Date of Service" ] ;
fhir:type [ fhir:v "Period" ]
  ] [
fhir:name [ fhir:v "PayerID" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payer Identifer" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "PayerName" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payer Name" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "PaymentInfo" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Information about the payment being searched for." ] ;
    ( fhir:part [
fhir:name [ fhir:v "PaymentIssueDate" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Issue Date" ] ;
fhir:type [ fhir:v "Period" ]     ] [
fhir:name [ fhir:v "PaymentAmountRange" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Amount Range" ] ;
      ( fhir:part [
fhir:name [ fhir:v "PaymentAmountLow" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Number Low" ] ;
fhir:type [ fhir:v "Money" ]       ] [
fhir:name [ fhir:v "PaymentAmountHigh" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Number High" ] ;
fhir:type [ fhir:v "Money" ]       ] )     ] [
fhir:name [ fhir:v "PaymentNumber" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Number - EFT/Cheque/Unique Remit Number" ] ;
fhir:type [ fhir:v "string" ]     ] )
  ] [
fhir:name [ fhir:v "TIN" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Medical Group / Billing Provider / Payee TIN" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "Payer" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Details of payer information." ] ;
    ( fhir:part [
fhir:name [ fhir:v "PayerID" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payer Identifier" ] ;
fhir:type [ fhir:v "string" ]     ] [
fhir:name [ fhir:v "PayerName" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payer Name" ] ;
fhir:type [ fhir:v "string" ]     ] )
  ] [
fhir:name [ fhir:v "PaymentInfo" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Details of adjudicated payment." ] ;
    ( fhir:part [
fhir:name [ fhir:v "PaymentDate" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Date" ] ;
fhir:type [ fhir:v "date" ]     ] [
fhir:name [ fhir:v "PaymentNumber" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Number" ] ;
fhir:type [ fhir:v "string" ]     ] [
fhir:name [ fhir:v "PaymentAmount" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Payment Amount" ] ;
fhir:type [ fhir:v "Money" ]     ] [
fhir:name [ fhir:v "Remittance" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "Details of remittance advice." ] ;
      ( fhir:part [
fhir:name [ fhir:v "RemittanceAdviceIdentifier" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Remittance Advice Identifier" ] ;
fhir:type [ fhir:v "string" ]       ] [
fhir:name [ fhir:v "RemittanceAdviceType" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Remittance Advice Type" ] ;
fhir:type [ fhir:v "code" ] ;
fhir:binding [
fhir:strength [ fhir:v "required" ] ;
fhir:valueSet [
fhir:v "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType>           ]         ]       ] [
fhir:name [ fhir:v "RemittanceAdviceDate" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Remittance Advice Date" ] ;
fhir:type [ fhir:v "date" ]       ] [
fhir:name [ fhir:v "RemittanceAdviceFileSize" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Remittance Advice File Size" ] ;
fhir:type [ fhir:v "integer" ]       ] )     ] )
  ] ) . #