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

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

## Extension: Balance Owing

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing | Version: 0.4.3
Active as of 2025-11-25 | Computable Name: BalanceOwing

Indicates the balance owing for the pharmacy claim item detail.

Context of Use

This extension may be used on the following element(s)

- Element ID: `Claim.item.detail`

Usage info

Usages:

- Use this Extension: NZ Pharmacy Claim
- Examples for this Extension: Claim/NzPharmacyClaimExample2

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Balance Owing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing"
value[x] |  | 1..1 | string | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Balance Owing
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing"
value[x] |  | 1..1 | string | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Indicates the balance owing for the pharmacy claim item detail.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Balance Owing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing"
value[x] |  | 1..1 | string | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Balance Owing
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hsaap-balance-owing"
value[x] |  | 1..1 | string | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type string: Indicates the balance owing for the pharmacy claim item detail.

Other representations of profile: CSV, Excel, Schematron

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |