Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Paymentreconciliation-example.json

Example PaymentReconciliation/ER2500 (JSON)

Maturity Level : N/A
Responsible Owner: Financial Management Work Group Standards Status : Informative Compartments : Practitioner

Raw JSON ( canonical form + also see JSON Format Specification )

General Payment Reconciliation Example

{
  "resourceType": "PaymentReconciliation",
  "id": "ER2500",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the PaymentReconciliation</div>"

  "resourceType" : "PaymentReconciliation",
  "id" : "ER2500",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the PaymentReconciliation</div>"

  },
  "identifier": [
    {
      "system": "http://www.BenefitsInc.com/fhir/enrollmentresponse",
      "value": "781234"
    }
  ],
  "status": "active",
  "period": {
    "start": "2014-08-16",
    "end": "2014-08-31"

  "identifier" : [{
    "system" : "http://www.BenefitsInc.com/fhir/enrollmentresponse",
    "value" : "781234"
  }],
  "type" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/payment-type",
      "code" : "payment"
    }]

  },
  "created": "2014-08-16",
  "paymentIssuer": {
    "reference": "Organization/2"

  "status" : "active",
  "period" : {
    "start" : "2014-08-16",
    "end" : "2014-08-31"

  },
  "request": {
    "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402"

  "created" : "2014-08-16",
  "paymentIssuer" : {
    "reference" : "Organization/2"

  },
  "requestor": {
    "reference": "Organization/1"

  "request" : {
    "reference" : "http://www.BenefitsInc.com/fhir/eligibility/225476332402"

  },
  "outcome": "complete",
  "disposition": "2014 August mid-month settlement.",
  "paymentDate": "2014-08-01",
  "paymentAmount": {
    "value": 7000.00,
    "currency": "USD"

  "requestor" : {
    "reference" : "Organization/1"

  },
  "paymentIdentifier": {
    "system": "http://www.BenefitsInc.com/payment/2018",
    "value": "10-12345"

  "outcome" : "complete",
  "disposition" : "2014 August mid-month settlement.",
  "date" : "2014-08-01",
  "amount" : {
    "value" : 7000.00,
    "currency" : "USD"

  },
  "detail": [
    {
      "identifier": {
        "system": "http://www.BenefitsInc.com/payment/2018/detail",
        "value": "10-12345-001"
      },
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/payment-type",
            "code": "payment"
          }
        ]
      },
      "request": {
        "identifier": {
          "system": "http://happyvalleyclinic.com/claim",
          "value": "AB12345"
        }
      },
      "submitter": {
        "reference": "Organization/1"
      },
      "response": {
        "identifier": {
          "system": "http://www.BenefitsInc.com/fhir/claimresponse",
          "value": "CR20140815-AB12345"
        }
      },
      "date": "2014-08-16",
      "payee": {
        "reference": "Organization/1"
      },
      "amount": {
        "value": 3500.00,
        "currency": "USD"
      }

  "paymentIdentifier" : {
    "system" : "http://www.BenefitsInc.com/payment/2018",
    "value" : "10-12345"
  },
  "allocation" : [{
    "identifier" : {
      "system" : "http://www.BenefitsInc.com/payment/2018/detail",
      "value" : "10-12345-001"

    },
    {
      "identifier": {
        "system": "http://www.BenefitsInc.com/payment/2018/detail",
        "value": "10-12345-002"
      },
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/payment-type",
            "code": "payment"
          }
        ]
      },
      "request": {
        "reference": "http://www.BenefitsInc.com/fhir/oralhealthclaim/225476332699"
      },
      "date": "2014-08-12",
      "amount": {
        "value": 4000.00,
        "currency": "USD"

    "target" : {
      "identifier" : {
        "system" : "http://happyvalleyclinic.com/claim",
        "value" : "AB12345"

      }
    },
    {
      "identifier": {
        "system": "http://www.BenefitsInc.com/payment/2018/detail",
        "value": "10-12345-003"
      },
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/payment-type",
            "code": "advance"
          }
        ]
      },
      "date": "2014-08-16",
      "amount": {
        "value": -1500.00,
        "currency": "USD"

    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/payment-type",
        "code" : "payment"
      }]
    },
    "submitter" : {
      "reference" : "Organization/1"
    },
    "response" : {
      "identifier" : {
        "system" : "http://www.BenefitsInc.com/fhir/claimresponse",
        "value" : "CR20140815-AB12345"

      }
    },
    "date" : "2014-08-16",
    "payee" : {
      "reference" : "Organization/1"
    },
    "amount" : {
      "value" : 3500.00,
      "currency" : "USD"

    }
  ],
  "formCode": {
    "coding": [
      {
        "system": "http://ncforms.org/formid",
        "code": "PAYREC/2016/01B"
      }
    ]

  },
  "processNote": [
    {
      "type": "display",
      "text": "Due to the year end holiday the cutoff for submissions for December will be the 28th."

  {
    "identifier" : {
      "system" : "http://www.BenefitsInc.com/payment/2018/detail",
      "value" : "10-12345-002"
    },
    "target" : {
      "reference" : "http://www.BenefitsInc.com/fhir/oralhealthclaim/225476332699"
    },
    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/payment-type",
        "code" : "payment"
      }]
    },
    "date" : "2014-08-12",
    "amount" : {
      "value" : 4000.00,
      "currency" : "USD"

    }
  ]

  },
  {
    "identifier" : {
      "system" : "http://www.BenefitsInc.com/payment/2018/detail",
      "value" : "10-12345-003"
    },
    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/payment-type",
        "code" : "advance"
      }]
    },
    "date" : "2014-08-16",
    "amount" : {
      "value" : -1500.00,
      "currency" : "USD"
    }
  }],
  "formCode" : {
    "coding" : [{
      "system" : "http://ncforms.org/formid",
      "code" : "PAYREC/2016/01B"
    }]
  },
  "processNote" : [{
    "type" : "display",
    "text" : "Due to the year end holiday the cutoff for submissions for December will be the 28th."
  }]

}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.