FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Claimresponse-example.json

Example ClaimResponse/R3500 (JSON)

Maturity Level : N/A
Responsible Owner: Financial Management Work Group Ballot Standards Status : Informative Compartments : Group , 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>"

  "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",
  "patient": {
    "reference": "Patient/1"

  "identifier" : [{
    "system" : "http://www.BenefitsInc.com/fhir/remittance",
    "value" : "R3500"
  }],
  "status" : "active",
  "type" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/claim-type",
      "code" : "oral"
    }]

  },
  "created": "2014-08-16",
  "insurer": {
    "identifier": {
      "system": "http://www.jurisdiction.org/insurers",
      "value": "555123"

  "subType" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/ex-claimsubtype",
      "code" : "emergency"
    }]
  },
  "use" : "claim",
  "subject" : {
    "reference" : "Patient/1"
  },
  "created" : "2014-08-16",
  "insurer" : {
    "identifier" : {
      "system" : "http://www.jurisdiction.org/insurers",
      "value" : "555123"

    }
  },
  "requestProvider": {
    "reference": "Practitioner/1"

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

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

  "request" : {
    "reference" : "http://www.BenefitsInc.com/fhir/oralhealthclaim/15476332402"

  },
  "request": {
    "reference": "http://www.BenefitsInc.com/fhir/oralhealthclaim/15476332402"

  "outcome" : "complete",
  "disposition" : "Claim settled as per contract.",
  "payeeType" : {
    "coding" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/payeetype",
      "code" : "provider"
    }]

  },
  "outcome": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/remittance-outcome",
        "code": "complete"

  "item" : [{
    "itemSequence" : 1,
    "adjudication" : [{
      "category" : {
        "coding" : [{
          "code" : "eligible"
        }]
      },
      "amount" : {
        "value" : 135.57,
        "currency" : "USD"

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

    },
    {
      "category" : {
        "coding" : [{
          "code" : "copay"
        }]
      },
      "amount" : {
        "value" : 10.00,
        "currency" : "USD"

      }
    ]
  },
  "item": [

    },

    {
      "sequenceLinkId": 1,
      "adjudication": [
        {
          "category": {
            "coding": [
              {
                "code": "eligible"
              }
            ]
          },
          "amount": {
            "value": 135.57,
            "system": "urn:iso:std:iso:4217",
            "code": "USD"
          }
        },
        {
          "category": {
            "coding": [
              {
                "code": "copay"
              }
            ]
          },
          "amount": {
            "value": 10.00,
            "system": "urn:iso:std:iso:4217",
            "code": "USD"
          }
        },
        {
          "category": {
            "coding": [
              {
                "code": "eligpercent"
              }
            ]
          },
          "value": 80.00
        },
        {
          "category": {
            "coding": [
              {
                "code": "benefit"
              }
            ]
          },
          "amount": {
            "value": 100.47,
            "system": "urn:iso:std:iso:4217",
            "code": "USD"
          }
        }
      ]

      "category" : {
        "coding" : [{
          "code" : "eligpercent"
        }]
      },
      "quantity" : {
        "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" : 90.47,
        "currency" : "USD"
      }
    }]
  }],
  "total" : [{
    "category" : {
      "coding" : [{
        "code" : "submitted"
      }]
    },
    "amount" : {
      "value" : 135.57,
      "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"

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

  {
    "category" : {
      "coding" : [{
        "code" : "benefit"
      }]

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

    "amount" : {
      "value" : 90.47,
      "currency" : "USD"
    }
  }],
  "payment" : {
    "type" : {
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/ex-paymenttype",
        "code" : "complete"
      }]

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

    "date" : "2014-08-31",
    "amount" : {
      "value" : 100.47,
      "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.