{
  "description": "This operation is used to search for a postable remittance by providing payment information.",
  "_filename": "OperationDefinition-SearchByPayment.json",
  "package_name": "hl7.fhir.us.davinci-pr",
  "date": "2024-12-16T18:43:35+00:00",
  "system": true,
  "publisher": "HL7 International / Payer/Provider Information Exchange Work Group",
  "instance": false,
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166",
      "display": "United States of America"
    } ]
  } ],
  "name": "SearchByPayment",
  "type": "false",
  "experimental": null,
  "outputProfile": "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters",
  "resourceType": "OperationDefinition",
  "title": "Search for Postable Remittance By Payment",
  "package_version": "1.0.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "claims"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1,
    "_valueInteger": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
      } ]
    }
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
      } ]
    }
  } ],
  "status": "active",
  "id": "e292572e-cdc4-4418-afa4-969ba45fa632",
  "kind": "operation",
  "url": "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment",
  "code": "searchByPayment",
  "version": "1.0.0-ballot",
  "contact": [ {
    "name": "HL7 International / Payer/Provider Information Exchange Work Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/claims",
      "system": "url"
    } ]
  } ],
  "inputProfile": "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters",
  "parameter": [ {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "TIN",
    "type": "string",
    "documentation": "Medical Group / Billing Provider / Payee TIN"
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "DateOfService",
    "type": "Period",
    "documentation": "Date of Service"
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "PayerID",
    "type": "string",
    "documentation": "Payer Identifer"
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "PayerName",
    "type": "string",
    "documentation": "Payer Name"
  }, {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "PaymentInfo",
    "part": [ {
      "max": "1",
      "min": 1,
      "use": "in",
      "name": "PaymentIssueDate",
      "type": "Period",
      "documentation": "Payment Issue Date"
    }, {
      "max": "1",
      "min": 0,
      "use": "in",
      "name": "PaymentAmountRange",
      "part": [ {
        "max": "1",
        "min": 1,
        "use": "in",
        "name": "PaymentAmountLow",
        "type": "Money",
        "documentation": "Payment Number Low"
      }, {
        "max": "1",
        "min": 1,
        "use": "in",
        "name": "PaymentAmountHigh",
        "type": "Money",
        "documentation": "Payment Number High"
      } ],
      "documentation": "Payment Amount Range"
    }, {
      "max": "1",
      "min": 1,
      "use": "in",
      "name": "PaymentNumber",
      "type": "string",
      "documentation": "Payment Number - EFT/Cheque/Unique Remit Number"
    } ],
    "documentation": "Information about the payment being searched for."
  }, {
    "max": "1",
    "min": 0,
    "use": "out",
    "name": "TIN",
    "type": "string",
    "documentation": "Medical Group / Billing Provider / Payee TIN"
  }, {
    "max": "1",
    "min": 0,
    "use": "out",
    "name": "Payer",
    "part": [ {
      "max": "1",
      "min": 1,
      "use": "out",
      "name": "PayerID",
      "type": "string",
      "documentation": "Payer Identifier"
    }, {
      "max": "1",
      "min": 1,
      "use": "out",
      "name": "PayerName",
      "type": "string",
      "documentation": "Payer Name"
    } ],
    "documentation": "Details of payer information."
  }, {
    "max": "*",
    "min": 0,
    "use": "out",
    "name": "PaymentInfo",
    "part": [ {
      "max": "1",
      "min": 1,
      "use": "out",
      "name": "PaymentDate",
      "type": "date",
      "documentation": "Payment Date"
    }, {
      "max": "1",
      "min": 1,
      "use": "out",
      "name": "PaymentNumber",
      "type": "string",
      "documentation": "Payment Number"
    }, {
      "max": "1",
      "min": 1,
      "use": "out",
      "name": "PaymentAmount",
      "type": "Money",
      "documentation": "Payment Amount"
    }, {
      "max": "*",
      "min": 0,
      "use": "out",
      "name": "Remittance",
      "part": [ {
        "max": "1",
        "min": 1,
        "use": "out",
        "name": "RemittanceAdviceIdentifier",
        "type": "string",
        "documentation": "Remittance Advice Identifier"
      }, {
        "max": "1",
        "min": 1,
        "use": "out",
        "name": "RemittanceAdviceType",
        "type": "code",
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"
        },
        "documentation": "Remittance Advice Type"
      }, {
        "max": "1",
        "min": 1,
        "use": "out",
        "name": "RemittanceAdviceDate",
        "type": "date",
        "documentation": "Remittance Advice Date"
      }, {
        "max": "1",
        "min": 1,
        "use": "out",
        "name": "RemittanceAdviceFileSize",
        "type": "integer",
        "documentation": "Remittance Advice File Size"
      } ],
      "documentation": "Details of remittance advice."
    } ],
    "documentation": "Details of adjudicated payment."
  } ]
}