PaymentNotice - FHIR Resource (r4)


This PaymentNotice Resource uses the FHIR API standard for access and structure.

Validate an PaymentNotice FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
amountfalseMoney# Monetary amount of the payment
createdfalsedateTime# Creation date
identifiertrueIdentifier# Business Identifier for the payment noctice
payeefalseReference# Party being paid
paymentfalseReference# Payment reference
paymentDatefalsedate# Payment or clearing date
paymentStatusfalseCodeableConcept# Issued or cleared Status of the payment
providerfalseReference# Responsible practitioner
recipientfalseReference# Party being notified
requestfalseReference# Request reference
responsefalseReference# Response reference
statusfalsecode# active | cancelled | draft | entered-in-error

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 ParameterField TypeResource Fields Searched
createddatecreated
identifiertextidentifier
payment-statustextpaymentStatus
providerreferenceprovider
requestreferencerequest
responsereferenceresponse
statustextstatus