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

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

## : NZ Telehealth Claim Example - JSON Representation

Raw json | Download

    {
      "resourceType" : "Claim",
      "meta" : {
        "source" : "https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A",
        "profile" : [
          🔗 "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaim"
        ],
        "tag" : [
          {
            "system" : "https://hub.services.digital.health.nz/ns/correlation-id",
            "code" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
          }
        ]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Claim NzTelehealthClaimExample</b></p><a name=\"NzTelehealthClaimExample\"> </a><a name=\"hcNzTelehealthClaimExample\"> </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\">Information Source: <a href=\"https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A\">https://standards.digital.health.nz/ns/hpi-facility-id/F12345-A</a></p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-SharedCareClaim.html\">NZ SharedCare Claim</a></p><p style=\"margin-bottom: 0px\">Tag: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa (Details: correlation-id code aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa)</p></div><p><b>Shared Care Agreement Number</b>: AGRS-202sdfg4-00121</p><p><b>Shared Care Claim Trace Number</b>: <code>https://example.org/fhir/trace-number</code>/7890</p><p><b>identifier</b>: <code>https://provider-org-name.co.nz/ns/claim-identifier</code>/C123456\u00a0(use:\u00a0official,\u00a0)</p><p><b>status</b>: Active</p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/claim-type professional}\">Professional</span></p><p><b>subType</b>: <span title=\"Codes:{https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype-cs telehealth}\">Telehealth</span></p><p><b>use</b>: Claim</p><p><b>patient</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-nhi.html\" title=\"NHI number\">NHI</a>/ZZZ0008</p><p><b>billablePeriod</b>: 2025-01-01 00:00:00+1300 --&gt; 2025-01-02 00:00:00+1300</p><p><b>created</b>: 2025-01-01 00:00:00+1300</p><p><b>provider</b>: Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiOrganization.html\" title=\"HPI organizations\">HPIOrganization</a>/GZZ999-9\u00a0(use:\u00a0official,\u00a0)</p><p><b>priority</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/processpriority normal}\">Normal</span></p><h3>Insurances</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Sequence</b></td><td><b>Focal</b></td><td><b>Coverage</b></td></tr><tr><td style=\"display: none\">*</td><td>1</td><td>false</td><td>?rref?</td></tr></table><h3>Items</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Extension</b></td><td><b>Sequence</b></td><td><b>ProductOrService</b></td><td><b>Serviced[x]</b></td><td><b>Location[x]</b></td><td><b>Quantity</b></td><td><b>Encounter</b></td></tr><tr><td style=\"display: none\">*</td><td/><td>1</td><td><span title=\"Codes:{https://standards.digital.health.nz/ns/purchase-unit COGP0068}\">COGP0068</span></td><td>2025-01-01 10:00:00+1300 --&gt; 2025-01-01 10:17:00+1300</td><td>Example Telehealth Facility (Identifier: <a href=\"http://fhir.org.nz/ig/base/NamingSystem-hpiFacility.html\" title=\"HPI facilities\">HPIFacility</a>/F12345-A)</td><td>1</td><td><a href=\"Encounter-NzGpOnlineEncounterExample.html\">Encounter: extension = Acute viral pharyngitis,true,enrolled; identifier = https://onlinegp-provider-name.co.nz/ns/encounter-identifier#ENC123456789\u00a0(use:\u00a0official,\u00a0); status = finished; class = virtual (ActCode#VR); type = Video consultation; period = 2025-01-01 10:00:00+1300 --&gt; 2025-01-01 10:17:00+1300</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-agreement-number",
          "valueString" : "AGRS-202sdfg4-00121"
        },
        {
          "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number",
          "valueIdentifier" : {
            "system" : "https://example.org/fhir/trace-number",
            "value" : "7890"
          }
        }
      ],
      "identifier" : [
        {
          "use" : "official",
          "system" : "https://provider-org-name.co.nz/ns/claim-identifier",
          "value" : "C123456"
        }
      ],
      "status" : "active",
      "type" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/claim-type",
            "code" : "professional"
          }
        ]
      },
      "subType" : {
        "coding" : [
          {
            "system" : "https://fhir-ig.digital.health.nz/shared-care/CodeSystem/nz-claim-subtype-cs",
            "code" : "telehealth"
          }
        ]
      },
      "use" : "claim",
      "patient" : {
        "type" : "Patient",
        "identifier" : {
          "system" : "https://standards.digital.health.nz/ns/nhi-id",
          "value" : "ZZZ0008"
        }
      },
      "billablePeriod" : {
        "start" : "2025-01-01T00:00:00+13:00",
        "end" : "2025-01-02T00:00:00+13:00"
      },
      "created" : "2025-01-01T00:00:00+13:00",
      "provider" : {
        "type" : "Organization",
        "identifier" : {
          "use" : "official",
          "system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
          "value" : "GZZ999-9"
        }
      },
      "priority" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/processpriority",
            "code" : "normal"
          }
        ]
      },
      "insurance" : [
        {
          "sequence" : 1,
          "focal" : false,
          "coverage" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
                "valueCode" : "not-applicable"
              }
            ]
          }
        }
      ],
      "item" : [
        {
          "extension" : [
            {
              "url" : "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-patient-copayment",
              "valueMoney" : {
                "value" : 20,
                "currency" : "NZD"
              }
            }
          ],
          "sequence" : 1,
          "productOrService" : {
            "coding" : [
              {
                "system" : "https://standards.digital.health.nz/ns/purchase-unit",
                "code" : "COGP0068"
              }
            ]
          },
          "servicedPeriod" : {
            "start" : "2025-01-01T10:00:00+13:00",
            "end" : "2025-01-01T10:17:00+13:00"
          },
          "locationReference" : {
            "type" : "Location",
            "identifier" : {
              "system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
              "value" : "F12345-A"
            },
            "display" : "Example Telehealth Facility"
          },
          "quantity" : {
            "value" : 1
          },
          "encounter" : [
            {
              🔗 "reference" : "Encounter/NzGpOnlineEncounterExample"
            }
          ]
        }
      ]
    }