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

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

Example ClaimResponse: New Zealand Pharmacy Claim Response Example

Information Source: https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A

Profile: New Zealand Pharmacy Claim Response

Tag: 123e4567-e89b-12d3-a456-426614174011 (Details: correlation-id code 123e4567-e89b-12d3-a456-426614174011)

identifier: https://standards.digital.health.nz/ns/claim-response-identifier/a1b2c3d4-e5f6-7890-abcd-ef1234567890 (use: official, )

status: Active

type: pharmacy

subType: ICP

use: Claim

patient: Identifier: NHI/ZZZ0008

created: 2025-01-01 00:00:00+0000

insurer: Identifier: HPIOrganization/G0K357-H

requestor: Identifier: HPIOrganization/GZZ999-9

request: Claim: extension = AG12345,Community Residential Care,AG54321; identifier = https://provider-org-name.co.nz/ns/claim-identifier#C123456 (use: official, ); status = active; type = pharmacy; subType = ICPSA; use = claim; billablePeriod = 2025-01-01 --> 2025-01-01; created = 2025-01-01 00:00:00+1300; priority = Normal

outcome: Processing Complete

item

Shared Care Product Or Service: PU1234

Shared Care Review Outcome

  • decision: Approved

itemSequence: 1

adjudication

category: Amount Paid

reason: policy

Amounts

-ValueCurrency
*100New Zealand dollar

detail

Pharmacy Claim Item Detail Product Or Service: 123456

Pharmacy Claim Item Detail Review Outcome

  • decision: Approved

Shared Care Claim Trace Number: https://example.com/system/UUID-123456

detailSequence: 1

adjudication

category: Drug Cost

reason: policy

Amounts

-ValueCurrency
*50New Zealand dollar

adjudication

category: Pharmaceutical Subsidy

Amounts

-ValueCurrency
*30New Zealand dollar

adjudication

category: Amount Paid

Amounts

-ValueCurrency
*100New Zealand dollar

payment

type: Complete

date: 2025-01-01

Amounts

-ValueCurrency
*100New Zealand dollar

Errors

-ItemSequenceDetailSequenceCode
*11NHI number cannot be found in our records