Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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: DHO Encounter profile

This profile derives from the Encounter Resource, for use in the Dunedin Hospital Outpatients context.

Dunedin Hospital Outpatient Encounter profile

Usages:

• Refer to this Profile: DHO Encounter profile, DHO Encounter profile used to create an Encounter, DHO Encounter profile used to update an Encounter and DHO Service Request Profile
• Examples for this Profile: Encounter/dho-outpatient-encounter-instance and Encounter/dho-outpatient-encounter-update-instance
• 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
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Encounter.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	Σ This element is included in summaries.	1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.type	Σ This element is included in summaries.	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
Encounter.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456
Encounter.participant	Σ This element is included in summaries.	0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.individual	Σ This element is included in summaries.	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.participant.individual.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.hospitalization.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Location)	Location the encounter takes place
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.serviceProvider.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	required	DHO Encounter Class	📦0.4.7	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.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

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
Encounter.meta
Encounter.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Encounter.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Encounter.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Encounter.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Encounter.identifier		0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.id		0..0		Unique id for inter-element referencing
Encounter.identifier.use	S This element must be supported.	0..1	code	usual | official | temp | secondary | old (If known)
Encounter.identifier.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Encounter.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Encounter.identifier.period		0..0		Time period when id is/was valid for use
Encounter.class		1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.subject		1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
Encounter.subject.identifier		1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format
Encounter.participant		0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.individual		0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.use		0..1	code	The local identifier use SHOULD be set to official.
Encounter.participant.individual.identifier.system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
Encounter.appointment		0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.use		0..1	code	The local identifier use SHOULD be set to official.
Encounter.serviceProvider.identifier.system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.class	Base	required	DHO Encounter Class	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
Encounter.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Encounter.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Encounter.meta.id		0..1	string	Unique id for inter-element referencing
Encounter.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Encounter.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Encounter.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Encounter.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Encounter.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Encounter.meta.Slices for tag	Σ This element is included in summaries.	1..*	Coding	Correlation-id where the record is sourced 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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Encounter.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Encounter.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Encounter.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Encounter.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Encounter.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Encounter.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.extension		0..*	Extension	Additional content defined by implementations
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.identifier.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type	Σ This element is included in summaries.	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.
Encounter.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Encounter.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory		0..*	BackboneElement	List of past encounter statuses
Encounter.statusHistory.id		0..1	string	Unique id for inter-element referencing
Encounter.statusHistory.extension		0..*	Extension	Additional content defined by implementations
Encounter.statusHistory.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period		1..1	Period	The time that the episode was in the specified status
Encounter.class	Σ This element is included in summaries.	1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.classHistory		0..*	BackboneElement	List of past encounter classes
Encounter.classHistory.id		0..1	string	Unique id for inter-element referencing
Encounter.classHistory.extension		0..*	Extension	Additional content defined by implementations
Encounter.classHistory.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period		1..1	Period	The time that the episode was in the specified class
Encounter.type	Σ This element is included in summaries.	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
Encounter.serviceType	Σ This element is included in summaries.	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.id		0..1	string	Unique id for inter-element referencing
Encounter.subject.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.subject.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.subject.type	Σ This element is included in summaries.	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
Encounter.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.subject.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.subject.identifier.type	Σ This element is included in summaries.	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.
Encounter.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456
Encounter.subject.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.subject.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.episodeOfCare	Σ This element is included in summaries.	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
Encounter.basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
Encounter.participant	Σ This element is included in summaries.	0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.extension		0..*	Extension	Additional content defined by implementations
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period		0..1	Period	Period of time during the encounter that the participant participated
Encounter.participant.individual	Σ This element is included in summaries.	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.individual.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.participant.individual.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.participant.individual.type	Σ This element is included in summaries.	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).
Encounter.participant.individual.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.individual.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.participant.individual.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.participant.individual.identifier.type	Σ This element is included in summaries.	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.
Encounter.participant.individual.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.participant.individual.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.participant.individual.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.participant.individual.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode	Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference	Σ This element is included in summaries.	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference)
Encounter.diagnosis	Σ This element is included in summaries.	0..*	BackboneElement	The list of diagnosis relevant to this encounter
Encounter.diagnosis.id		0..1	string	Unique id for inter-element referencing
Encounter.diagnosis.extension		0..*	Extension	Additional content defined by implementations
Encounter.diagnosis.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	Σ This element is included in summaries.	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
Encounter.account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.hospitalization.id		0..1	string	Unique id for inter-element referencing
Encounter.hospitalization.extension		0..*	Extension	Additional content defined by implementations
Encounter.hospitalization.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
Encounter.hospitalization.origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.location.id		0..1	string	Unique id for inter-element referencing
Encounter.location.extension		0..*	Extension	Additional content defined by implementations
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Location)	Location the encounter takes place
Encounter.location.status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
Encounter.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.
Encounter.location.period		0..1	Period	Time period during which the patient was present at the location
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.id		0..1	string	Unique id for inter-element referencing
Encounter.serviceProvider.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.serviceProvider.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.serviceProvider.type	Σ This element is included in summaries.	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).
Encounter.serviceProvider.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.serviceProvider.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.serviceProvider.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.serviceProvider.identifier.type	Σ This element is included in summaries.	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.
Encounter.serviceProvider.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.serviceProvider.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.serviceProvider.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.serviceProvider.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
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	required	DHO Encounter Class	📦0.4.7	This IG
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📦3.0.0	THO v6.5
Encounter.type	Base	example	Encounter type	📍4.0.1	FHIR Std.
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📦3.0.0	THO v6.5
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	extensible	Participant type	📍4.0.1	FHIR Std.
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.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.
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
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

