Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.3 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-agreement-number | Version: 0.4.3 | |||
| Active as of 2025-11-13 | Computable Name: SharedCareAgreementNumber | |||
The agreement/contract number between the provider and the 'insurer' (HNZ) including version number
Context of Use
This extension may be used on the following element(s)
Claim
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Shared Care Agreement Number | |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-agreement-number" | |
  value[x] |
0..1 | string | Agreement number with optional version (e.g., AGR-2024-001 or AGR-2024-001-v2) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Shared Care Agreement 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-agreement-number" | |
| value[x] |
0..1 | string | Agreement number with optional version (e.g., AGR-2024-001 or AGR-2024-001-v2) | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Shared Care Agreement Number | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-agreement-number" | |
| value[x] |
0..1 | string | Agreement number with optional version (e.g., AGR-2024-001 or AGR-2024-001-v2) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Shared Care Agreement 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-agreement-number" | |
| value[x] |
0..1 | string | Agreement number with optional version (e.g., AGR-2024-001 or AGR-2024-001-v2) | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| 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() |