| Package | hl7.fhir.us.davinci-pr |
| Resource Type | OperationDefinition |
| Id | SearchByPayment |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-pr/https://build.fhir.org/ig/HL7/davinci-pr/OperationDefinition-SearchByPayment.html |
| URL | http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-04-07T20:24:22+00:00 |
| Name | SearchByPayment |
| Title | Search for Postable Remittance By Payment |
| Realm | us |
| Authority | hl7 |
| Description | This operation is used to search for a postable remittance by providing payment information. |
| Type | false |
| Kind | operation |
| CapabilityStatement | |
| PostableRemittanceClientCapabilities | Postable Remittance Client Capabilities |
| PostableRemittanceServerCapabilities | Postable Remittance Server Capabilities |
No resources found
Note: links and images are rebased to the (stated) source
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 | PayerID | 0..1 | string | Payer Identifer | ||
| IN | PayerName | 0..1 | string | Payer Name | ||
| IN | ServiceStartDate | 0..1 | date | Start Date of Service | ||
| IN | ServiceEndDate | 0..1 | date | End Date of Service | ||
| 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 | 1..1 | string | Medical Group / Billing Provider / Payee TIN | ||
| OUT | Payer | 1..1 | Details of payer information. | |||
| OUT | Payer.PayerID | 1..1 | string | Payer Identifier | ||
| OUT | Payer.PayerName | 1..1 | string | Payer Name | ||
| OUT | PaymentInfo | 1..* | 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 | 1..* | 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 |
FHIR{
"resourceType": "OperationDefinition",
"id": "SearchByPayment",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"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"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/SearchByPayment",
"version": "1.0.0",
"name": "SearchByPayment",
"title": "Search for Postable Remittance By Payment",
"status": "active",
"kind": "operation",
"date": "2025-04-07T20:24:22+00:00",
"publisher": "HL7 International / Payer/Provider Information Exchange Work Group",
"contact": [
{
"name": "HL7 International / Payer/Provider Information Exchange Work Group",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/claims"
}
]
}
],
"description": "This operation is used to search for a postable remittance by providing payment information.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"code": "searchByPayment",
"system": true,
"type": false,
"instance": false,
"inputProfile": "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters",
"outputProfile": "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentResultParameters",
"parameter": [
{
"name": "TIN",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Medical Group / Billing Provider / Payee TIN",
"type": "string"
},
{
"name": "PayerID",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Payer Identifer",
"type": "string"
},
{
"name": "PayerName",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Payer Name",
"type": "string"
},
{
"name": "ServiceStartDate",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Start Date of Service",
"type": "date"
},
{
"name": "ServiceEndDate",
"use": "in",
"min": 0,
"max": "1",
"documentation": "End Date of Service",
"type": "date"
},
{
"name": "PaymentInfo",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Information about the payment being searched for.",
"part": [
{
"name": "PaymentIssueDate",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Payment Issue Date",
"type": "Period"
},
{
"name": "PaymentAmountRange",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Payment Amount Range",
"part": [
{
"name": "PaymentAmountLow",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Payment Number Low",
"type": "Money"
},
{
"name": "PaymentAmountHigh",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Payment Number High",
"type": "Money"
}
]
},
{
"name": "PaymentNumber",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Payment Number - EFT/Cheque/Unique Remit Number",
"type": "string"
}
]
},
{
"name": "TIN",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Medical Group / Billing Provider / Payee TIN",
"type": "string"
},
{
"name": "Payer",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Details of payer information.",
"part": [
{
"name": "PayerID",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Payer Identifier",
"type": "string"
},
{
"name": "PayerName",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Payer Name",
"type": "string"
}
]
},
{
"name": "PaymentInfo",
"use": "out",
"min": 1,
"max": "*",
"documentation": "Details of adjudicated payment.",
"part": [
{
"name": "PaymentDate",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Payment Date",
"type": "date"
},
{
"name": "PaymentNumber",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Payment Number",
"type": "string"
},
{
"name": "PaymentAmount",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Payment Amount",
"type": "Money"
},
{
"name": "Remittance",
"use": "out",
"min": 1,
"max": "*",
"documentation": "Details of remittance advice.",
"part": [
{
"name": "RemittanceAdviceIdentifier",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Remittance Advice Identifier",
"type": "string"
},
{
"name": "RemittanceAdviceType",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Remittance Advice Type",
"type": "code",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"
}
},
{
"name": "RemittanceAdviceDate",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Remittance Advice Date",
"type": "date"
},
{
"name": "RemittanceAdviceFileSize",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Remittance Advice File Size",
"type": "integer"
}
]
}
]
}
]
}