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

## Resource Profile: ManaakiNgaTahiEncounter

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

Encounter FHIR resource for Manaaki Nga Tahi

Usages:

- Examples for this Profile: Encounter/EncounterExample
- CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
subject | Σ | 0..1 | Reference(Patient) | The patient or group present at the encounter
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() |
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() |

This structure is derived from Encounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
statusHistory |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
classHistory |  | 0..0 |  |
type |  | 0..0 |  |
subject |  | 0..1 | Reference(Patient) | The patient or group present at the encounter
episodeOfCare |  | 0..0 |  |
basedOn |  | 0..0 |  |
participant |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
individual |  | 0..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
reasonReference |  | 0..0 |  |
diagnosis |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
condition |  | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter
account |  | 0..0 |  |
hospitalization |  | 0..0 |  |
location |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
partOf |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject | Σ | 0..1 | Reference(Patient) | The patient or group present at the encounter
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
condition | Σ | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
location |  | 0..* | BackboneElement | List of locations where the patient has been
location |  | 1..1 | Reference(Location) | Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType |  | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider |  | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` From the FHIR Standard
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` From the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` From the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` From the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` From the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` From the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` From the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` From the FHIR Standard
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` From the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() |
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() |

This structure is derived from Encounter

Summary

Mandatory: 1 element
Prohibited: 24 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
subject | Σ | 0..1 | Reference(Patient) | The patient or group present at the encounter
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() |
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() |

Differential View

This structure is derived from Encounter

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
statusHistory |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
classHistory |  | 0..0 |  |
type |  | 0..0 |  |
subject |  | 0..1 | Reference(Patient) | The patient or group present at the encounter
episodeOfCare |  | 0..0 |  |
basedOn |  | 0..0 |  |
participant |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
individual |  | 0..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
reasonReference |  | 0..0 |  |
diagnosis |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
condition |  | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter
account |  | 0..0 |  |
hospitalization |  | 0..0 |  |
location |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
partOf |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Encounter |  | 0..* | Encounter | An interaction during which services are provided to the patient
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory |  | 0..* | BackboneElement | List of past encounter statuses
status |  | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period |  | 1..1 | Period | The time that the episode was in the specified status
class | Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter.
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority |  | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject | Σ | 0..1 | Reference(Patient) | The patient or group present at the encounter
participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter
type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
period |  | 0..1 | Period | Period of time during the encounter that the participant participated
individual | Σ | 0..1 | Reference(Practitioner) | Persons involved in the encounter other than the patient
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter
period |  | 1..1 | Period | Start | end values must be in UTC timezone on the FHIR server
length |  | 0..1 | Duration | Quantity of time the encounter lasted (less time absent)
reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter
condition | Σ | 1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter
use |  | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank |  | 0..1 | positiveInt | Ranking of the diagnosis (for each role type)
location |  | 0..* | BackboneElement | List of locations where the patient has been
location |  | 1..1 | Reference(Location) | Location the encounter takes place
status |  | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
physicalType |  | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.
period |  | 0..1 | Period | Time period during which the patient was present at the location
serviceProvider |  | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Encounter.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.statusHistory.status | required | EncounterStatus `http://hl7.org/fhir/ValueSet/encounter-status|4.0.1` From the FHIR Standard
Encounter.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.classHistory.class | extensible | ActEncounterCode `http://terminology.hl7.org/ValueSet/v3-ActEncounterCode`
Encounter.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` From the FHIR Standard
Encounter.priority | example | ActPriority `http://terminology.hl7.org/ValueSet/v3-ActPriority`
Encounter.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` From the FHIR Standard
Encounter.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` From the FHIR Standard
Encounter.diagnosis.use | preferred | DiagnosisRole `http://hl7.org/fhir/ValueSet/diagnosis-role` From the FHIR Standard
Encounter.hospitalization.admitSource | preferred | AdmitSource `http://hl7.org/fhir/ValueSet/encounter-admit-source` From the FHIR Standard
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator `http://terminology.hl7.org/ValueSet/v2-0092`
Encounter.hospitalization.dietPreference | example | Diet `http://hl7.org/fhir/ValueSet/encounter-diet` From the FHIR Standard
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy `http://hl7.org/fhir/ValueSet/encounter-special-courtesy` From the FHIR Standard
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements `http://hl7.org/fhir/ValueSet/encounter-special-arrangements` From the FHIR Standard
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition `http://hl7.org/fhir/ValueSet/encounter-discharge-disposition` From the FHIR Standard
Encounter.location.status | required | EncounterLocationStatus `http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1` From the FHIR Standard
Encounter.location.physicalType | example | LocationType `http://hl7.org/fhir/ValueSet/location-physical-type` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() |
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() |

This structure is derived from Encounter

Summary

Mandatory: 1 element
Prohibited: 24 elements

Other representations of profile: CSV, Excel, Schematron