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: Dunedin Hospital Outpatient Encounter

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

Usages:

• 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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	External (provider) and Health NZ business identifiers
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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
userSelected		0..1	boolean	If this coding was chosen directly by the user
subject	Σ	1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-nhi-value-format Example General: 123456
participant	Σ	0..*	BackboneElement	Practitioners involved in the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	Pattern Value: AMB("Ambulatory") http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.subject.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.participant.individual.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.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'
DHOhpiCpnPattern	error	Encounter.participant.individual.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	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	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	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})$')
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
identifier		0..1	Identifier	External (provider) and Health NZ business identifiers
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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
subject		1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-nhi-value-format
participant		0..*	BackboneElement	Practitioners involved in the encounter
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
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
serviceProvider
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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 readmitted)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	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'
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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	1..1	uri	HPI Facility ID from where the record is sourced
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	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".
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	Identity of the terminology system Fixed Value: 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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	External (provider) and Health NZ business identifiers
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
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
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. 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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
userSelected		0..1	boolean	If this coding was chosen directly by the user
classHistory		0..*	BackboneElement	List of past encounter classes
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
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	Σ	1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-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)
display	Σ	0..1	string	Text alternative for the resource
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	Σ	0..*	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: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	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: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	Σ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference)
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this 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
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
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: DischargeDisposition (example): Discharge Disposition.
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		0..1	Reference(Organization)	The organization (facility) responsible for this 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	Σ	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: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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 readmitted)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Encounter.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Encounter.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	Pattern Value: AMB("Ambulatory") http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type From the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.subject.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.participant.individual.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.participant.individual.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.participant.individual.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition From the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type From the FHIR Standard
Encounter.serviceProvider.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.serviceProvider.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.serviceProvider.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	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'
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})$')
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 5 elements(11 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Dunedin Hospital Outpatient Get 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)
• Dunedin Hospital Outpatient Appointment Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment)

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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	External (provider) and Health NZ business identifiers
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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
userSelected		0..1	boolean	If this coding was chosen directly by the user
subject	Σ	1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-nhi-value-format Example General: 123456
participant	Σ	0..*	BackboneElement	Practitioners involved in the encounter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
identifier	ΣC	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
partOf		0..1	Reference(Encounter)	A preceding Encounter (e.g. discharged from ED then readmitted)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	Pattern Value: AMB("Ambulatory") http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.subject.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.participant.individual.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	error	Encounter.participant.individual.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'
DHOhpiCpnPattern	error	Encounter.participant.individual.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	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	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	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})$')
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Encounter

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Encounter		0..*	Encounter	An interaction during which services are provided to the patient
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
identifier		0..1	Identifier	External (provider) and Health NZ business identifiers
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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
subject		1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-nhi-value-format
participant		0..*	BackboneElement	Practitioners involved in the encounter
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
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
hospitalization		0..1	BackboneElement	Admission & discharge details (if applicable)
location		0..*	BackboneElement	(Sub)Locations where the patient has been during the encounter
serviceProvider
identifier	C	1..1	Identifier	A local identifier MUST be added to this section. Constraints: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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 readmitted)
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	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'
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
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	1..1	uri	HPI Facility ID from where the record is sourced
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	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".
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	Identity of the terminology system Fixed Value: 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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	External (provider) and Health NZ business identifiers
status	?!Σ	1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
statusHistory		0..*	BackboneElement	List of past encounter statuses
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
status		1..1	code	planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.
period		1..1	Period	The time that the episode was in the specified status
class	Σ	1..1	Coding	Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. 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: AMB
display		1..1	string	Representation defined by the system Fixed Value: Ambulatory
userSelected		0..1	boolean	If this coding was chosen directly by the user
classHistory		0..*	BackboneElement	List of past encounter classes
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
class		1..1	Coding	inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.
period		1..1	Period	The time that the episode was in the specified class
type	Σ	0..*	CodeableConcept	Specific type of encounter Binding: EncounterType (example): The type of encounter.
serviceType	Σ	0..1	CodeableConcept	Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.
priority		0..1	CodeableConcept	Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.
subject	Σ	1..1	Reference(Dunedin Hospital Outpatient Get Patient Profile | 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: dho-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)
display	Σ	0..1	string	Text alternative for the resource
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	Σ	0..*	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: ParticipantType (extensible): Role of participant in encounter.
period		0..1	Period	Period of time during the encounter that the participant participated
individual	Σ	0..1	Reference(Practitioner resource for use in NZ | PractitionerRole resource for use in NZ | RelatedPerson)	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: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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(Dunedin Hospital Outpatient Appointment Profile)	The appointment that scheduled this encounter
period		0..1	Period	Start | end values must be in UTC timezone on the FHIR server
length		0..1	Duration	Quantity of time the encounter lasted (less time absent)
reasonCode	Σ	0..*	CodeableConcept	Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
reasonReference	Σ	0..*	Reference(Condition | Procedure | Observation | ImmunizationRecommendation)	Reason the encounter takes place (reference)
diagnosis	Σ	0..*	BackboneElement	The list of diagnosis relevant to this 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
condition	Σ	1..1	Reference(Condition | Procedure)	The diagnosis or procedure relevant to the encounter
use		0..1	CodeableConcept	Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
rank		0..1	positiveInt	Ranking of the diagnosis (for each role type)
account		0..*	Reference(Account)	The set of accounts that may be used for billing for this Encounter
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: DischargeDisposition (example): Discharge Disposition.
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		0..1	Reference(Organization)	The organization (facility) responsible for this 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	Σ	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: DHOhpiOrganizationIdPattern, DHOhpiFacilityIdPattern, DHOnzbnPattern, DHOhpiCpnPattern
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: DHOallowedLocalIdentifierSystems 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 readmitted)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Encounter.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Encounter.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Encounter.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Encounter.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Encounter.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.statusHistory.status	required	EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|4.0.1 From the FHIR Standard
Encounter.class	extensible	Pattern Value: AMB("Ambulatory") http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.classHistory.class	extensible	ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.type	example	EncounterType http://hl7.org/fhir/ValueSet/encounter-type From the FHIR Standard
Encounter.serviceType	example	ServiceType http://hl7.org/fhir/ValueSet/service-type From the FHIR Standard
Encounter.priority	example	ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority
Encounter.subject.type	extensible	Pattern Value: Patient http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.subject.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.subject.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Encounter.participant.type	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard
Encounter.participant.individual.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.participant.individual.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.participant.individual.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Encounter.reasonCode	preferred	EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason From the FHIR Standard
Encounter.diagnosis.use	preferred	DiagnosisRole http://hl7.org/fhir/ValueSet/diagnosis-role From the FHIR Standard
Encounter.hospitalization.admitSource	preferred	AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source From the FHIR Standard
Encounter.hospitalization.reAdmission	example	Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreference	example	Diet http://hl7.org/fhir/ValueSet/encounter-diet From the FHIR Standard
Encounter.hospitalization.specialCourtesy	preferred	SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy From the FHIR Standard
Encounter.hospitalization.specialArrangement	preferred	SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements From the FHIR Standard
Encounter.hospitalization.dischargeDisposition	example	DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition From the FHIR Standard
Encounter.location.status	required	EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 From the FHIR Standard
Encounter.location.physicalType	example	LocationType http://hl7.org/fhir/ValueSet/location-physical-type From the FHIR Standard
Encounter.serviceProvider.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Encounter.serviceProvider.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Encounter.serviceProvider.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
DHOallowedLocalIdentifierSystems	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'
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})$')
dom-2	error	Encounter	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Encounter	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Encounter	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Encounter	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Encounter

Summary

Mandatory: 5 elements(11 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

• Dunedin Hospital Outpatient Get 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)
• Dunedin Hospital Outpatient Appointment Profile (https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment)

Slices

This structure defines the following Slices:

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