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/ManaakiNgaTahiEncounter | Version: 2 | |||
| Active as of 2026-07-20 | Computable Name: ManaakiNgaTahiEncounter | |||
Encounter FHIR resource for Manaaki Nga Tahi
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 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: |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
 modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Identifier(s) by which this encounter is known | ||
 statusHistory |
||||
 id |
0..0 | Unique id for inter-element referencing | ||
 extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| classHistory |
0..0 | List of past encounter classes | ||
| type |
0..0 | Specific type of encounter | ||
| subject |
0..1 | Reference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
0..0 | Episode(s) of care that this encounter should be recorded against | ||
| basedOn |
0..0 | The ServiceRequest that initiated this encounter | ||
| participant |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| 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 | Reason the encounter takes place (reference) | ||
| diagnosis |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
| account |
0..0 | The set of accounts that may be used for billing for this Encounter | ||
| hospitalization |
0..0 | Details about the admission to a healthcare service | ||
| location |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| partOf |
0..0 | Another Encounter this encounter is part of | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v6.5 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 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: |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| modifierExtension |
0..0 | Extension | ||
| identifier |
0..0 | Identifier(s) by which this encounter is known | ||
| statusHistory |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| classHistory |
0..0 | List of past encounter classes | ||
| type |
0..0 | Specific type of encounter | ||
| subject |
0..1 | Reference(Patient) | The patient or group present at the encounter | |
| episodeOfCare |
0..0 | Episode(s) of care that this encounter should be recorded against | ||
| basedOn |
0..0 | The ServiceRequest that initiated this encounter | ||
| participant |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| 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 | Reason the encounter takes place (reference) | ||
| diagnosis |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| condition |
1..1 | Reference(Condition) | The diagnosis or procedure relevant to the encounter | |
| account |
0..0 | The set of accounts that may be used for billing for this Encounter | ||
| hospitalization |
0..0 | Details about the admission to a healthcare service | ||
| location |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| partOf |
0..0 | Another Encounter this encounter is part of | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.statusHistory.status | Base | required | EncounterStatus | 📍4.0.1 | FHIR Std. |
| Encounter.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.classHistory.class | Base | extensible | ActEncounterCode | 📦3.0.0 | THO v6.5 |
| Encounter.serviceType | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| Encounter.priority | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Encounter.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Encounter.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.0.1 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | DiagnosisRole | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.admitSource | Base | preferred | Admit source | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📦2.0.0 | THO v6.5 |
| Encounter.hospitalization.dietPreference | Base | example | Diet | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialCourtesy | Base | preferred | Special courtesy | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.specialArrangement | Base | preferred | Special arrangements | 📍4.0.1 | FHIR Std. |
| Encounter.hospitalization.dischargeDisposition | Base | example | Discharge disposition | 📍4.0.1 | FHIR Std. |
| Encounter.location.status | Base | required | EncounterLocationStatus | 📍4.0.1 | FHIR Std. |
| Encounter.location.physicalType | Base | example | Location type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Other representations of profile: CSV, Excel, Schematron