Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass | Version: 0.4.5 | |||
| Active as of 2026-06-25 | Computable Name: DHOInitialPatientClass | |||
The encounter class (e.g. ambulatory, inpatient, emergency) the patient is expected to be classified as at the start of the encounter resulting from this appointment.
Context of Use
This extension may be used on the following element(s)
Appointment
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 | DHO Initial Patient Class | |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass" | |
  value[x] |
1..1 | CodeableConcept | Value of extension Binding: Encounter class (extensible) | |
  coding |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| text |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | DHO Initial Patient Class | |
 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/DHOInitialPatientClass" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Encounter class (extensible) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| 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 | DHO Initial Patient Class | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOInitialPatientClass" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Encounter class (extensible) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| text |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | DHO Initial Patient Class | |
| 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/DHOInitialPatientClass" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Encounter class (extensible) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
Σ | 1..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Extension.value[x] | extensible | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class |
| 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() |