API Reference

Update PaymentNotice with identifier {identifier}

PaymentNotice on the FHIR specification website.

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

The body should be a valid FHIR object for PaymentNotice.

Here is an 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"
      }
    ]
  }
}

You can reference the FHIR documentation to determine the format for PaymentNotice.

Language
Credentials
Click Try It! to start a request and see the response here!