FHIR Release 3 (STU) 4

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

Paymentreconciliation-example.json

Financial Management Work Group Maturity Level : N/A Ballot 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>"
  },
  "identifier": [
    {
      "system": "http://www.BenefitsInc.com/fhir/enrollmentresponse",
      "value": "781234"
    }
  ],
  "status": "active",
  "period": {
    "start": "2014-08-16",
    "end": "2014-08-31"
  },
  "created": "2014-08-16",
  "organization": {

  "paymentIssuer": {

    "reference": "Organization/2"
  },
  "request": {
    "reference": "http://www.BenefitsInc.com/fhir/eligibility/225476332402"
  },
  "outcome": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/remittance-outcome",
        "code": "complete"
      }
    ]

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

  },
  "outcome": "complete",

  "disposition": "2014 August mid-month settlement.",
  "requestProvider": {
    "reference": "Practitioner/example"

  "paymentDate": "2014-08-01",
  "paymentAmount": {
    "value": 7000.00,
    "currency": "USD"

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

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

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

      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/payment-type",

            "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"
        }
      },
      "submitter": {
        "reference": "Organization/1"
      },

      "date": "2014-08-16",

      "payee": {
        "reference": "Organization/1"
      },
      "date": "2014-08-16",

      "amount": {
        "value": 1000.00,
        "system": "urn:iso:std:iso:4217",
        "code": "USD"

        "value": 3500.00,
        "currency": "USD"

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

      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/payment-type",

            "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,
        "system": "urn:iso:std:iso:4217",
        "code": "USD"

        "currency": "USD"

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

      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/payment-type",

            "system": "http://terminology.hl7.org/CodeSystem/payment-type",

            "code": "advance"
          }
        ]
      },
      "date": "2014-08-16",
      "amount": {
        "value": -1500.00,
        "system": "urn:iso:std:iso:4217",
        "code": "USD"

        "currency": "USD"

      }
    }
  ],
  "form": {

  "formCode": {

    "coding": [
      {
        "system": "http://ncforms.org/formid",
        "code": "PAYREC/2016/01B"
      }
    ]
  },
  "total": {
    "value": 3500.00,
    "system": "urn:iso:std:iso:4217",
    "code": "USD"
  },

  "processNote": [
    {
      "type": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/note-type",
            "code": "display"
          }
        ]
      },

      "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.