PaymentNotice - FHIR Resource (r4)
This PaymentNotice Resource uses the FHIR API standard for access and structure.
Validate an PaymentNotice FHIR Resource (r4)
PaymentNotice Attributes
AttributeField is listTypeDescription
Description: Business Identifier for the payment noctice
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://benefitsinc.com/paymentnotice",
"value": "776543"
}
]Learn more about the (PaymentNotice) identifier FHIR attribute
Description: active | cancelled | draft | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (PaymentNotice) status FHIR attribute
Description: Request reference
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"request": {
"reference": "http://benefitsinc.com/fhir/claim/12345"
}Learn more about the (PaymentNotice) request FHIR attribute
Description: Response reference
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"response": {
"reference": "http://benefitsinc.com/fhir/claimresponse/CR12345"
}Learn more about the (PaymentNotice) response FHIR attribute
Description: Creation date
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"created": "2014-08-16"Learn more about the (PaymentNotice) created FHIR attribute
Description: Responsible practitioner
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"provider": {
"reference": "Organization/1"
}Learn more about the (PaymentNotice) provider FHIR attribute
Description: Payment reference
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"payment": {
"reference": "PaymentReconciliation/ER2500"
}Learn more about the (PaymentNotice) payment FHIR attribute
Description: Payment or clearing date
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"paymentDate": "2014-08-15"Learn more about the (PaymentNotice) paymentDate FHIR attribute
Description: Party being paid
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"payee": {
"reference": "Organization/1"
}Learn more about the (PaymentNotice) payee FHIR attribute
Description: Party being notified
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recipient": {
"identifier": {
"system": "http://regulators.gov",
"value": "AB123"
}
}Learn more about the (PaymentNotice) recipient FHIR attribute
Description: Monetary amount of the payment
FHIR Version: r4
Attribute Type : Money
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"amount": {
"value": 12500,
"currency": "USD"
}Learn more about the (PaymentNotice) amount FHIR attribute
Description: Issued or cleared Status of the payment
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"paymentStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/paymentstatus",
"code": "paid"
}
]
}Learn more about the (PaymentNotice) paymentStatus FHIR attribute
PaymentNotice Example
{
"resourceType": "PaymentNotice",
"id": "77654",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the PaymentNotice</div>"
},
"identifier": [
{
"system": "http://benefitsinc.com/paymentnotice",
"value": "776543"
}
],
"status": "active",
"request": {
"reference": "http://benefitsinc.com/fhir/claim/12345"
},
"response": {
"reference": "http://benefitsinc.com/fhir/claimresponse/CR12345"
},
"created": "2014-08-16",
"provider": {
"reference": "Organization/1"
},
"payment": {
"reference": "PaymentReconciliation/ER2500"
},
"paymentDate": "2014-08-15",
"payee": {
"reference": "Organization/1"
},
"recipient": {
"identifier": {
"system": "http://regulators.gov",
"value": "AB123"
}
},
"amount": {
"value": 12500,
"currency": "USD"
},
"paymentStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/paymentstatus",
"code": "paid"
}
]
}
}PaymentNotice Structure
{
"resourceType" : "PaymentNotice",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business Identifier for the payment noctice
"status" : "<code>", // R! active | cancelled | draft | entered-in-error
"request" : { Reference(Any) }, // Request reference
"response" : { Reference(Any) }, // Response reference
"created" : "<dateTime>", // R! Creation date
"provider" : { Reference(Practitioner|PractitionerRole|Organization) }, // Responsible practitioner
"payment" : { Reference(PaymentReconciliation) }, // R! Payment reference
"paymentDate" : "<date>", // Payment or clearing date
"payee" : { Reference(Practitioner|PractitionerRole|Organization) }, // Party being paid
"recipient" : { Reference(Organization) }, // R! Party being notified
"amount" : { Money }, // R! Monetary amount of the payment
"paymentStatus" : { CodeableConcept } // Issued or cleared Status of the payment
}
PaymentNotice Search Parameters
The following search parameters can be used to query PaymentNotice resources. Just submit them like so:
https://api.1up.health/fhir/r4/PaymentNotice?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
created | date | created |
identifier | text | identifier |
payment-status | text | paymentStatus |
provider | reference | provider |
request | reference | request |
response | reference | response |
status | text | status |
