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

## Extension: Shared Care Claim Trace Number

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number | Version: 0.4.5
Active as of 2026-03-03 | Computable Name: SharedCareClaimTraceNumber

Internal primary key ID for shared care claim tracking

Context of Use

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

- Element ID: `Claim`
- Element ID: `ClaimResponse.item`
- Element ID: `ClaimResponse.item.detail`

Usage info

Usages:

- Use this Extension: New Zealand Pharmacy Claim Response, NZ SharedCare Claim and NZ SharedCare Claim Response
- Examples for this Extension: Claim/NzTelehealthClaimExample, ClaimResponse/NzPharmacyClaimResponseExample and ClaimResponse/NzTelehealthClaimResponseExample

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 | Shared Care Claim Trace Number
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number"
value[x] |  | 0..1 | Identifier | Value of extension
system |  | 1..1 | uri | The namespace for the identifier value
value |  | 1..1 | string | The value that is unique
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Shared Care Claim Trace Number
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/shared-care-trace-number"
value[x] |  | 0..1 | Identifier | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Identifier: Internal primary key ID for shared care claim tracking

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Shared Care Claim Trace Number
extension |  | 0..0 |  |
url |  | 1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-trace-number"
value[x] |  | 0..1 | Identifier | Value of extension
system |  | 1..1 | uri | The namespace for the identifier value
value |  | 1..1 | string | The value that is unique
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Shared Care Claim Trace Number
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/shared-care-trace-number"
value[x] |  | 0..1 | Identifier | Value of extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Identifier: Internal primary key ID for shared care claim tracking

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Extension.value[x].use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Extension.value[x].type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard

#### 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() |