Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: NZ Telehealth Claim Response Example - JSON Representation

Raw json | Download

{
  "resourceType" : "ClaimResponse",
  "meta" : {
    "profile" : [
      🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: ClaimResponse NzTelehealthClaimResponseExample</b></p><a name=\"NzTelehealthClaimResponseExample\"> </a><a name=\"hcNzTelehealthClaimResponseExample\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SharedCareClaimResponse.html\">NZ Telehealth Claim Response</a></p></div><p><b>identifier</b>: <code>https://standards.digital.health.nz/ns/claim-response-identifier</code>/CR12345\u00a0(use:\u00a0official,\u00a0)</p><p><b>status</b>: Active</p><p><b>type</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/nz-claim-type professional}\">professional</span></p><p><b>subType</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/nz-claim-subtype online-gp-services}\">online-gp-services</span></p><p><b>use</b>: Claim</p><p><b>patient</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=http://fhir.org.nz/ig/base/Patient/ZZZ0008\">Mr Test Patient | Male | 2001-01-01</a></p><p><b>created</b>: 2025-01-01 00:00:00+0000</p><p><b>insurer</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@3.0.0&amp;canonical=http://fhir.org.nz/ig/base/Organization/GZZ000-1\">Organization/GZZ000-1</a></p><p><b>request</b>: <a href=\"Claim-NzTelehealthClaimExample.html\">Claim: extension = https://example.org/fhir/trace-number#7890; identifier = https://standards.digital.health.nz/ns/claim-identifier#C123456\u00a0(use:\u00a0official,\u00a0); status = active; type = professional; subType = online-gp-services; use = claim; billablePeriod = 2025-01-01 --&gt; 2025-01-01; created = 2025-01-01 00:00:00+1300; priority = Normal</a></p><p><b>outcome</b>: Processing Complete</p><blockquote><p><b>item</b></p><p><b>Product Or Service</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/purchase-unit PU1234}\">PU1234</span></p><p><b>itemSequence</b>: 1</p><blockquote><p><b>adjudication</b></p><p><b>category</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/adjudication-value-code benefit}\">benefit</span></p><p><b>reason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/adjudication-reason-code ar1234}\">ar1234</span></p><h3>Amounts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style=\"display: none\">*</td><td>100</td><td>New Zealand dollar</td></tr></table><p><b>value</b>: 1</p></blockquote></blockquote><blockquote><p><b>total</b></p><p><b>category</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/adjudication benefit}\">Benefit Amount</span></p><h3>Amounts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style=\"display: none\">*</td><td>100</td><td>New Zealand dollar</td></tr></table></blockquote><blockquote><p><b>payment</b></p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/ex-paymenttype complete}\">Complete</span></p><p><b>date</b>: 2025-01-01</p><h3>Amounts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Value</b></td><td><b>Currency</b></td></tr><tr><td style=\"display: none\">*</td><td>100</td><td>New Zealand dollar</td></tr></table></blockquote></div>"
  },
  "identifier" : [
    {
      "use" : "official",
      "system" : "https://standards.digital.health.nz/ns/claim-response-identifier",
      "value" : "CR12345"
    }
  ],
  "status" : "active",
  "type" : {
    "coding" : [
      {
        "system" : "https://standards.digital.health.nz/ns/nz-claim-type",
        "code" : "professional"
      }
    ]
  },
  "subType" : {
    "coding" : [
      {
        "system" : "https://standards.digital.health.nz/ns/nz-claim-subtype",
        "code" : "online-gp-services"
      }
    ]
  },
  "use" : "claim",
  "patient" : {
    "reference" : "Patient/ZZZ0008",
    "type" : "Patient",
    "identifier" : {
      "system" : "https://standards.digital.health.nz/ns/nhi-id",
      "value" : "ZZZ0008"
    },
    "display" : "Mr Test Patient | Male | 2001-01-01"
  },
  "created" : "2025-01-01T00:00:00-00:00",
  "insurer" : {
    "reference" : "Organization/GZZ000-1",
    "type" : "Organization"
  },
  "request" : {
    🔗 "reference" : "Claim/NzTelehealthClaimExample"
  },
  "outcome" : "complete",
  "item" : [
    {
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/product-or-service",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "https://standards.digital.health.nz/ns/purchase-unit",
                "code" : "PU1234"
              }
            ]
          }
        }
      ],
      "itemSequence" : 1,
      "adjudication" : [
        {
          "category" : {
            "coding" : [
              {
                "system" : "https://standards.digital.health.nz/ns/adjudication-value-code",
                "code" : "benefit"
              }
            ]
          },
          "reason" : {
            "coding" : [
              {
                "system" : "https://standards.digital.health.nz/ns/adjudication-reason-code",
                "code" : "ar1234"
              }
            ]
          },
          "amount" : {
            "value" : 100,
            "currency" : "NZD"
          },
          "value" : 1
        }
      ]
    }
  ],
  "total" : [
    {
      "category" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/adjudication",
            "code" : "benefit"
          }
        ]
      },
      "amount" : {
        "value" : 100,
        "currency" : "NZD"
      }
    }
  ],
  "payment" : {
    "type" : {
      "coding" : [
        {
          "system" : "http://terminology.hl7.org/CodeSystem/ex-paymenttype",
          "code" : "complete"
        }
      ]
    },
    "date" : "2025-01-01",
    "amount" : {
      "value" : 100,
      "currency" : "NZD"
    }
  }
}