This structure is derived from Encounter

Summary

Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• DHO Patient Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatient)
• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
• PractitionerRole resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole)
• DHO Appointment Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment)
• Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
• DHO Encounter profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounter)

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
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Encounter.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class	Σ This element is included in summaries.	1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.type	Σ This element is included in summaries.	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
Encounter.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456
Encounter.participant	Σ This element is included in summaries.	0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.individual	Σ This element is included in summaries.	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.participant.individual.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.hospitalization.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Location)	Location the encounter takes place
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.serviceProvider.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Encounter.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.status	Base	required	EncounterStatus	📍4.0.1	FHIR Std.
Encounter.class	Base	required	DHO Encounter Class	📦0.4.7	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.​individual.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Encounter.serviceProvider.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

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
Encounter.meta
Encounter.meta.source		1..1	uri	HPI Facility ID from where the record is sourced
Encounter.meta.Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.meta.Slices for tag.tag:correlationId		1..1	Coding	Tags applied to this resource
Encounter.meta.Slices for tag.tag:correlationId.system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Encounter.meta.Slices for tag.tag:correlationId.code		1..1	code	Symbol in syntax defined by the system
Encounter.identifier		0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.id		0..0		Unique id for inter-element referencing
Encounter.identifier.use	S This element must be supported.	0..1	code	usual | official | temp | secondary | old (If known)
Encounter.identifier.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Encounter.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Encounter.identifier.period		0..0		Time period when id is/was valid for use
Encounter.class		1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.subject		1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.type		1..1	uri	Type the reference refers to (e.g. "Patient") Required Pattern: Patient
Encounter.subject.identifier		1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format
Encounter.participant		0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.individual		0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.use		0..1	code	The local identifier use SHOULD be set to official.
Encounter.participant.individual.identifier.system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
Encounter.appointment		0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.use		0..1	code	The local identifier use SHOULD be set to official.
Encounter.serviceProvider.identifier.system	C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value		1..1	string	The actual local identifier value, e.g. GZZ999-Z Example Example HPI Org ID: GZZ999-Z
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Encounter.class	Base	required	DHO Encounter Class	📦0.4.7	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

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
Encounter.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Encounter.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Encounter.meta.id		0..1	string	Unique id for inter-element referencing
Encounter.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
Encounter.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
Encounter.meta.source	Σ This element is included in summaries.	1..1	uri	HPI Facility ID from where the record is sourced
Encounter.meta.profile	Σ This element is included in summaries.	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Encounter.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Encounter.meta.Slices for tag	Σ This element is included in summaries.	1..*	Coding	Correlation-id where the record is sourced 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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.meta.Slices for tag.tag:correlationId	Σ This element is included in summaries.	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".
Encounter.meta.Slices for tag.tag:correlationId.id		0..1	string	Unique id for inter-element referencing
Encounter.meta.Slices for tag.tag:correlationId.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.meta.Slices for tag.tag:correlationId.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
Encounter.meta.Slices for tag.tag:correlationId.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Encounter.meta.Slices for tag.tag:correlationId.code	Σ This element is included in summaries.	1..1	code	Symbol in syntax defined by the system
Encounter.meta.Slices for tag.tag:correlationId.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Encounter.meta.Slices for tag.tag:correlationId.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Encounter.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Encounter.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Encounter.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
Encounter.contained		0..*	Resource	Contained, inline Resources
Encounter.extension		0..*	Extension	Additional content defined by implementations
Encounter.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Encounter.identifier	Σ This element is included in summaries.	0..1	Identifier	External (provider) and Health NZ location identifiers
Encounter.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.identifier.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type	Σ This element is included in summaries.	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.
Encounter.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Encounter.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory		0..*	BackboneElement	List of past encounter statuses
Encounter.statusHistory.id		0..1	string	Unique id for inter-element referencing
Encounter.statusHistory.extension		0..*	Extension	Additional content defined by implementations
Encounter.statusHistory.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period		1..1	Period	The time that the episode was in the specified status
Encounter.class	Σ This element is included in summaries.	1..1	Coding	Classification of patient encounter Binding: DHO Encounter Class (required)
Encounter.classHistory		0..*	BackboneElement	List of past encounter classes
Encounter.classHistory.id		0..1	string	Unique id for inter-element referencing
Encounter.classHistory.extension		0..*	Extension	Additional content defined by implementations
Encounter.classHistory.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period		1..1	Period	The time that the episode was in the specified class
Encounter.type	Σ This element is included in summaries.	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
Encounter.serviceType	Σ This element is included in summaries.	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject	Σ This element is included in summaries.	1..1	Reference(DHO Patient Profile | NZ Patient | Patient)	The patient or group present at the encounter
Encounter.subject.id		0..1	string	Unique id for inter-element referencing
Encounter.subject.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.subject.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.subject.type	Σ This element is included in summaries.	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
Encounter.subject.identifier	Σ This element is included in summaries.	1..1	Identifier	Logical reference, when literal reference is not known
Encounter.subject.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.subject.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.subject.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.subject.identifier.type	Σ This element is included in summaries.	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.
Encounter.subject.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
Encounter.subject.identifier.value	Σ This element is included in summaries. C	1..1	string	Must be an absolute URL reference to the patient on the NHI system. See constraints for details. Constraints: dho-nhi-value-format Example General: 123456
Encounter.subject.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.subject.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.subject.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.episodeOfCare	Σ This element is included in summaries.	0..*	Reference(EpisodeOfCare)	Episode(s) of care that this encounter should be recorded against
Encounter.basedOn		0..*	Reference(ServiceRequest)	The ServiceRequest that initiated this encounter
Encounter.participant	Σ This element is included in summaries.	0..*	BackboneElement	Practitioners involved in the encounter
Encounter.participant.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.extension		0..*	Extension	Additional content defined by implementations
Encounter.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.participant.type	Σ This element is included in summaries.	0..*	CodeableConcept	Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period		0..1	Period	Period of time during the encounter that the participant participated
Encounter.participant.individual	Σ This element is included in summaries.	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	Persons involved in the encounter other than the patient
Encounter.participant.individual.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.individual.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.participant.individual.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.participant.individual.type	Σ This element is included in summaries.	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).
Encounter.participant.individual.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.participant.individual.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.participant.individual.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.participant.individual.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.participant.individual.identifier.type	Σ This element is included in summaries.	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.
Encounter.participant.individual.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.participant.individual.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.participant.individual.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.participant.individual.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.participant.individual.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.appointment	Σ This element is included in summaries.	0..*	Reference(DHO Appointment Profile)	The appointment that scheduled this encounter
Encounter.period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
Encounter.length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode	Σ This element is included in summaries.	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference	Σ This element is included in summaries.	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference)
Encounter.diagnosis	Σ This element is included in summaries.	0..*	BackboneElement	The list of diagnosis relevant to this encounter
Encounter.diagnosis.id		0..1	string	Unique id for inter-element referencing
Encounter.diagnosis.extension		0..*	Extension	Additional content defined by implementations
Encounter.diagnosis.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition	Σ This element is included in summaries.	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
Encounter.account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
Encounter.hospitalization.id		0..1	string	Unique id for inter-element referencing
Encounter.hospitalization.extension		0..*	Extension	Additional content defined by implementations
Encounter.hospitalization.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier		0..1	Identifier	Pre-admission identifier
Encounter.hospitalization.origin		0..1	Reference(Location | Organization)	The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource		0..1	CodeableConcept	From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference		0..*	CodeableConcept	Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy		0..*	CodeableConcept	Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement		0..*	CodeableConcept	Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination		0..1	Reference(Location | Organization)	Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition		0..1	CodeableConcept	Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
Encounter.location.id		0..1	string	Unique id for inter-element referencing
Encounter.location.extension		0..*	Extension	Additional content defined by implementations
Encounter.location.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Encounter.location.location		1..1	Reference(Location)	Location the encounter takes place
Encounter.location.status		0..1	code	planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.
Encounter.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.
Encounter.location.period		0..1	Period	Time period during which the patient was present at the location
Encounter.serviceProvider		0..1	Reference(Organization resource for use in NZ | Organization)	The organization (facility) responsible for this encounter
Encounter.serviceProvider.id		0..1	string	Unique id for inter-element referencing
Encounter.serviceProvider.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.serviceProvider.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Encounter.serviceProvider.type	Σ This element is included in summaries.	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).
Encounter.serviceProvider.identifier	Σ This element is included in summaries. C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
Encounter.serviceProvider.identifier.id		0..1	string	Unique id for inter-element referencing
Encounter.serviceProvider.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Encounter.serviceProvider.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	The local identifier use SHOULD be set to official. Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.serviceProvider.identifier.type	Σ This element is included in summaries.	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.
Encounter.serviceProvider.identifier.system	Σ This element is included in summaries. C	1..1	uri	The system identifier for the organization, facility or nzbn Constraints: DHOallowedLocalIdentifierSystems Example General: http://www.acme.com/identifiers/patient Example HPI Organisation ID: https://standards.digital.health.nz/ns/hpi-organisation-id
Encounter.serviceProvider.identifier.value	Σ This element is included in summaries.	1..1	string	The actual local identifier value, e.g. GZZ999-Z Example General: 123456 Example Example HPI Org ID: GZZ999-Z
Encounter.serviceProvider.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Encounter.serviceProvider.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Encounter.serviceProvider.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Encounter.partOf		0..1	Reference(DHO Encounter profile | Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
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	required	DHO Encounter Class	📦0.4.7	This IG
Encounter.classHistory.​class	Base	extensible	ActEncounterCode	📦3.0.0	THO v6.5
Encounter.type	Base	example	Encounter type	📍4.0.1	FHIR Std.
Encounter.serviceType	Base	example	Service type	📍4.0.1	FHIR Std.
Encounter.priority	Base	example	ActPriority	📦3.0.0	THO v6.5
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	extensible	Participant type	📍4.0.1	FHIR Std.
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.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.
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
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.identifier.system, Encounter.serviceProvider.identifier.system	Identifier system must be HPI facility, NHI, NZBN, HPI Organisation, HPI Person, HPI Practitioner, NZHIS Facility ID (Legacy) or a DHO system URI (https://dho.tewhatuora.govt.nz/)	$this = 'https://standards.digital.health.nz/ns/hpi-facility-id' or $this = 'https://standards.digital.health.nz/ns/nhi-id' or $this = 'https://standards.digital.health.nz/ns/hpi-nzbn' or $this = 'https://standards.digital.health.nz/ns/hpi-organisation-id' or $this = 'https://standards.digital.health.nz/ns/hpi-person-id' or $this = 'https://standards.digital.health.nz/ns/hpi-practitioner-id' or $this = 'https://standards.digital.health.nz/ns/nzhis-facility-id' or $this.startsWith('https://dho.tewhatuora.govt.nz/')
DHOhpiCpnPattern	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}$')
DHOhpiFacilityIdPattern	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]$')
DHOhpiOrganizationIdPattern	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]$')
DHOnzbnPattern	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}$')
dho-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})$')

This structure is derived from Encounter

Summary

Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 3 elements
Fixed: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• DHO Patient Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatient)
• NZ Patient (http://hl7.org.nz/fhir/StructureDefinition/NzPatient)
• Practitioner resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitioner)
• PractitionerRole resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzPractitionerRole)
• DHO Appointment Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment)
• Organization resource for use in NZ (http://hl7.org.nz/fhir/StructureDefinition/NzOrganization)
• DHO Encounter profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounter)

Slices

This structure defines the following Slices:

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