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

Claimresponse-example.json

Financial Management Work Group Maturity Level : N/A Ballot Standards Status : Informative Compartments : Patient , Practitioner

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

General Person Primary Coverage Example 

{
  "resourceType": "ClaimResponse",
  "id": "R3500",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the ClaimResponse</div>"
  },
  "identifier": [
    {
      "system": "http://www.BenefitsInc.com/fhir/remittance",
      "value": "R3500"
    }
  ],
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/claim-type",
        "code": "oral"
      }
    ]
  },
  "subType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/ex-claimsubtype",
        "code": "emergency"
      }
    ]
  },
  "use": "claim",

  "patient": {
    "reference": "Patient/1"
  },
  "created": "2014-08-16",
  "insurer": {
    "identifier": {
      "system": "http://www.jurisdiction.org/insurers",
      "value": "555123"
    }
  },
  "requestProvider": {
    "reference": "Practitioner/1"
  },
  "requestOrganization": {

  "requestor": {

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

  "outcome": "complete",

  "disposition": "Claim settled as per contract.",
  "payeeType": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/payeetype",

        "system": "http://terminology.hl7.org/CodeSystem/payeetype",

        "code": "provider"
      }
    ]
  },
  "item": [
    {
      "sequenceLinkId": 1,

      "itemSequence": 1,

      "adjudication": [
        {
          "category": {
            "coding": [
              {
                "code": "eligible"
              }
            ]
          },
          "amount": {
            "value": 135.57,
            "system": "urn:iso:std:iso:4217",
            "code": "USD"

            "currency": "USD"

          }
        },
        {
          "category": {
            "coding": [
              {
                "code": "copay"
              }
            ]
          },
          "amount": {
            "value": 10.00,
            "system": "urn:iso:std:iso:4217",
            "code": "USD"

            "currency": "USD"

          }
        },
        {
          "category": {
            "coding": [
              {
                "code": "eligpercent"
              }
            ]
          },
          "value": 80.00
        },
        {
          "category": {
            "coding": [
              {
                "code": "benefit"
              }
            ]
          },
          "reason": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/adjudication-reason",
                "code": "ar002",
                "display": "Plan Limit Reached"
              }
            ]
          },

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

            "value": 90.47,
            "currency": "USD"

          }
        }
      ]
    }
  ],
  "totalCost": {
    "value": 135.57,
    "system": "urn:iso:std:iso:4217",
    "code": "USD"
  },
  "totalBenefit": {
    "value": 100.47,
    "system": "urn:iso:std:iso:4217",
    "code": "USD"
  },

  "total": [
    {
      "category": {
        "coding": [
          {
            "code": "submitted"
          }
        ]
      },
      "amount": {
        "value": 135.57,
        "currency": "USD"
      }
    },
    {
      "category": {
        "coding": [
          {
            "code": "benefit"
          }
        ]
      },
      "amount": {
        "value": 90.47,
        "currency": "USD"
      }
    }
  ],

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

          "system": "http://terminology.hl7.org/CodeSystem/ex-paymenttype",

          "code": "complete"
        }
      ]
    },
    "date": "2014-08-31",
    "amount": {
      "value": 100.47,
      "system": "urn:iso:std:iso:4217",
      "code": "USD"

      "currency": "USD"

    },
    "identifier": {
      "system": "http://www.BenefitsInc.com/fhir/paymentidentifier",
      "value": "201408-2-1569478"
    }
  }
}

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.