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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Online GP Encounter

A FHIR resource profile for operational reporting of Online GP encounters.

A FHIR resource profile for operational reporting of Online GP encounters.

Usages:

• Examples for this Profile: Encounter/NzGpOnlineEncounterExample
• 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
meta	Σ	1..1	Meta	Metadata about the resource
source	ΣC	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External (provider) and Health NZ business identifiers
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
userSelected		0..1	boolean	If this coding was chosen directly by the user
type	Σ	1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
subject	Σ	1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	ΣC	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456
participant	Σ	1..*	BackboneElement	Practitioners involved in the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
individual	Σ	0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use	?!Σ	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
appointment	Σ	0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(Location)	Location the encounter takes place
serviceProvider		1..1	Reference(Organization)	Organization providing the online GP service
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use	?!Σ	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
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.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.participant.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.hospitalization.​dischargeDisposition	Base	required	Online GP Discharge Disposition	📦1.0.0	This IG
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
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()
full-datetime-with-timezone	error	Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

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
meta		1..1	Meta	Metadata about the resource
source	C	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
contained		0..0		Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
identifier		1..*	Identifier	External (provider) and Health NZ business identifiers
period
start	C	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	C	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
statusHistory		0..0		List of past encounter statuses
class		1..1	Coding	Classification of patient encounter Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
classHistory		0..0		List of past encounter classes
type		1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
priority		0..0		Indicates the urgency of the encounter
subject		1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format
display		0..0		Text alternative for the resource
participant		1..*	BackboneElement	Practitioners involved in the encounter
type		0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
individual		0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use		0..1	code	The local identifier use SHOULD be set to official.
system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
appointment		0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
start	C	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	C	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
reasonCode		0..0		Coded reason the encounter takes place
reasonReference		0..0		Reason the encounter takes place (reference)
diagnosis		0..0		The list of diagnosis relevant to this encounter
account		0..0		The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
serviceProvider		1..1	Reference(Organization)	Organization providing the online GP service
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use		0..1	code	The local identifier use SHOULD be set to official.
system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.hospitalization.​dischargeDisposition	Base	required	Online GP Discharge Disposition	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
full-datetime-with-timezone	error	Encounter.identifier.period.start, Encounter.identifier.period.end, Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

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	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	ΣC	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External (provider) and Health NZ business identifiers
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
userSelected		0..1	boolean	If this coding was chosen directly by the user
type	Σ	1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
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 Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	ΣC	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format 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)
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	Σ	1..*	BackboneElement	Practitioners involved in the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
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	The local identifier use SHOULD be set to official. 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	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
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)
display	Σ	0..1	string	Text alternative for the resource
appointment	Σ	0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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		1..1	Reference(Organization)	Organization providing the online GP service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
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	The local identifier use SHOULD be set to official. 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	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
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)
display	Σ	0..1	string	Text alternative for the resource
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Encounter.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
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.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.participant.​individual.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.participant.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.participant.​individual.identifier.​type	Base	extensible	IdentifierType	📍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	required	Online GP Discharge Disposition	📦1.0.0	This IG
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
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()
full-datetime-with-timezone	error	Encounter.identifier.period.start, Encounter.identifier.period.end, Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

This structure is derived from Encounter

Summary

Mandatory: 19 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 9 elements

Structures

This structure refers to these other structures:

• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
• Online GP Appointment (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OnlineGPAppointment)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Encounter.meta.tag

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
meta	Σ	1..1	Meta	Metadata about the resource
source	ΣC	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External (provider) and Health NZ business identifiers
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
userSelected		0..1	boolean	If this coding was chosen directly by the user
type	Σ	1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
subject	Σ	1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	ΣC	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format Example General: 123456
participant	Σ	1..*	BackboneElement	Practitioners involved in the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
individual	Σ	0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use	?!Σ	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
appointment	Σ	0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
location		1..1	Reference(Location)	Location the encounter takes place
serviceProvider		1..1	Reference(Organization)	Organization providing the online GP service
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use	?!Σ	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
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.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.participant.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.hospitalization.​dischargeDisposition	Base	required	Online GP Discharge Disposition	📦1.0.0	This IG
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
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()
full-datetime-with-timezone	error	Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

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
meta		1..1	Meta	Metadata about the resource
source	C	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
contained		0..0		Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
identifier		1..*	Identifier	External (provider) and Health NZ business identifiers
period
start	C	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	C	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
statusHistory		0..0		List of past encounter statuses
class		1..1	Coding	Classification of patient encounter Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
classHistory		0..0		List of past encounter classes
type		1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
priority		0..0		Indicates the urgency of the encounter
subject		1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
identifier		1..1	Identifier	Logical reference, when literal reference is not known
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format
display		0..0		Text alternative for the resource
participant		1..*	BackboneElement	Practitioners involved in the encounter
type		0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
individual		0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use		0..1	code	The local identifier use SHOULD be set to official.
system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
appointment		0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
start	C	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	C	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
reasonCode		0..0		Coded reason the encounter takes place
reasonReference		0..0		Reason the encounter takes place (reference)
diagnosis		0..0		The list of diagnosis relevant to this encounter
account		0..0		The set of accounts that may be used for billing for this Encounter
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
serviceProvider		1..1	Reference(Organization)	Organization providing the online GP service
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
use		0..1	code	The local identifier use SHOULD be set to official.
system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.hospitalization.​dischargeDisposition	Base	required	Online GP Discharge Disposition	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
full-datetime-with-timezone	error	Encounter.identifier.period.start, Encounter.identifier.period.end, Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

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	Σ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	ΣC	1..1	uri	HPI Facility ID from where the record is sourced Constraints: hpi-location-url-format
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cscHolder		0..1	boolean	Shared Care CSC holder URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
extension:regCode		0..1	string	Shared Care Registration Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
extension:diagnosis		0..*	CodeableConcept	Shared Care Diagnosis Code URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code Binding: Condition/Problem/DiagnosisCodes (example)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	1..*	Identifier	External (provider) and Health NZ business identifiers
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: VR
display		1..1	string	Representation defined by the system Fixed Value: virtual
userSelected		0..1	boolean	If this coding was chosen directly by the user
type	Σ	1..1	CodeableConcept	Type of encounter (e.g., Video consultation) Binding: Shared Care Encounter Type Value Set (extensible)
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
subject	Σ	1..1	Reference(NZ Patient | Patient)	The patient or group present at the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
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 Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	ΣC	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: nhi-value-format 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)
episodeOfCare	Σ	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
participant	Σ	1..*	BackboneElement	Practitioners involved in the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..*	CodeableConcept	Role of participant in encounter Binding: Online GP Participant Type (required)
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner resource for use in NZ)	Persons involved in the encounter other than the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
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	The local identifier use SHOULD be set to official. 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	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
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)
display	Σ	0..1	string	Text alternative for the resource
appointment	Σ	0..*	Reference(Online GP Appointment)	The appointment that scheduled this encounter
period		1..1	Period	The start and end time of the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary Constraints: full-datetime-with-timezone
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing Constraints: full-datetime-with-timezone
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
reAdmission		0..1	CodeableConcept	The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: Online GP Discharge Disposition (required)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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		1..1	Reference(Organization)	Organization providing the online GP service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: hpiOrganizationIdPattern, hpiFacilityIdPattern, nzbnPattern, hpiCpnPattern
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	The local identifier use SHOULD be set to official. 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	ΣC	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: allowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
value	Σ	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
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)
display	Σ	0..1	string	Text alternative for the resource
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then admitted as an inpatient)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Encounter.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
Encounter.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
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.type	Base	extensible	Shared Care Encounter Type Value Set	📦0.0.1	This IG
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.subject.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.subject.identifier.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Encounter.participant.​type	Base	required	Online GP Participant Type	📦1.0.2	This IG
Encounter.participant.​individual.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.participant.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.participant.​individual.identifier.​type	Base	extensible	IdentifierType	📍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	required	Online GP Discharge Disposition	📦1.0.0	This IG
Encounter.location.status	Base	required	EncounterLocationStatus	📍4.0.1	FHIR Std.
Encounter.location.physicalType	Base	example	Location type	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
allowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, HPI Organisation, HPI CPN or NZBN	$this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id'
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()
full-datetime-with-timezone	error	Encounter.identifier.period.start, Encounter.identifier.period.end, Encounter.period.start, Encounter.period.end	DateTime must be ISO 8601 format with time and timezone (e.g., 2026-01-01T00:00:00+13:00 or 2026-01-01T00:00:00Z). Date-only values are not accepted.	toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})$')
hpi-location-url-format	error	Encounter.meta.source	Reference must be an HPI facility URL with format https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A	matches('^https://standards.digital.health.nz/ns/hpi-facility-id/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiCpnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI CPN must conform to format (NNXXXX where N is numeric and X is alphabetic).	system = 'https://standards.digital.health.nz/ns/hpi-person-id' implies value.matches('^[0-9]{2}[A-Za-z]{4}$')
hpiFacilityIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Facility ID must conform to format (FXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-facility-id' implies value.matches('^F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')
hpiOrganizationIdPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	HPI Organisation ID must conform to format (GXXnnn-C).	system = 'https://standards.digital.health.nz/ns/hpi-organisation-id' implies value.matches('^G[a-zA-Z0-9]{2}[0-9]{3}-[a-zA-Z0-9]$')
nhi-value-format	error	Encounter.subject.identifier.value	Reference must be an NHI Patient URL with format ZZZ1111 or ZZZ11AA	matches('^[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')
nzbnPattern	error	Encounter.participant.individual.identifier, Encounter.serviceProvider.identifier	NZBN must conform to format (13 digits).	system = 'https://standards.digital.health.nz/ns/hpi-nzbn' implies value.matches('^[0-9]{13}$')

This structure is derived from Encounter

Summary

Mandatory: 19 elements(3 nested mandatory elements)
Fixed: 1 element
Prohibited: 9 elements

Structures

This structure refers to these other structures:

• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
• Online GP Appointment (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OnlineGPAppointment)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-csc-holder
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-registration-code
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/shared-care-diagnosis-code

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Encounter.meta.tag